├── .gitignore ├── .swagger-codegen-ignore ├── .swagger-codegen └── VERSION ├── .travis.yml ├── LICENSE.md ├── README.md ├── docs ├── AbTestCampaignResult.md ├── AbTestCampaignResultClickedLinks.md ├── AbTestCampaignResultStatistics.md ├── AbTestVersionClicks.md ├── AbTestVersionClicksInner.md ├── AbTestVersionStats.md ├── AccountApi.md ├── AddChildDomain.md ├── AddContactToList.md ├── AddCredits.md ├── AttributesApi.md ├── BlockDomain.md ├── Body.md ├── Body1.md ├── Body10.md ├── Body11.md ├── Body12.md ├── Body2.md ├── Body3.md ├── Body4.md ├── Body5.md ├── Body6.md ├── Body7.md ├── Body8.md ├── Body9.md ├── BodyVariablesItems.md ├── CRMApi.md ├── CompaniesApi.md ├── CompaniesList.md ├── Company.md ├── CompanyAttributes.md ├── CompanyAttributesInner.md ├── ComponentItems.md ├── Contact.md ├── ContactsApi.md ├── ConversationsApi.md ├── ConversationsMessage.md ├── ConversationsMessageFile.md ├── ConversationsMessageFileImageInfo.md ├── CreateApiKeyRequest.md ├── CreateApiKeyResponse.md ├── CreateAttribute.md ├── CreateAttributeEnumeration.md ├── CreateCategoryModel.md ├── CreateChild.md ├── CreateContact.md ├── CreateDoiContact.md ├── CreateEmailCampaign.md ├── CreateEmailCampaignRecipients.md ├── CreateEmailCampaignSender.md ├── CreateExternalFeed.md ├── CreateList.md ├── CreateModel.md ├── CreateProductModel.md ├── CreateReseller.md ├── CreateSender.md ├── CreateSenderIps.md ├── CreateSenderModel.md ├── CreateSmsCampaign.md ├── CreateSmsCampaignRecipients.md ├── CreateSmtpEmail.md ├── CreateSmtpTemplate.md ├── CreateSmtpTemplateSender.md ├── CreateSubAccount.md ├── CreateSubAccountResponse.md ├── CreateUpdateBatchCategory.md ├── CreateUpdateBatchCategoryModel.md ├── CreateUpdateBatchProducts.md ├── CreateUpdateBatchProductsModel.md ├── CreateUpdateCategories.md ├── CreateUpdateCategory.md ├── CreateUpdateContactModel.md ├── CreateUpdateFolder.md ├── CreateUpdateProduct.md ├── CreateUpdateProducts.md ├── CreateWebhook.md ├── CreatedBatchId.md ├── CreatedProcessId.md ├── Deal.md ├── DealAttributes.md ├── DealAttributesInner.md ├── DealsApi.md ├── DealsList.md ├── DeleteHardbounces.md ├── EcommerceApi.md ├── EmailCampaignsApi.md ├── EmailExportRecipients.md ├── ErrorModel.md ├── ExternalFeedsApi.md ├── FileData.md ├── FileDownloadableLink.md ├── FileList.md ├── FilesApi.md ├── FoldersApi.md ├── GetAccount.md ├── GetAccountMarketingAutomation.md ├── GetAccountPlan.md ├── GetAccountRelay.md ├── GetAccountRelayData.md ├── GetAggregatedReport.md ├── GetAllExternalFeeds.md ├── GetAllExternalFeedsFeeds.md ├── GetAttributes.md ├── GetAttributesAttributes.md ├── GetAttributesEnumeration.md ├── GetBlockedDomains.md ├── GetCampaignOverview.md ├── GetCampaignRecipients.md ├── GetCampaignStats.md ├── GetCategories.md ├── GetCategoryDetails.md ├── GetChildAccountCreationStatus.md ├── GetChildDomain.md ├── GetChildDomains.md ├── GetChildInfo.md ├── GetChildInfoApiKeys.md ├── GetChildInfoApiKeysV2.md ├── GetChildInfoApiKeysV3.md ├── GetChildInfoCredits.md ├── GetChildInfoStatistics.md ├── GetChildrenList.md ├── GetClient.md ├── GetContactCampaignStats.md ├── GetContactCampaignStatsClicked.md ├── GetContactCampaignStatsOpened.md ├── GetContactCampaignStatsTransacAttributes.md ├── GetContactCampaignStatsUnsubscriptions.md ├── GetContactDetails.md ├── GetContacts.md ├── GetDeviceBrowserStats.md ├── GetEmailCampaign.md ├── GetEmailCampaigns.md ├── GetEmailEventReport.md ├── GetEmailEventReportEvents.md ├── GetExtendedCampaignOverview.md ├── GetExtendedCampaignOverviewSender.md ├── GetExtendedCampaignStats.md ├── GetExtendedClient.md ├── GetExtendedClientAddress.md ├── GetExtendedContactDetails.md ├── GetExtendedContactDetailsStatistics.md ├── GetExtendedContactDetailsStatisticsClicked.md ├── GetExtendedContactDetailsStatisticsDelivered.md ├── GetExtendedContactDetailsStatisticsLinks.md ├── GetExtendedContactDetailsStatisticsMessagesSent.md ├── GetExtendedContactDetailsStatisticsOpened.md ├── GetExtendedContactDetailsStatisticsUnsubscriptions.md ├── GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md ├── GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md ├── GetExtendedList.md ├── GetExtendedListCampaignStats.md ├── GetExternalFeedByUUID.md ├── GetExternalFeedByUUIDHeaders.md ├── GetFolder.md ├── GetFolderLists.md ├── GetFolders.md ├── GetInboundEmailEvents.md ├── GetInboundEmailEventsByUuid.md ├── GetInboundEmailEventsByUuidAttachments.md ├── GetInboundEmailEventsByUuidLogs.md ├── GetInboundEmailEventsEvents.md ├── GetIp.md ├── GetIpFromSender.md ├── GetIps.md ├── GetIpsFromSender.md ├── GetList.md ├── GetLists.md ├── GetProcess.md ├── GetProcesses.md ├── GetProductDetails.md ├── GetProducts.md ├── GetReports.md ├── GetReportsReports.md ├── GetScheduledEmailByBatchId.md ├── GetScheduledEmailByBatchIdBatches.md ├── GetScheduledEmailByMessageId.md ├── GetSendersList.md ├── GetSendersListIps.md ├── GetSendersListSenders.md ├── GetSharedTemplateUrl.md ├── GetSmsCampaign.md ├── GetSmsCampaignOverview.md ├── GetSmsCampaignStats.md ├── GetSmsCampaigns.md ├── GetSmsEventReport.md ├── GetSmsEventReportEvents.md ├── GetSmtpTemplateOverview.md ├── GetSmtpTemplateOverviewSender.md ├── GetSmtpTemplates.md ├── GetSsoToken.md ├── GetStatsByBrowser.md ├── GetStatsByDevice.md ├── GetStatsByDomain.md ├── GetTransacAggregatedSmsReport.md ├── GetTransacBlockedContacts.md ├── GetTransacBlockedContactsContacts.md ├── GetTransacBlockedContactsReason.md ├── GetTransacEmailContent.md ├── GetTransacEmailContentEvents.md ├── GetTransacEmailsList.md ├── GetTransacEmailsListTransactionalEmails.md ├── GetTransacSmsReport.md ├── GetTransacSmsReportReports.md ├── GetWATemplates.md ├── GetWATemplatesTemplates.md ├── GetWebhook.md ├── GetWebhooks.md ├── GetWhatsappCampaignOverview.md ├── GetWhatsappEventReport.md ├── GetWhatsappEventReportEvents.md ├── InboundParsingApi.md ├── InlineResponse200.md ├── InlineResponse201.md ├── InlineResponse2011.md ├── InlineResponse2012.md ├── InlineResponse2013.md ├── ListsApi.md ├── ManageIp.md ├── MasterAccountApi.md ├── MasterDetailsResponse.md ├── MasterDetailsResponseBillingInfo.md ├── MasterDetailsResponseBillingInfoAddress.md ├── MasterDetailsResponseBillingInfoName.md ├── MasterDetailsResponsePlanInfo.md ├── MasterDetailsResponsePlanInfoFeatures.md ├── Note.md ├── NoteData.md ├── NoteId.md ├── NoteList.md ├── NotesApi.md ├── Order.md ├── OrderBatch.md ├── OrderBilling.md ├── OrderProducts.md ├── Pipeline.md ├── PipelineStage.md ├── PostContactInfo.md ├── PostContactInfoContacts.md ├── PostSendFailed.md ├── PostSendSmsTestFailed.md ├── ProcessApi.md ├── RemainingCreditModel.md ├── RemainingCreditModelChild.md ├── RemainingCreditModelReseller.md ├── RemoveContactFromList.md ├── RemoveCredits.md ├── RequestContactExport.md ├── RequestContactExportCustomContactFilter.md ├── RequestContactImport.md ├── RequestContactImportNewList.md ├── RequestSMSRecipientExport.md ├── ResellerApi.md ├── SMSCampaignsApi.md ├── ScheduleSmtpEmail.md ├── SendEmail.md ├── SendEmailAttachment.md ├── SendReport.md ├── SendReportEmail.md ├── SendSms.md ├── SendSmtpEmail.md ├── SendSmtpEmailAttachment.md ├── SendSmtpEmailBcc.md ├── SendSmtpEmailCc.md ├── SendSmtpEmailMessageVersions.md ├── SendSmtpEmailReplyTo.md ├── SendSmtpEmailReplyTo1.md ├── SendSmtpEmailSender.md ├── SendSmtpEmailTo.md ├── SendSmtpEmailTo1.md ├── SendTemplateEmail.md ├── SendTestEmail.md ├── SendTestSms.md ├── SendTransacSms.md ├── SendWhatsappMessage.md ├── SendersApi.md ├── SsoTokenRequest.md ├── SubAccountDetailsResponse.md ├── SubAccountDetailsResponsePlanInfo.md ├── SubAccountDetailsResponsePlanInfoCredits.md ├── SubAccountDetailsResponsePlanInfoCreditsEmails.md ├── SubAccountDetailsResponsePlanInfoFeatures.md ├── SubAccountDetailsResponsePlanInfoFeaturesInbox.md ├── SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md ├── SubAccountDetailsResponsePlanInfoFeaturesUsers.md ├── SubAccountUpdatePlanRequest.md ├── SubAccountUpdatePlanRequestCredits.md ├── SubAccountUpdatePlanRequestFeatures.md ├── SubAccountsResponse.md ├── SubAccountsResponseSubAccounts.md ├── Task.md ├── TaskList.md ├── TaskReminder.md ├── TaskTypes.md ├── TasksApi.md ├── TransactionalEmailsApi.md ├── TransactionalSMSApi.md ├── TransactionalWhatsAppApi.md ├── UpdateAttribute.md ├── UpdateAttributeEnumeration.md ├── UpdateBatchContacts.md ├── UpdateBatchContactsContacts.md ├── UpdateBatchContactsModel.md ├── UpdateCampaignStatus.md ├── UpdateChild.md ├── UpdateChildAccountStatus.md ├── UpdateChildDomain.md ├── UpdateContact.md ├── UpdateEmailCampaign.md ├── UpdateEmailCampaignRecipients.md ├── UpdateEmailCampaignSender.md ├── UpdateExternalFeed.md ├── UpdateList.md ├── UpdateSender.md ├── UpdateSmsCampaign.md ├── UpdateSmtpTemplate.md ├── UpdateSmtpTemplateSender.md ├── UpdateWebhook.md ├── UploadImageModel.md ├── UploadImageToGallery.md ├── VariablesItems.md ├── WebhooksApi.md ├── WhatsappCampStats.md ├── WhatsappCampTemplate.md └── WhatsappCampaignsApi.md ├── git_push.sh ├── requirements.txt ├── setup.py ├── sib_api_v3_sdk ├── __init__.py ├── api │ ├── __init__.py │ ├── account_api.py │ ├── attributes_api.py │ ├── companies_api.py │ ├── contacts_api.py │ ├── conversations_api.py │ ├── crm_api.py │ ├── deals_api.py │ ├── ecommerce_api.py │ ├── email_campaigns_api.py │ ├── external_feeds_api.py │ ├── files_api.py │ ├── folders_api.py │ ├── inbound_parsing_api.py │ ├── lists_api.py │ ├── master_account_api.py │ ├── notes_api.py │ ├── process_api.py │ ├── reseller_api.py │ ├── senders_api.py │ ├── sms_campaigns_api.py │ ├── tasks_api.py │ ├── transactional_emails_api.py │ ├── transactional_sms_api.py │ ├── transactional_whats_app_api.py │ ├── webhooks_api.py │ └── whatsapp_campaigns_api.py ├── api_client.py ├── configuration.py ├── models │ ├── __init__.py │ ├── ab_test_campaign_result.py │ ├── ab_test_campaign_result_clicked_links.py │ ├── ab_test_campaign_result_statistics.py │ ├── ab_test_version_clicks.py │ ├── ab_test_version_clicks_inner.py │ ├── ab_test_version_stats.py │ ├── add_child_domain.py │ ├── add_contact_to_list.py │ ├── add_credits.py │ ├── block_domain.py │ ├── body.py │ ├── body1.py │ ├── body10.py │ ├── body11.py │ ├── body12.py │ ├── body2.py │ ├── body3.py │ ├── body4.py │ ├── body5.py │ ├── body6.py │ ├── body7.py │ ├── body8.py │ ├── body9.py │ ├── body_variables_items.py │ ├── companies_list.py │ ├── company.py │ ├── company_attributes.py │ ├── company_attributes_inner.py │ ├── component_items.py │ ├── contact.py │ ├── conversations_message.py │ ├── conversations_message_file.py │ ├── conversations_message_file_image_info.py │ ├── create_api_key_request.py │ ├── create_api_key_response.py │ ├── create_attribute.py │ ├── create_attribute_enumeration.py │ ├── create_category_model.py │ ├── create_child.py │ ├── create_contact.py │ ├── create_doi_contact.py │ ├── create_email_campaign.py │ ├── create_email_campaign_recipients.py │ ├── create_email_campaign_sender.py │ ├── create_external_feed.py │ ├── create_list.py │ ├── create_model.py │ ├── create_product_model.py │ ├── create_reseller.py │ ├── create_sender.py │ ├── create_sender_ips.py │ ├── create_sender_model.py │ ├── create_sms_campaign.py │ ├── create_sms_campaign_recipients.py │ ├── create_smtp_email.py │ ├── create_smtp_template.py │ ├── create_smtp_template_sender.py │ ├── create_sub_account.py │ ├── create_sub_account_response.py │ ├── create_update_batch_category.py │ ├── create_update_batch_category_model.py │ ├── create_update_batch_products.py │ ├── create_update_batch_products_model.py │ ├── create_update_categories.py │ ├── create_update_category.py │ ├── create_update_contact_model.py │ ├── create_update_folder.py │ ├── create_update_product.py │ ├── create_update_products.py │ ├── create_webhook.py │ ├── created_batch_id.py │ ├── created_process_id.py │ ├── deal.py │ ├── deal_attributes.py │ ├── deal_attributes_inner.py │ ├── deals_list.py │ ├── delete_hardbounces.py │ ├── email_export_recipients.py │ ├── error_model.py │ ├── file_data.py │ ├── file_downloadable_link.py │ ├── file_list.py │ ├── get_account.py │ ├── get_account_marketing_automation.py │ ├── get_account_plan.py │ ├── get_account_relay.py │ ├── get_account_relay_data.py │ ├── get_aggregated_report.py │ ├── get_all_external_feeds.py │ ├── get_all_external_feeds_feeds.py │ ├── get_attributes.py │ ├── get_attributes_attributes.py │ ├── get_attributes_enumeration.py │ ├── get_blocked_domains.py │ ├── get_campaign_overview.py │ ├── get_campaign_recipients.py │ ├── get_campaign_stats.py │ ├── get_categories.py │ ├── get_category_details.py │ ├── get_child_account_creation_status.py │ ├── get_child_domain.py │ ├── get_child_domains.py │ ├── get_child_info.py │ ├── get_child_info_api_keys.py │ ├── get_child_info_api_keys_v2.py │ ├── get_child_info_api_keys_v3.py │ ├── get_child_info_credits.py │ ├── get_child_info_statistics.py │ ├── get_children_list.py │ ├── get_client.py │ ├── get_contact_campaign_stats.py │ ├── get_contact_campaign_stats_clicked.py │ ├── get_contact_campaign_stats_opened.py │ ├── get_contact_campaign_stats_transac_attributes.py │ ├── get_contact_campaign_stats_unsubscriptions.py │ ├── get_contact_details.py │ ├── get_contacts.py │ ├── get_device_browser_stats.py │ ├── get_email_campaign.py │ ├── get_email_campaigns.py │ ├── get_email_event_report.py │ ├── get_email_event_report_events.py │ ├── get_extended_campaign_overview.py │ ├── get_extended_campaign_overview_sender.py │ ├── get_extended_campaign_stats.py │ ├── get_extended_client.py │ ├── get_extended_client_address.py │ ├── get_extended_contact_details.py │ ├── get_extended_contact_details_statistics.py │ ├── get_extended_contact_details_statistics_clicked.py │ ├── get_extended_contact_details_statistics_delivered.py │ ├── get_extended_contact_details_statistics_links.py │ ├── get_extended_contact_details_statistics_messages_sent.py │ ├── get_extended_contact_details_statistics_opened.py │ ├── get_extended_contact_details_statistics_unsubscriptions.py │ ├── get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.py │ ├── get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.py │ ├── get_extended_list.py │ ├── get_extended_list_campaign_stats.py │ ├── get_external_feed_by_uuid.py │ ├── get_external_feed_by_uuid_headers.py │ ├── get_folder.py │ ├── get_folder_lists.py │ ├── get_folders.py │ ├── get_inbound_email_events.py │ ├── get_inbound_email_events_by_uuid.py │ ├── get_inbound_email_events_by_uuid_attachments.py │ ├── get_inbound_email_events_by_uuid_logs.py │ ├── get_inbound_email_events_events.py │ ├── get_ip.py │ ├── get_ip_from_sender.py │ ├── get_ips.py │ ├── get_ips_from_sender.py │ ├── get_list.py │ ├── get_lists.py │ ├── get_process.py │ ├── get_processes.py │ ├── get_product_details.py │ ├── get_products.py │ ├── get_reports.py │ ├── get_reports_reports.py │ ├── get_scheduled_email_by_batch_id.py │ ├── get_scheduled_email_by_batch_id_batches.py │ ├── get_scheduled_email_by_message_id.py │ ├── get_senders_list.py │ ├── get_senders_list_ips.py │ ├── get_senders_list_senders.py │ ├── get_shared_template_url.py │ ├── get_sms_campaign.py │ ├── get_sms_campaign_overview.py │ ├── get_sms_campaign_stats.py │ ├── get_sms_campaigns.py │ ├── get_sms_event_report.py │ ├── get_sms_event_report_events.py │ ├── get_smtp_template_overview.py │ ├── get_smtp_template_overview_sender.py │ ├── get_smtp_templates.py │ ├── get_sso_token.py │ ├── get_stats_by_browser.py │ ├── get_stats_by_device.py │ ├── get_stats_by_domain.py │ ├── get_transac_aggregated_sms_report.py │ ├── get_transac_blocked_contacts.py │ ├── get_transac_blocked_contacts_contacts.py │ ├── get_transac_blocked_contacts_reason.py │ ├── get_transac_email_content.py │ ├── get_transac_email_content_events.py │ ├── get_transac_emails_list.py │ ├── get_transac_emails_list_transactional_emails.py │ ├── get_transac_sms_report.py │ ├── get_transac_sms_report_reports.py │ ├── get_wa_templates.py │ ├── get_wa_templates_templates.py │ ├── get_webhook.py │ ├── get_webhooks.py │ ├── get_whatsapp_campaign_overview.py │ ├── get_whatsapp_event_report.py │ ├── get_whatsapp_event_report_events.py │ ├── inline_response200.py │ ├── inline_response201.py │ ├── inline_response2011.py │ ├── inline_response2012.py │ ├── inline_response2013.py │ ├── manage_ip.py │ ├── master_details_response.py │ ├── master_details_response_billing_info.py │ ├── master_details_response_billing_info_address.py │ ├── master_details_response_billing_info_name.py │ ├── master_details_response_plan_info.py │ ├── master_details_response_plan_info_features.py │ ├── note.py │ ├── note_data.py │ ├── note_id.py │ ├── note_list.py │ ├── order.py │ ├── order_batch.py │ ├── order_billing.py │ ├── order_products.py │ ├── pipeline.py │ ├── pipeline_stage.py │ ├── post_contact_info.py │ ├── post_contact_info_contacts.py │ ├── post_send_failed.py │ ├── post_send_sms_test_failed.py │ ├── remaining_credit_model.py │ ├── remaining_credit_model_child.py │ ├── remaining_credit_model_reseller.py │ ├── remove_contact_from_list.py │ ├── remove_credits.py │ ├── request_contact_export.py │ ├── request_contact_export_custom_contact_filter.py │ ├── request_contact_import.py │ ├── request_contact_import_new_list.py │ ├── request_sms_recipient_export.py │ ├── schedule_smtp_email.py │ ├── send_email.py │ ├── send_email_attachment.py │ ├── send_report.py │ ├── send_report_email.py │ ├── send_sms.py │ ├── send_smtp_email.py │ ├── send_smtp_email_attachment.py │ ├── send_smtp_email_bcc.py │ ├── send_smtp_email_cc.py │ ├── send_smtp_email_message_versions.py │ ├── send_smtp_email_reply_to.py │ ├── send_smtp_email_reply_to1.py │ ├── send_smtp_email_sender.py │ ├── send_smtp_email_to.py │ ├── send_smtp_email_to1.py │ ├── send_template_email.py │ ├── send_test_email.py │ ├── send_test_sms.py │ ├── send_transac_sms.py │ ├── send_whatsapp_message.py │ ├── sso_token_request.py │ ├── sub_account_details_response.py │ ├── sub_account_details_response_plan_info.py │ ├── sub_account_details_response_plan_info_credits.py │ ├── sub_account_details_response_plan_info_credits_emails.py │ ├── sub_account_details_response_plan_info_features.py │ ├── sub_account_details_response_plan_info_features_inbox.py │ ├── sub_account_details_response_plan_info_features_landing_page.py │ ├── sub_account_details_response_plan_info_features_users.py │ ├── sub_account_update_plan_request.py │ ├── sub_account_update_plan_request_credits.py │ ├── sub_account_update_plan_request_features.py │ ├── sub_accounts_response.py │ ├── sub_accounts_response_sub_accounts.py │ ├── task.py │ ├── task_list.py │ ├── task_reminder.py │ ├── task_types.py │ ├── update_attribute.py │ ├── update_attribute_enumeration.py │ ├── update_batch_contacts.py │ ├── update_batch_contacts_contacts.py │ ├── update_batch_contacts_model.py │ ├── update_campaign_status.py │ ├── update_child.py │ ├── update_child_account_status.py │ ├── update_child_domain.py │ ├── update_contact.py │ ├── update_email_campaign.py │ ├── update_email_campaign_recipients.py │ ├── update_email_campaign_sender.py │ ├── update_external_feed.py │ ├── update_list.py │ ├── update_sender.py │ ├── update_sms_campaign.py │ ├── update_smtp_template.py │ ├── update_smtp_template_sender.py │ ├── update_webhook.py │ ├── upload_image_model.py │ ├── upload_image_to_gallery.py │ ├── variables_items.py │ ├── whatsapp_camp_stats.py │ └── whatsapp_camp_template.py └── rest.py ├── test-requirements.txt ├── test ├── __init__.py ├── test_ab_test_campaign_result.py ├── test_ab_test_campaign_result_clicked_links.py ├── test_ab_test_campaign_result_statistics.py ├── test_ab_test_version_clicks.py ├── test_ab_test_version_clicks_inner.py ├── test_ab_test_version_stats.py ├── test_account_api.py ├── test_add_child_domain.py ├── test_add_contact_to_list.py ├── test_add_credits.py ├── test_attributes_api.py ├── test_block_domain.py ├── test_body.py ├── test_body1.py ├── test_body10.py ├── test_body11.py ├── test_body12.py ├── test_body2.py ├── test_body3.py ├── test_body4.py ├── test_body5.py ├── test_body6.py ├── test_body7.py ├── test_body8.py ├── test_body9.py ├── test_body_variables_items.py ├── test_companies_api.py ├── test_companies_list.py ├── test_company.py ├── test_company_attributes.py ├── test_company_attributes_inner.py ├── test_component_items.py ├── test_contact.py ├── test_contacts_api.py ├── test_conversations_api.py ├── test_conversations_message.py ├── test_conversations_message_file.py ├── test_conversations_message_file_image_info.py ├── test_create_api_key_request.py ├── test_create_api_key_response.py ├── test_create_attribute.py ├── test_create_attribute_enumeration.py ├── test_create_category_model.py ├── test_create_child.py ├── test_create_contact.py ├── test_create_doi_contact.py ├── test_create_email_campaign.py ├── test_create_email_campaign_recipients.py ├── test_create_email_campaign_sender.py ├── test_create_external_feed.py ├── test_create_list.py ├── test_create_model.py ├── test_create_product_model.py ├── test_create_reseller.py ├── test_create_sender.py ├── test_create_sender_ips.py ├── test_create_sender_model.py ├── test_create_sms_campaign.py ├── test_create_sms_campaign_recipients.py ├── test_create_smtp_email.py ├── test_create_smtp_template.py ├── test_create_smtp_template_sender.py ├── test_create_sub_account.py ├── test_create_sub_account_response.py ├── test_create_update_batch_category.py ├── test_create_update_batch_category_model.py ├── test_create_update_batch_products.py ├── test_create_update_batch_products_model.py ├── test_create_update_categories.py ├── test_create_update_category.py ├── test_create_update_contact_model.py ├── test_create_update_folder.py ├── test_create_update_product.py ├── test_create_update_products.py ├── test_create_webhook.py ├── test_created_batch_id.py ├── test_created_process_id.py ├── test_crm_api.py ├── test_deal.py ├── test_deal_attributes.py ├── test_deal_attributes_inner.py ├── test_deals_api.py ├── test_deals_list.py ├── test_delete_hardbounces.py ├── test_ecommerce_api.py ├── test_email_campaigns_api.py ├── test_email_export_recipients.py ├── test_error_model.py ├── test_external_feeds_api.py ├── test_file_data.py ├── test_file_downloadable_link.py ├── test_file_list.py ├── test_files_api.py ├── test_folders_api.py ├── test_get_account.py ├── test_get_account_marketing_automation.py ├── test_get_account_plan.py ├── test_get_account_relay.py ├── test_get_account_relay_data.py ├── test_get_aggregated_report.py ├── test_get_all_external_feeds.py ├── test_get_all_external_feeds_feeds.py ├── test_get_attributes.py ├── test_get_attributes_attributes.py ├── test_get_attributes_enumeration.py ├── test_get_blocked_domains.py ├── test_get_campaign_overview.py ├── test_get_campaign_recipients.py ├── test_get_campaign_stats.py ├── test_get_categories.py ├── test_get_category_details.py ├── test_get_child_account_creation_status.py ├── test_get_child_domain.py ├── test_get_child_domains.py ├── test_get_child_info.py ├── test_get_child_info_api_keys.py ├── test_get_child_info_api_keys_v2.py ├── test_get_child_info_api_keys_v3.py ├── test_get_child_info_credits.py ├── test_get_child_info_statistics.py ├── test_get_children_list.py ├── test_get_client.py ├── test_get_contact_campaign_stats.py ├── test_get_contact_campaign_stats_clicked.py ├── test_get_contact_campaign_stats_opened.py ├── test_get_contact_campaign_stats_transac_attributes.py ├── test_get_contact_campaign_stats_unsubscriptions.py ├── test_get_contact_details.py ├── test_get_contacts.py ├── test_get_device_browser_stats.py ├── test_get_email_campaign.py ├── test_get_email_campaigns.py ├── test_get_email_event_report.py ├── test_get_email_event_report_events.py ├── test_get_extended_campaign_overview.py ├── test_get_extended_campaign_overview_sender.py ├── test_get_extended_campaign_stats.py ├── test_get_extended_client.py ├── test_get_extended_client_address.py ├── test_get_extended_contact_details.py ├── test_get_extended_contact_details_statistics.py ├── test_get_extended_contact_details_statistics_clicked.py ├── test_get_extended_contact_details_statistics_delivered.py ├── test_get_extended_contact_details_statistics_links.py ├── test_get_extended_contact_details_statistics_messages_sent.py ├── test_get_extended_contact_details_statistics_opened.py ├── test_get_extended_contact_details_statistics_unsubscriptions.py ├── test_get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.py ├── test_get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.py ├── test_get_extended_list.py ├── test_get_extended_list_campaign_stats.py ├── test_get_external_feed_by_uuid.py ├── test_get_external_feed_by_uuid_headers.py ├── test_get_folder.py ├── test_get_folder_lists.py ├── test_get_folders.py ├── test_get_inbound_email_events.py ├── test_get_inbound_email_events_by_uuid.py ├── test_get_inbound_email_events_by_uuid_attachments.py ├── test_get_inbound_email_events_by_uuid_logs.py ├── test_get_inbound_email_events_events.py ├── test_get_ip.py ├── test_get_ip_from_sender.py ├── test_get_ips.py ├── test_get_ips_from_sender.py ├── test_get_list.py ├── test_get_lists.py ├── test_get_process.py ├── test_get_processes.py ├── test_get_product_details.py ├── test_get_products.py ├── test_get_reports.py ├── test_get_reports_reports.py ├── test_get_scheduled_email_by_batch_id.py ├── test_get_scheduled_email_by_batch_id_batches.py ├── test_get_scheduled_email_by_message_id.py ├── test_get_senders_list.py ├── test_get_senders_list_ips.py ├── test_get_senders_list_senders.py ├── test_get_shared_template_url.py ├── test_get_sms_campaign.py ├── test_get_sms_campaign_overview.py ├── test_get_sms_campaign_stats.py ├── test_get_sms_campaigns.py ├── test_get_sms_event_report.py ├── test_get_sms_event_report_events.py ├── test_get_smtp_template_overview.py ├── test_get_smtp_template_overview_sender.py ├── test_get_smtp_templates.py ├── test_get_sso_token.py ├── test_get_stats_by_browser.py ├── test_get_stats_by_device.py ├── test_get_stats_by_domain.py ├── test_get_transac_aggregated_sms_report.py ├── test_get_transac_blocked_contacts.py ├── test_get_transac_blocked_contacts_contacts.py ├── test_get_transac_blocked_contacts_reason.py ├── test_get_transac_email_content.py ├── test_get_transac_email_content_events.py ├── test_get_transac_emails_list.py ├── test_get_transac_emails_list_transactional_emails.py ├── test_get_transac_sms_report.py ├── test_get_transac_sms_report_reports.py ├── test_get_wa_templates.py ├── test_get_wa_templates_templates.py ├── test_get_webhook.py ├── test_get_webhooks.py ├── test_get_whatsapp_campaign_overview.py ├── test_get_whatsapp_event_report.py ├── test_get_whatsapp_event_report_events.py ├── test_inbound_parsing_api.py ├── test_inline_response200.py ├── test_inline_response201.py ├── test_inline_response2011.py ├── test_inline_response2012.py ├── test_inline_response2013.py ├── test_lists_api.py ├── test_manage_ip.py ├── test_master_account_api.py ├── test_master_details_response.py ├── test_master_details_response_billing_info.py ├── test_master_details_response_billing_info_address.py ├── test_master_details_response_billing_info_name.py ├── test_master_details_response_plan_info.py ├── test_master_details_response_plan_info_features.py ├── test_note.py ├── test_note_data.py ├── test_note_id.py ├── test_note_list.py ├── test_notes_api.py ├── test_order.py ├── test_order_batch.py ├── test_order_billing.py ├── test_order_products.py ├── test_pipeline.py ├── test_pipeline_stage.py ├── test_post_contact_info.py ├── test_post_contact_info_contacts.py ├── test_post_send_failed.py ├── test_post_send_sms_test_failed.py ├── test_process_api.py ├── test_remaining_credit_model.py ├── test_remaining_credit_model_child.py ├── test_remaining_credit_model_reseller.py ├── test_remove_contact_from_list.py ├── test_remove_credits.py ├── test_request_contact_export.py ├── test_request_contact_export_custom_contact_filter.py ├── test_request_contact_import.py ├── test_request_contact_import_new_list.py ├── test_request_sms_recipient_export.py ├── test_reseller_api.py ├── test_schedule_smtp_email.py ├── test_send_email.py ├── test_send_email_attachment.py ├── test_send_report.py ├── test_send_report_email.py ├── test_send_sms.py ├── test_send_smtp_email.py ├── test_send_smtp_email_attachment.py ├── test_send_smtp_email_bcc.py ├── test_send_smtp_email_cc.py ├── test_send_smtp_email_message_versions.py ├── test_send_smtp_email_reply_to.py ├── test_send_smtp_email_reply_to1.py ├── test_send_smtp_email_sender.py ├── test_send_smtp_email_to.py ├── test_send_smtp_email_to1.py ├── test_send_template_email.py ├── test_send_test_email.py ├── test_send_test_sms.py ├── test_send_transac_sms.py ├── test_send_whatsapp_message.py ├── test_senders_api.py ├── test_sms_campaigns_api.py ├── test_sso_token_request.py ├── test_sub_account_details_response.py ├── test_sub_account_details_response_plan_info.py ├── test_sub_account_details_response_plan_info_credits.py ├── test_sub_account_details_response_plan_info_credits_emails.py ├── test_sub_account_details_response_plan_info_features.py ├── test_sub_account_details_response_plan_info_features_inbox.py ├── test_sub_account_details_response_plan_info_features_landing_page.py ├── test_sub_account_details_response_plan_info_features_users.py ├── test_sub_account_update_plan_request.py ├── test_sub_account_update_plan_request_credits.py ├── test_sub_account_update_plan_request_features.py ├── test_sub_accounts_response.py ├── test_sub_accounts_response_sub_accounts.py ├── test_task.py ├── test_task_list.py ├── test_task_reminder.py ├── test_task_types.py ├── test_tasks_api.py ├── test_transactional_emails_api.py ├── test_transactional_sms_api.py ├── test_transactional_whats_app_api.py ├── test_update_attribute.py ├── test_update_attribute_enumeration.py ├── test_update_batch_contacts.py ├── test_update_batch_contacts_contacts.py ├── test_update_batch_contacts_model.py ├── test_update_campaign_status.py ├── test_update_child.py ├── test_update_child_account_status.py ├── test_update_child_domain.py ├── test_update_contact.py ├── test_update_email_campaign.py ├── test_update_email_campaign_recipients.py ├── test_update_email_campaign_sender.py ├── test_update_external_feed.py ├── test_update_list.py ├── test_update_sender.py ├── test_update_sms_campaign.py ├── test_update_smtp_template.py ├── test_update_smtp_template_sender.py ├── test_update_webhook.py ├── test_upload_image_model.py ├── test_upload_image_to_gallery.py ├── test_variables_items.py ├── test_webhooks_api.py ├── test_whatsapp_camp_stats.py ├── test_whatsapp_camp_template.py └── test_whatsapp_campaigns_api.py └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | venv/ 48 | .python-version 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | 57 | # Sphinx documentation 58 | docs/_build/ 59 | 60 | # PyBuilder 61 | target/ 62 | 63 | #Ipython Notebook 64 | .ipynb_checkpoints 65 | 66 | # Miscellaneous 67 | playground.py 68 | /env -------------------------------------------------------------------------------- /.swagger-codegen-ignore: -------------------------------------------------------------------------------- 1 | # Swagger Codegen Ignore 2 | # Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /.swagger-codegen/VERSION: -------------------------------------------------------------------------------- 1 | 2.4.12 -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # ref: https://docs.travis-ci.com/user/languages/python 2 | language: python 3 | python: 4 | # - "2.7" 5 | # - "3.2" 6 | # - "3.3" 7 | - "3.4" 8 | - "3.5" 9 | #- "3.5-dev" # 3.5 development branch 10 | #- "nightly" # points to the latest development branch e.g. 3.6-dev 11 | # command to install dependencies 12 | install: "pip install -r requirements.txt" 13 | # command to run tests 14 | script: nosetests 15 | -------------------------------------------------------------------------------- /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/AbTestCampaignResult.md: -------------------------------------------------------------------------------- 1 | # AbTestCampaignResult 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **winning_version** | **str** | 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** | **str** | Criteria choosen for winning version (Open/Click) | [optional] 8 | **winning_subject_line** | **str** | Subject Line of current winning version | [optional] 9 | **open_rate** | **str** | Open rate for current winning version | [optional] 10 | **click_rate** | **str** | Click rate for current winning version | [optional] 11 | **winning_version_rate** | **str** | Open/Click rate for the winner version | [optional] 12 | **statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional] 13 | **clicked_links** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/AbTestCampaignResultClickedLinks.md: -------------------------------------------------------------------------------- 1 | # AbTestCampaignResultClickedLinks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **version_a** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | | 7 | **version_b** | [**AbTestVersionClicks**](AbTestVersionClicks.md) | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AbTestCampaignResultStatistics.md: -------------------------------------------------------------------------------- 1 | # 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/AbTestVersionClicks.md: -------------------------------------------------------------------------------- 1 | # AbTestVersionClicks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/AbTestVersionClicksInner.md: -------------------------------------------------------------------------------- 1 | # AbTestVersionClicksInner 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **link** | **str** | URL of the link | 7 | **clicks_count** | **float** | Number of times a link is clicked | 8 | **click_rate** | **str** | Percentage of clicks of link with respect to total clicks | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AbTestVersionStats.md: -------------------------------------------------------------------------------- 1 | # AbTestVersionStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **version_a** | **str** | percentage of an event for version A | 7 | **version_b** | **str** | percentage of an event for version B | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AddChildDomain.md: -------------------------------------------------------------------------------- 1 | # AddChildDomain 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **domain** | **str** | Sender domain to add for a specific child account | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AddContactToList.md: -------------------------------------------------------------------------------- 1 | # AddContactToList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **emails** | **list[str]** | 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** | **list[int]** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AddCredits.md: -------------------------------------------------------------------------------- 1 | # AddCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sms** | **int** | Required if email credits are empty. SMS credits to be added to the child account | [optional] 7 | **email** | **int** | Required if sms credits are empty. Email credits to be added to the child account | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/BlockDomain.md: -------------------------------------------------------------------------------- 1 | # BlockDomain 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **domain** | **str** | name of the domain to be blocked | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Body.md: -------------------------------------------------------------------------------- 1 | # Body 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of company | 7 | **attributes** | **object** | Attributes for company creation | [optional] 8 | **country_code** | **int** | Country code if phone_number is passed in attributes. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Body1.md: -------------------------------------------------------------------------------- 1 | # Body1 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of company | [optional] 7 | **attributes** | **object** | Attributes for company update | [optional] 8 | **country_code** | **int** | Country code if phone_number is passed in attributes. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Body10.md: -------------------------------------------------------------------------------- 1 | # Body10 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **visitor_id** | **str** | 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** | **str** | message text | 8 | **agent_id** | **str** | 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** | **str** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body11.md: -------------------------------------------------------------------------------- 1 | # Body11 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **text** | **str** | edited message text | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Body12.md: -------------------------------------------------------------------------------- 1 | # Body12 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **agent_id** | **str** | 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** | **str** | mark your messages to distinguish messages created by you from the others. | [optional] 8 | **agent_email** | **str** | 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** | **str** | agent name. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body2.md: -------------------------------------------------------------------------------- 1 | # Body2 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **link_contact_ids** | **list[int]** | Contact ids for contacts to be linked with company | [optional] 7 | **unlink_contact_ids** | **list[int]** | Contact ids for contacts to be unlinked from company | [optional] 8 | **link_deals_ids** | **list[str]** | Deals ids for deals to be linked with company | [optional] 9 | **unlink_deals_ids** | **list[str]** | Deals ids for deals to be unlinked from company | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body3.md: -------------------------------------------------------------------------------- 1 | # Body3 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of deal | 7 | **attributes** | **object** | Attributes fo\\r deal creation | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Body4.md: -------------------------------------------------------------------------------- 1 | # Body4 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of deal | [optional] 7 | **attributes** | **object** | Attributes for deal update | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Body5.md: -------------------------------------------------------------------------------- 1 | # Body5 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **link_contact_ids** | **list[int]** | Contact ids for contacts to be linked with deal | [optional] 7 | **unlink_contact_ids** | **list[int]** | Contact ids for contacts to be unlinked from deal | [optional] 8 | **link_company_ids** | **list[str]** | Company ids to be linked with deal | [optional] 9 | **unlink_company_ids** | **list[str]** | Company ids to be unlinked from deal | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Body6.md: -------------------------------------------------------------------------------- 1 | # Body6 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of task | 7 | **duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] 8 | **task_type_id** | **str** | Id for type of task e.g Call / Email / Meeting etc. | 9 | **_date** | **datetime** | Task due date and time | 10 | **notes** | **str** | Notes added to a task | [optional] 11 | **done** | **bool** | Task marked as done | [optional] 12 | **assign_to_id** | **str** | User id to whom task is assigned | [optional] 13 | **contacts_ids** | **list[int]** | Contact ids for contacts linked to this task | [optional] 14 | **deals_ids** | **list[str]** | Deal ids for deals a task is linked to | [optional] 15 | **companies_ids** | **list[str]** | Companies ids for companies a task is linked to | [optional] 16 | **reminder** | [**TaskReminder**](TaskReminder.md) | | [optional] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/Body7.md: -------------------------------------------------------------------------------- 1 | # Body7 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of task | [optional] 7 | **duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] 8 | **task_type_id** | **str** | Id for type of task e.g Call / Email / Meeting etc. | [optional] 9 | **_date** | **datetime** | Task date/time | [optional] 10 | **notes** | **str** | Notes added to a task | [optional] 11 | **done** | **bool** | Task marked as done | [optional] 12 | **assign_to_id** | **str** | User id to whom task is assigned | [optional] 13 | **contacts_ids** | **list[int]** | Contact ids for contacts linked to this task | [optional] 14 | **deals_ids** | **list[str]** | Deal ids for deals a task is linked to | [optional] 15 | **companies_ids** | **list[str]** | Companies ids for companies a task is linked to | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/Body8.md: -------------------------------------------------------------------------------- 1 | # Body8 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **visitor_id** | **str** | 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** | **str** | message text | 8 | **agent_id** | **str** | 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** | **str** | mark your messages to distinguish messages created by you from the others. | [optional] 10 | **agent_email** | **str** | 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** | **str** | agent name | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Body9.md: -------------------------------------------------------------------------------- 1 | # Body9 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **text** | **str** | edited message text | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/BodyVariablesItems.md: -------------------------------------------------------------------------------- 1 | # BodyVariablesItems 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CompaniesList.md: -------------------------------------------------------------------------------- 1 | # CompaniesList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **items** | [**list[Company]**](Company.md) | List of compaies | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Company.md: -------------------------------------------------------------------------------- 1 | # Company 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique company id | [optional] 7 | **attributes** | **object** | Company attributes with values | [optional] 8 | **linked_contacts_ids** | **list[int]** | Contact ids for contacts linked to this company | [optional] 9 | **linked_deals_ids** | **list[str]** | Deals ids for companies linked to this company | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CompanyAttributes.md: -------------------------------------------------------------------------------- 1 | # CompanyAttributes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CompanyAttributesInner.md: -------------------------------------------------------------------------------- 1 | # CompanyAttributesInner 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **internal_name** | **str** | | [optional] 7 | **label** | **str** | | [optional] 8 | **attribute_type_name** | **str** | | [optional] 9 | **attribute_options** | **list[object]** | | [optional] 10 | **is_required** | **bool** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ComponentItems.md: -------------------------------------------------------------------------------- 1 | # ComponentItems 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | | [optional] 7 | **text** | **str** | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Contact.md: -------------------------------------------------------------------------------- 1 | # Contact 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **virtual_next_task** | **object** | Next incomplete task of contact | [optional] 7 | **email** | **str** | Contact email | 8 | **assign_to_id** | **str** | User id to whom contact is assigned | [optional] 9 | **contacts_id** | **int** | Contact id | [optional] 10 | **crm_lists** | **object** | CRM lists in which contact is added | 11 | **attributes** | **object** | Contact attributes e.g firstname / lastname / SMS etc. | [optional] 12 | **created_at** | **datetime** | Contact created date/time | [optional] 13 | **updated_at** | **datetime** | Contact updated date/time | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ConversationsMessage.md: -------------------------------------------------------------------------------- 1 | # ConversationsMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Message ID. It can be used for further manipulations with the message. | [optional] 7 | **type** | **str** | `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. | [optional] 8 | **text** | **str** | Message text or name of the attached file | [optional] 9 | **visitor_id** | **str** | visitor’s ID | [optional] 10 | **agent_id** | **str** | ID of the agent on whose behalf the message was sent (only in messages sent by an agent). | [optional] 11 | **agent_name** | **str** | Agent’s name as displayed to the visitor. Only in the messages sent by an agent. | [optional] 12 | **created_at** | **int** | Timestamp in milliseconds. | [optional] 13 | **is_pushed** | **bool** | `true` for pushed messages | [optional] 14 | **received_from** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/ConversationsMessageFile.md: -------------------------------------------------------------------------------- 1 | # ConversationsMessageFile 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filename** | **str** | Name of the file | [optional] 7 | **size** | **int** | Size in bytes | [optional] 8 | **is_image** | **bool** | Whether the file is an image | [optional] 9 | **url** | **str** | URL of the file | [optional] 10 | **image_info** | [**ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ConversationsMessageFileImageInfo.md: -------------------------------------------------------------------------------- 1 | # ConversationsMessageFileImageInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **width** | **int** | Width of the image | [optional] 7 | **height** | **int** | height of the image | [optional] 8 | **preview_url** | **str** | URL of the preview | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateApiKeyRequest.md: -------------------------------------------------------------------------------- 1 | # CreateApiKeyRequest 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | Id of the sub-account organization | 7 | **name** | **str** | Name of the API key | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateApiKeyResponse.md: -------------------------------------------------------------------------------- 1 | # CreateApiKeyResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **status** | **str** | Status of the API operation. | [optional] 7 | **key** | **str** | API Key | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateAttribute.md: -------------------------------------------------------------------------------- 1 | # CreateAttribute 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **str** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 7 | **is_recurring** | **bool** | Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 8 | **enumeration** | [**list[CreateAttributeEnumeration]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional] 9 | **type** | **str** | 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] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CreateAttributeEnumeration.md: -------------------------------------------------------------------------------- 1 | # CreateAttributeEnumeration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **int** | Id of the value | 7 | **label** | **str** | Label of the value | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateCategoryModel.md: -------------------------------------------------------------------------------- 1 | # CreateCategoryModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the category when a new category is created | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateChild.md: -------------------------------------------------------------------------------- 1 | # CreateChild 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address to create the child account | 7 | **first_name** | **str** | First name to use to create the child account | 8 | **last_name** | **str** | Last name to use to create the child account | 9 | **company_name** | **str** | Company name to use to create the child account | 10 | **password** | **str** | Password for the child account to login | 11 | **language** | **str** | Language of the child account | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateDoiContact.md: -------------------------------------------------------------------------------- 1 | # CreateDoiContact 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | 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** | **list[int]** | Lists under user account where contact should be added | 9 | **exclude_list_ids** | **list[int]** | Lists under user account where contact should not be added | [optional] 10 | **template_id** | **int** | Id of the Double opt-in (DOI) template | 11 | **redirection_url** | **str** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateEmailCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | # CreateEmailCampaignRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **exclusion_list_ids** | **list[int]** | List ids to exclude from the campaign | [optional] 7 | **list_ids** | **list[int]** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional] 8 | **segment_ids** | **list[int]** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateEmailCampaignSender.md: -------------------------------------------------------------------------------- 1 | # CreateEmailCampaignSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Sender Name | [optional] 7 | **email** | **str** | Sender email | 8 | **id** | **int** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateExternalFeed.md: -------------------------------------------------------------------------------- 1 | # CreateExternalFeed 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the feed | 7 | **url** | **str** | URL of the feed | 8 | **auth_type** | **str** | Auth type of the feed: * `basic` * `token` * `noAuth` | [optional] [default to 'noAuth'] 9 | **username** | **str** | Username for authType `basic` | [optional] 10 | **password** | **str** | Password for authType `basic` | [optional] 11 | **token** | **str** | Token for authType `token` | [optional] 12 | **headers** | [**list[GetExternalFeedByUUIDHeaders]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | [optional] 13 | **max_retries** | **int** | Maximum number of retries on the feed url | [optional] 14 | **cache** | **bool** | Toggle caching of feed url response | [optional] [default to False] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/CreateList.md: -------------------------------------------------------------------------------- 1 | # CreateList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the list | 7 | **folder_id** | **int** | Id of the parent folder in which this list is to be created | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateModel.md: -------------------------------------------------------------------------------- 1 | # CreateModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the object created | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateProductModel.md: -------------------------------------------------------------------------------- 1 | # CreateProductModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the Product when a new product is created | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateReseller.md: -------------------------------------------------------------------------------- 1 | # CreateReseller 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **auth_key** | **str** | AuthKey of Reseller child created | 7 | **id** | **int** | Id of Reseller child created | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateSender.md: -------------------------------------------------------------------------------- 1 | # CreateSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | From Name to use for the sender | 7 | **email** | **str** | From email to use for the sender. A verification email will be sent to this address. | 8 | **ips** | [**list[CreateSenderIps]**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSenderIps.md: -------------------------------------------------------------------------------- 1 | # CreateSenderIps 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ip** | **str** | Dedicated IP available in your account | 7 | **domain** | **str** | Domain of the IP | 8 | **weight** | **int** | Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSenderModel.md: -------------------------------------------------------------------------------- 1 | # CreateSenderModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the Sender created | 7 | **spf_error** | **bool** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional] 8 | **dkim_error** | **bool** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSmsCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | # CreateSmsCampaignRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **list_ids** | **list[int]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty | 7 | **exclusion_list_ids** | **list[int]** | List ids which have to be excluded from a campaign | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateSmtpEmail.md: -------------------------------------------------------------------------------- 1 | # CreateSmtpEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **message_id** | **str** | Message ID of the transactional email sent | [optional] 7 | **message_ids** | **list[str]** | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateSmtpTemplateSender.md: -------------------------------------------------------------------------------- 1 | # CreateSmtpTemplateSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the sender. If not passed, will be set to default | [optional] 7 | **email** | **str** | Email of the sender | [optional] 8 | **id** | **int** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateSubAccount.md: -------------------------------------------------------------------------------- 1 | # CreateSubAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **company_name** | **str** | Set the name of the sub-account company | 7 | **email** | **str** | Email address for the organization | 8 | **language** | **str** | Set the language of the sub-account | [optional] 9 | **timezone** | **str** | Set the timezone of the sub-account | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CreateSubAccountResponse.md: -------------------------------------------------------------------------------- 1 | # CreateSubAccountResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the sub-account created | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateUpdateBatchCategory.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateBatchCategory 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **categories** | [**list[CreateUpdateCategories]**](CreateUpdateCategories.md) | array of categories objects | 7 | **update_enabled** | **bool** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateUpdateBatchCategoryModel.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateBatchCategoryModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **created_count** | **int** | Number of the new created categories | [optional] 7 | **updated_count** | **int** | Number of the existing categories updated | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateUpdateBatchProducts.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateBatchProducts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **products** | [**list[CreateUpdateProducts]**](CreateUpdateProducts.md) | array of products objects | 7 | **update_enabled** | **bool** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateUpdateBatchProductsModel.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateBatchProductsModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **created_count** | **int** | Number of the new created products | [optional] 7 | **updated_count** | **int** | Number of the existing products updated | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateUpdateCategories.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateCategories 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique Category ID as saved in the shop | 7 | **name** | **str** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] 8 | **url** | **str** | URL to the category | [optional] 9 | **deleted_at** | **str** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CreateUpdateCategory.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateCategory 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique Category ID as saved in the shop | 7 | **name** | **str** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] 8 | **url** | **str** | URL to the category | [optional] 9 | **update_enabled** | **bool** | Facilitate to update the existing category in the same request (updateEnabled = true) | [optional] [default to False] 10 | **deleted_at** | **str** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CreateUpdateContactModel.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateContactModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the contact when a new contact is created | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateUpdateFolder.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateFolder 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the folder | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreateUpdateProduct.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateProduct 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Product ID for which you requested the details | 7 | **name** | **str** | Mandatory in case of creation**. Name of the product for which you requested the details | 8 | **url** | **str** | URL to the product | [optional] 9 | **image_url** | **str** | Absolute URL to the cover image of the product | [optional] 10 | **sku** | **str** | Product identifier from the shop | [optional] 11 | **price** | **float** | Price of the product | [optional] 12 | **categories** | **list[str]** | Category ID-s of the product | [optional] 13 | **parent_id** | **str** | Parent product id of the product | [optional] 14 | **meta_info** | **dict(str, str)** | Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. | [optional] 15 | **update_enabled** | **bool** | Facilitate to update the existing category in the same request (updateEnabled = true) | [optional] [default to False] 16 | **deleted_at** | **str** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database | [optional] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/CreateUpdateProducts.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateProducts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Product ID for which you requested the details | 7 | **name** | **str** | Mandatory in case of creation**. Name of the product for which you requested the details | 8 | **url** | **str** | URL to the product | [optional] 9 | **image_url** | **str** | Absolute URL to the cover image of the product | [optional] 10 | **sku** | **str** | Product identifier from the shop | [optional] 11 | **price** | **float** | Price of the product | [optional] 12 | **categories** | **list[str]** | Category ID-s of the product | [optional] 13 | **parent_id** | **str** | Parent product id of the product | [optional] 14 | **meta_info** | **dict(str, str)** | Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. | [optional] 15 | **deleted_at** | **str** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/CreateWebhook.md: -------------------------------------------------------------------------------- 1 | # CreateWebhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **str** | URL of the webhook | 7 | **description** | **str** | Description of the webhook | [optional] 8 | **events** | **list[str]** | - 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** | **str** | Type of the webhook | [optional] [default to 'transactional'] 10 | **domain** | **str** | Inbound domain of webhook, required in case of event type `inbound` | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CreatedBatchId.md: -------------------------------------------------------------------------------- 1 | # CreatedBatchId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **batch_id** | **float** | Batch ID of the request | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CreatedProcessId.md: -------------------------------------------------------------------------------- 1 | # CreatedProcessId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **process_id** | **int** | Id of the process created | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Deal.md: -------------------------------------------------------------------------------- 1 | # Deal 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique deal id | [optional] 7 | **attributes** | **object** | Deal attributes with values | [optional] 8 | **linked_contacts_ids** | **list[int]** | Contact ids for contacts linked to this deal | [optional] 9 | **linked_companies_ids** | **list[str]** | Companies ids for companies linked to this deal | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/DealAttributes.md: -------------------------------------------------------------------------------- 1 | # DealAttributes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/DealAttributesInner.md: -------------------------------------------------------------------------------- 1 | # DealAttributesInner 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **internal_name** | **str** | | [optional] 7 | **label** | **str** | | [optional] 8 | **attribute_type_name** | **str** | | [optional] 9 | **attribute_options** | **list[object]** | | [optional] 10 | **is_required** | **bool** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DealsList.md: -------------------------------------------------------------------------------- 1 | # DealsList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **items** | [**list[Deal]**](Deal.md) | List of deals | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DeleteHardbounces.md: -------------------------------------------------------------------------------- 1 | # DeleteHardbounces 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **start_date** | **str** | 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** | **str** | 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** | **str** | Target a specific email address | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/EmailExportRecipients.md: -------------------------------------------------------------------------------- 1 | # EmailExportRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **notify_url** | **str** | Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 7 | **recipients_type** | **str** | Type of recipients to export for a campaign | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ErrorModel.md: -------------------------------------------------------------------------------- 1 | # ErrorModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **code** | **str** | Error code displayed in case of a failure | 7 | **message** | **str** | Readable message associated to the failure | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/FileData.md: -------------------------------------------------------------------------------- 1 | # FileData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of uploaded file | [optional] 7 | **author_id** | **str** | Account id of user which created the file | [optional] 8 | **contact_id** | **int** | Contact id of contact on which file is uploaded | [optional] 9 | **deal_id** | **str** | Deal id linked to a file | [optional] 10 | **company_id** | **str** | Company id linked to a file | [optional] 11 | **size** | **int** | Size of file in bytes | [optional] 12 | **created_at** | **datetime** | File created date/time | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/FileDownloadableLink.md: -------------------------------------------------------------------------------- 1 | # FileDownloadableLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **file_url** | **str** | A unique link to download the requested file. | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/FileList.md: -------------------------------------------------------------------------------- 1 | # FileList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetAccount.md: -------------------------------------------------------------------------------- 1 | # GetAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Login Email | 7 | **first_name** | **str** | First Name | 8 | **last_name** | **str** | Last Name | 9 | **company_name** | **str** | Name of the company | 10 | **address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | | 11 | **plan** | [**list[GetAccountPlan]**](GetAccountPlan.md) | Information about your plans and credits | 12 | **relay** | [**GetAccountRelay**](GetAccountRelay.md) | | 13 | **marketing_automation** | [**GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) | | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetAccountMarketingAutomation.md: -------------------------------------------------------------------------------- 1 | # GetAccountMarketingAutomation 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | **str** | Marketing Automation Tracker ID | [optional] 7 | **enabled** | **bool** | Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetAccountPlan.md: -------------------------------------------------------------------------------- 1 | # GetAccountPlan 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | Displays the plan type of the user | 7 | **credits_type** | **str** | 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** | **int** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/GetAccountRelay.md: -------------------------------------------------------------------------------- 1 | # GetAccountRelay 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **enabled** | **bool** | Status of your transactional email Account (true=Enabled, false=Disabled) | 7 | **data** | [**GetAccountRelayData**](GetAccountRelayData.md) | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetAccountRelayData.md: -------------------------------------------------------------------------------- 1 | # GetAccountRelayData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_name** | **str** | Email to use as login on transactional platform | 7 | **relay** | **str** | URL of the SMTP Relay | 8 | **port** | **int** | Port used for SMTP Relay | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetAggregatedReport.md: -------------------------------------------------------------------------------- 1 | # GetAggregatedReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **range** | **str** | Time frame of the report | [optional] 7 | **requests** | **int** | Number of requests for the timeframe | [optional] 8 | **delivered** | **int** | Number of delivered emails for the timeframe | [optional] 9 | **hard_bounces** | **int** | Number of hardbounces for the timeframe | [optional] 10 | **soft_bounces** | **int** | Number of softbounces for the timeframe | [optional] 11 | **clicks** | **int** | Number of clicks for the timeframe | [optional] 12 | **unique_clicks** | **int** | Number of unique clicks for the timeframe | [optional] 13 | **opens** | **int** | Number of openings for the timeframe | [optional] 14 | **unique_opens** | **int** | Number of unique openings for the timeframe | [optional] 15 | **spam_reports** | **int** | Number of complaint (spam report) for the timeframe | [optional] 16 | **blocked** | **int** | Number of blocked contact emails for the timeframe | [optional] 17 | **invalid** | **int** | Number of invalid emails for the timeframe | [optional] 18 | **unsubscribed** | **int** | Number of unsubscribed emails for the timeframe | [optional] 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GetAllExternalFeeds.md: -------------------------------------------------------------------------------- 1 | # GetAllExternalFeeds 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | Total number of batches | [optional] 7 | **feeds** | [**list[GetAllExternalFeedsFeeds]**](GetAllExternalFeedsFeeds.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetAllExternalFeedsFeeds.md: -------------------------------------------------------------------------------- 1 | # GetAllExternalFeedsFeeds 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | ID of the feed | 7 | **name** | **str** | Name of the feed | 8 | **url** | **str** | URL of the feed | 9 | **auth_type** | **str** | Auth type of the feed: * `basic` * `token` * `noAuth` | 10 | **username** | **str** | Username for authType `basic` | [optional] 11 | **password** | **str** | Password for authType `basic` | [optional] 12 | **token** | **str** | Token for authType `token` | [optional] 13 | **headers** | [**list[GetExternalFeedByUUIDHeaders]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | 14 | **max_retries** | **int** | Maximum number of retries on the feed url | 15 | **cache** | **bool** | Toggle caching of feed url response | 16 | **created_at** | **datetime** | Datetime on which the feed was created | 17 | **modified_at** | **datetime** | Datetime on which the feed was modified | 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/GetAttributes.md: -------------------------------------------------------------------------------- 1 | # GetAttributes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **attributes** | [**list[GetAttributesAttributes]**](GetAttributesAttributes.md) | Listing of available contact attributes in your account | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetAttributesAttributes.md: -------------------------------------------------------------------------------- 1 | # GetAttributesAttributes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the attribute | 7 | **category** | **str** | Category of the attribute | 8 | **type** | **str** | Type of the attribute | [optional] 9 | **enumeration** | [**list[GetAttributesEnumeration]**](GetAttributesEnumeration.md) | Parameter only available for \"category\" type attributes. | [optional] 10 | **calculated_value** | **str** | Calculated value formula | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetAttributesEnumeration.md: -------------------------------------------------------------------------------- 1 | # GetAttributesEnumeration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **int** | ID of Value of the \"category\" type attribute | 7 | **label** | **str** | Label of the \"category\" type attribute | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetBlockedDomains.md: -------------------------------------------------------------------------------- 1 | # GetBlockedDomains 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **domains** | **list[str]** | List of all blocked domains | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | # GetCampaignRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **lists** | **list[int]** | | 7 | **exclusion_lists** | **list[int]** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetCategories.md: -------------------------------------------------------------------------------- 1 | # GetCategories 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **categories** | **list[object]** | | 7 | **count** | **int** | Number of categories | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetCategoryDetails.md: -------------------------------------------------------------------------------- 1 | # GetCategoryDetails 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Category ID for which you requested the details | 7 | **name** | **str** | Name of the category for which you requested the details | 8 | **created_at** | **str** | Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) | 9 | **modified_at** | **str** | Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) | 10 | **url** | **str** | URL to the category | [optional] 11 | **is_deleted** | **bool** | category deleted from the shop's database | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/GetChildAccountCreationStatus.md: -------------------------------------------------------------------------------- 1 | # GetChildAccountCreationStatus 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **child_account_created** | **bool** | Status of child account creation whether it is successfully created (exists) or not. | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetChildDomain.md: -------------------------------------------------------------------------------- 1 | # GetChildDomain 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **domain** | **str** | Sender domain | [optional] 7 | **active** | **bool** | indicates whether a domain is verified or not | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildDomains.md: -------------------------------------------------------------------------------- 1 | # GetChildDomains 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetChildInfo.md: -------------------------------------------------------------------------------- 1 | # GetChildInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Login Email | 7 | **first_name** | **str** | First Name | 8 | **last_name** | **str** | Last Name | 9 | **company_name** | **str** | Name of the company | 10 | **credits** | [**GetChildInfoCredits**](GetChildInfoCredits.md) | | [optional] 11 | **statistics** | [**GetChildInfoStatistics**](GetChildInfoStatistics.md) | | [optional] 12 | **password** | **str** | The encrypted password of child account | 13 | **ips** | **list[str]** | IP(s) associated to a child account user | [optional] 14 | **api_keys** | [**GetChildInfoApiKeys**](GetChildInfoApiKeys.md) | | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetChildInfoApiKeys.md: -------------------------------------------------------------------------------- 1 | # GetChildInfoApiKeys 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **v2** | [**list[GetChildInfoApiKeysV2]**](GetChildInfoApiKeysV2.md) | | 7 | **v3** | [**list[GetChildInfoApiKeysV3]**](GetChildInfoApiKeysV3.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildInfoApiKeysV2.md: -------------------------------------------------------------------------------- 1 | # GetChildInfoApiKeysV2 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the key for version 2 | 7 | **key** | **str** | API Key for version 2 | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildInfoApiKeysV3.md: -------------------------------------------------------------------------------- 1 | # GetChildInfoApiKeysV3 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the key for version 3 | 7 | **key** | **str** | API Key for version 3 | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildInfoCredits.md: -------------------------------------------------------------------------------- 1 | # GetChildInfoCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email_credits** | **int** | Email credits available for your child | [optional] 7 | **sms_credits** | **int** | SMS credits available for your child | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetChildInfoStatistics.md: -------------------------------------------------------------------------------- 1 | # GetChildInfoStatistics 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **previous_month_total_sent** | **int** | Overall emails sent for the previous month | [optional] 7 | **current_month_total_sent** | **int** | Overall emails sent for current month | [optional] 8 | **total_sent** | **int** | Overall emails sent for since the account exists | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetChildrenList.md: -------------------------------------------------------------------------------- 1 | # GetChildrenList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **children** | **list[object]** | Your children's account information | [optional] 7 | **count** | **int** | Number of child accounts | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetClient.md: -------------------------------------------------------------------------------- 1 | # GetClient 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Login Email | 7 | **first_name** | **str** | First Name | 8 | **last_name** | **str** | Last Name | 9 | **company_name** | **str** | Name of the company | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsClicked.md: -------------------------------------------------------------------------------- 1 | # GetContactCampaignStatsClicked 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **int** | ID of the campaign which generated the event | 7 | **links** | [**list[GetExtendedContactDetailsStatisticsLinks]**](GetExtendedContactDetailsStatisticsLinks.md) | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsOpened.md: -------------------------------------------------------------------------------- 1 | # GetContactCampaignStatsOpened 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **int** | ID of the campaign which generated the event | 7 | **count** | **int** | Number of openings of the campaign | 8 | **event_time** | **str** | UTC date-time of the event | 9 | **ip** | **str** | IP from which the user has opened the campaign | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsTransacAttributes.md: -------------------------------------------------------------------------------- 1 | # 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** | **int** | ID of the order | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetContactCampaignStatsUnsubscriptions.md: -------------------------------------------------------------------------------- 1 | # GetContactCampaignStatsUnsubscriptions 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_unsubscription** | [**list[GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription]**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email | 7 | **admin_unsubscription** | [**list[GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription]**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetContactDetails.md: -------------------------------------------------------------------------------- 1 | # GetContactDetails 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address of the contact for which you requested the details | 7 | **id** | **int** | ID of the contact for which you requested the details | 8 | **email_blacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | 9 | **sms_blacklisted** | **bool** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | 10 | **created_at** | **str** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 11 | **modified_at** | **str** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 12 | **list_ids** | **list[int]** | | 13 | **list_unsubscribed** | **list[int]** | | [optional] 14 | **attributes** | **object** | Set of attributes of the contact | 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetContacts.md: -------------------------------------------------------------------------------- 1 | # GetContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **contacts** | **list[object]** | | 7 | **count** | **int** | Number of contacts | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetDeviceBrowserStats.md: -------------------------------------------------------------------------------- 1 | # GetDeviceBrowserStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **clickers** | **int** | Number of total clicks for the campaign using the particular browser | 7 | **unique_clicks** | **int** | Number of unique clicks for the campaign using the particular browser | 8 | **viewed** | **int** | Number of openings for the campaign using the particular browser | 9 | **unique_views** | **int** | Number of unique openings for the campaign using the particular browser | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetEmailCampaigns.md: -------------------------------------------------------------------------------- 1 | # GetEmailCampaigns 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaigns** | **list[object]** | | [optional] 7 | **count** | **int** | Number of Email campaigns retrieved | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetEmailEventReport.md: -------------------------------------------------------------------------------- 1 | # GetEmailEventReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **events** | [**list[GetEmailEventReportEvents]**](GetEmailEventReportEvents.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetEmailEventReportEvents.md: -------------------------------------------------------------------------------- 1 | # GetEmailEventReportEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address which generates the event | 7 | **_date** | **str** | UTC date-time on which the event has been generated | 8 | **subject** | **str** | Subject of the event | [optional] 9 | **message_id** | **str** | Message ID which generated the event | 10 | **event** | **str** | Event which occurred | 11 | **reason** | **str** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 12 | **tag** | **str** | Tag of the email which generated the event | [optional] 13 | **ip** | **str** | 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** | **str** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional] 15 | **_from** | **str** | Sender email from which the emails are sent | [optional] 16 | **template_id** | **int** | ID of the template (only available if the email is template based) | [optional] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/GetExtendedCampaignOverviewSender.md: -------------------------------------------------------------------------------- 1 | # GetExtendedCampaignOverviewSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Sender name of the campaign | [optional] 7 | **email** | **str** | Sender email of the campaign | [optional] 8 | **id** | **str** | Sender id of the campaign | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetExtendedCampaignStats.md: -------------------------------------------------------------------------------- 1 | # GetExtendedCampaignStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **global_stats** | **object** | Overall statistics of the campaign | 7 | **campaign_stats** | **list[object]** | List-wise statistics of the campaign. | 8 | **mirror_click** | **int** | Number of clicks on mirror link | 9 | **remaining** | **int** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetExtendedClient.md: -------------------------------------------------------------------------------- 1 | # GetExtendedClient 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Login Email | 7 | **first_name** | **str** | First Name | 8 | **last_name** | **str** | Last Name | 9 | **company_name** | **str** | Name of the company | 10 | **address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetExtendedClientAddress.md: -------------------------------------------------------------------------------- 1 | # GetExtendedClientAddress 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **street** | **str** | Street information | 7 | **city** | **str** | City information | 8 | **zip_code** | **str** | Zip Code information | 9 | **country** | **str** | Country information | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetails.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetails 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address of the contact for which you requested the details | 7 | **id** | **int** | ID of the contact for which you requested the details | 8 | **email_blacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | 9 | **sms_blacklisted** | **bool** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | 10 | **created_at** | **str** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 11 | **modified_at** | **str** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 12 | **list_ids** | **list[int]** | | 13 | **list_unsubscribed** | **list[int]** | | [optional] 14 | **attributes** | **object** | Set of attributes of the contact | 15 | **statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | | 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsClicked.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetailsStatisticsClicked 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **int** | ID of the campaign which generated the event | 7 | **links** | [**list[GetExtendedContactDetailsStatisticsLinks]**](GetExtendedContactDetailsStatisticsLinks.md) | Listing of the clicked links for the campaign | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsDelivered.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetailsStatisticsDelivered 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **int** | ID of the campaign which generated the event | 7 | **event_time** | **str** | UTC date-time of the event | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsLinks.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetailsStatisticsLinks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | Number of clicks on this link for the campaign | 7 | **event_time** | **str** | UTC date-time of the event | 8 | **ip** | **str** | IP from which the user has clicked on the link | 9 | **url** | **str** | URL of the clicked link | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsMessagesSent.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetailsStatisticsMessagesSent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **int** | ID of the campaign which generated the event | 7 | **event_time** | **str** | UTC date-time of the event | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsOpened.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetailsStatisticsOpened 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **int** | ID of the campaign which generated the event | 7 | **count** | **int** | Number of openings for the campaign | 8 | **event_time** | **str** | UTC date-time of the event | 9 | **ip** | **str** | IP from which the user has opened the email | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetailsStatisticsUnsubscriptions 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **user_unsubscription** | [**list[GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription]**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact unsubscribe via unsubscription link in a campaign | 7 | **admin_unsubscription** | [**list[GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription]**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **event_time** | **str** | UTC date-time of the event | 7 | **ip** | **str** | IP from which the user has been unsubscribed | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **int** | ID of the campaign which generated the event | 7 | **event_time** | **str** | UTC date-time of the event | 8 | **ip** | **str** | IP from which the user has unsubscribed | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetExtendedList.md: -------------------------------------------------------------------------------- 1 | # GetExtendedList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the list | 7 | **name** | **str** | Name of the list | 8 | **total_blacklisted** | **int** | Number of blacklisted contacts in the list | 9 | **total_subscribers** | **int** | Number of contacts in the list | 10 | **unique_subscribers** | **int** | Number of unique contacts in the list | 11 | **folder_id** | **int** | ID of the folder | 12 | **created_at** | **str** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **campaign_stats** | [**list[GetExtendedListCampaignStats]**](GetExtendedListCampaignStats.md) | | [optional] 14 | **dynamic_list** | **bool** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetExtendedListCampaignStats.md: -------------------------------------------------------------------------------- 1 | # GetExtendedListCampaignStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaign_id** | **int** | ID of the campaign | 7 | **stats** | [**GetCampaignStats**](GetCampaignStats.md) | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetExternalFeedByUUID.md: -------------------------------------------------------------------------------- 1 | # GetExternalFeedByUUID 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | ID of the feed | 7 | **name** | **str** | Name of the feed | 8 | **url** | **str** | URL of the feed | 9 | **auth_type** | **str** | Auth type of the feed: * `basic` * `token` * `noAuth` | 10 | **username** | **str** | Username for authType `basic` | [optional] 11 | **password** | **str** | Password for authType `basic` | [optional] 12 | **token** | **str** | Token for authType `token` | [optional] 13 | **headers** | [**list[GetExternalFeedByUUIDHeaders]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | 14 | **max_retries** | **int** | Maximum number of retries on the feed url | 15 | **cache** | **bool** | Toggle caching of feed url response | 16 | **created_at** | **datetime** | Datetime on which the feed was created | 17 | **modified_at** | **datetime** | Datetime on which the feed was modified | 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/GetExternalFeedByUUIDHeaders.md: -------------------------------------------------------------------------------- 1 | # GetExternalFeedByUUIDHeaders 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the header | [optional] 7 | **value** | **str** | Value of the header | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetFolder.md: -------------------------------------------------------------------------------- 1 | # GetFolder 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the folder | 7 | **name** | **str** | Name of the folder | 8 | **total_blacklisted** | **int** | Number of blacklisted contacts in the folder | 9 | **total_subscribers** | **int** | Number of contacts in the folder | 10 | **unique_subscribers** | **int** | Number of unique contacts in the folder | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetFolderLists.md: -------------------------------------------------------------------------------- 1 | # GetFolderLists 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **lists** | **list[object]** | | [optional] 7 | **count** | **int** | Number of lists in the folder | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetFolders.md: -------------------------------------------------------------------------------- 1 | # GetFolders 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **folders** | **list[object]** | | [optional] 7 | **count** | **int** | Number of folders available in your account | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEvents.md: -------------------------------------------------------------------------------- 1 | # GetInboundEmailEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **events** | [**list[GetInboundEmailEventsEvents]**](GetInboundEmailEventsEvents.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsByUuid.md: -------------------------------------------------------------------------------- 1 | # 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** | **str** | Recipient’s email address | [optional] 9 | **sender** | **str** | Sender’s email address | [optional] 10 | **message_id** | **str** | Value of the Message-ID header. This will be present only after the processing is done. | [optional] 11 | **subject** | **str** | Value of the Subject header. This will be present only after the processing is done. | [optional] 12 | **attachments** | [**list[GetInboundEmailEventsByUuidAttachments]**](GetInboundEmailEventsByUuidAttachments.md) | List of attachments of the email. This will be present only after the processing is done. | [optional] 13 | **logs** | [**list[GetInboundEmailEventsByUuidLogs]**](GetInboundEmailEventsByUuidLogs.md) | List of events/logs that describe the lifecycle of the email on SIB platform | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsByUuidAttachments.md: -------------------------------------------------------------------------------- 1 | # GetInboundEmailEventsByUuidAttachments 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | filename specified in the Content-Disposition header of the attachment | [optional] 7 | **content_type** | **str** | value of the Content-Type header of the attachment | [optional] 8 | **content_id** | **str** | value of the Content-ID header of the attachment. | [optional] 9 | **content_length** | **int** | size of the attachment in bytes | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsByUuidLogs.md: -------------------------------------------------------------------------------- 1 | # GetInboundEmailEventsByUuidLogs 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **_date** | **datetime** | Date of the event | [optional] 7 | **type** | **str** | Type of the event | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetInboundEmailEventsEvents.md: -------------------------------------------------------------------------------- 1 | # GetInboundEmailEventsEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **uuid** | **str** | UUID that can be used to fetch additional data | 7 | **_date** | **datetime** | Date when email was received on SMTP relay | 8 | **sender** | **str** | Sender’s email address | 9 | **recipient** | **str** | Recipient’s email address | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetIp.md: -------------------------------------------------------------------------------- 1 | # GetIp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the dedicated IP | 7 | **ip** | **str** | Dedicated IP | 8 | **active** | **bool** | Status of the IP (true=active, false=inactive) | 9 | **domain** | **str** | Domain associated to the IP | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetIpFromSender.md: -------------------------------------------------------------------------------- 1 | # GetIpFromSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the dedicated IP | 7 | **ip** | **str** | Dedicated IP | 8 | **domain** | **str** | Domain associated to the IP | 9 | **weight** | **int** | Weight of the IP | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetIps.md: -------------------------------------------------------------------------------- 1 | # GetIps 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ips** | [**list[GetIp]**](GetIp.md) | Dedicated IP(s) available on your account | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetIpsFromSender.md: -------------------------------------------------------------------------------- 1 | # GetIpsFromSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ips** | [**list[GetIpFromSender]**](GetIpFromSender.md) | Dedicated IP(s) linked to a sender | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetList.md: -------------------------------------------------------------------------------- 1 | # GetList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the list | 7 | **name** | **str** | Name of the list | 8 | **total_blacklisted** | **int** | Number of blacklisted contacts in the list | 9 | **total_subscribers** | **int** | Number of contacts in the list | 10 | **unique_subscribers** | **int** | Number of unique contacts in the list | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetLists.md: -------------------------------------------------------------------------------- 1 | # GetLists 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **lists** | **list[object]** | Listing of all the lists available in your account | [optional] 7 | **count** | **int** | Number of lists in your account | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetProcess.md: -------------------------------------------------------------------------------- 1 | # GetProcess 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | Id of the process | 7 | **status** | **str** | Status of the process | 8 | **name** | **str** | Process name | 9 | **export_url** | **str** | URL on which send export the of contacts once the process is completed | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetProcesses.md: -------------------------------------------------------------------------------- 1 | # GetProcesses 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **processes** | [**list[GetProcess]**](GetProcess.md) | List of processes available on your account | [optional] 7 | **count** | **int** | Number of processes available on your account | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetProducts.md: -------------------------------------------------------------------------------- 1 | # GetProducts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **products** | **list[object]** | | 7 | **count** | **int** | Number of products | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetReports.md: -------------------------------------------------------------------------------- 1 | # GetReports 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **reports** | [**list[GetReportsReports]**](GetReportsReports.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetReportsReports.md: -------------------------------------------------------------------------------- 1 | # GetReportsReports 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **_date** | **date** | Date of the statistics | 7 | **requests** | **int** | Number of requests for the date | 8 | **delivered** | **int** | Number of delivered emails for the date | 9 | **hard_bounces** | **int** | Number of hardbounces for the date | 10 | **soft_bounces** | **int** | Number of softbounces for the date | 11 | **clicks** | **int** | Number of clicks for the date | 12 | **unique_clicks** | **int** | Number of unique clicks for the date | 13 | **opens** | **int** | Number of openings for the date | 14 | **unique_opens** | **int** | Number of unique openings for the date | 15 | **spam_reports** | **int** | Number of complaints (spam reports) for the date | 16 | **blocked** | **int** | Number of blocked emails for the date | 17 | **invalid** | **int** | Number of invalid emails for the date | 18 | **unsubscribed** | **int** | Number of unsubscribed emails for the date | 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GetScheduledEmailByBatchId.md: -------------------------------------------------------------------------------- 1 | # GetScheduledEmailByBatchId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | Total number of batches | [optional] 7 | **batches** | [**list[GetScheduledEmailByBatchIdBatches]**](GetScheduledEmailByBatchIdBatches.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetScheduledEmailByBatchIdBatches.md: -------------------------------------------------------------------------------- 1 | # 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** | **str** | Current status of the scheduled batch | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetScheduledEmailByMessageId.md: -------------------------------------------------------------------------------- 1 | # 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** | **str** | Current status of the scheduled email | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetSendersList.md: -------------------------------------------------------------------------------- 1 | # GetSendersList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **senders** | [**list[GetSendersListSenders]**](GetSendersListSenders.md) | List of the senders available in your account | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetSendersListIps.md: -------------------------------------------------------------------------------- 1 | # GetSendersListIps 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ip** | **str** | Dedicated IP available in your account | 7 | **domain** | **str** | Domain of the IP | 8 | **weight** | **int** | Weight of the IP for this sender | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetSendersListSenders.md: -------------------------------------------------------------------------------- 1 | # GetSendersListSenders 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | Id of the sender | 7 | **name** | **str** | From Name associated to the sender | 8 | **email** | **str** | From Email associated to the sender | 9 | **active** | **bool** | Status of sender (true=activated, false=deactivated) | 10 | **ips** | [**list[GetSendersListIps]**](GetSendersListIps.md) | List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetSharedTemplateUrl.md: -------------------------------------------------------------------------------- 1 | # GetSharedTemplateUrl 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **shared_url** | **str** | A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users. | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetSmsCampaign.md: -------------------------------------------------------------------------------- 1 | # GetSmsCampaign 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the SMS Campaign | 7 | **name** | **str** | Name of the SMS Campaign | 8 | **status** | **str** | Status of the SMS Campaign | 9 | **content** | **str** | Content of the SMS Campaign | 10 | **scheduled_at** | **str** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 11 | **sender** | **str** | Sender of the SMS Campaign | 12 | **created_at** | **str** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **modified_at** | **str** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | **recipients** | **object** | | 15 | **statistics** | **object** | | 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/GetSmsCampaignOverview.md: -------------------------------------------------------------------------------- 1 | # GetSmsCampaignOverview 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the SMS Campaign | 7 | **name** | **str** | Name of the SMS Campaign | 8 | **status** | **str** | Status of the SMS Campaign | 9 | **content** | **str** | Content of the SMS Campaign | 10 | **scheduled_at** | **str** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 11 | **sender** | **str** | Sender of the SMS Campaign | 12 | **created_at** | **str** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **modified_at** | **str** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetSmsCampaignStats.md: -------------------------------------------------------------------------------- 1 | # GetSmsCampaignStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **delivered** | **int** | Number of delivered SMS | 7 | **sent** | **int** | Number of sent SMS | 8 | **processing** | **int** | Number of processing SMS | 9 | **soft_bounces** | **int** | Number of softbounced SMS | 10 | **hard_bounces** | **int** | Number of hardbounced SMS | 11 | **unsubscriptions** | **int** | Number of unsubscription SMS | 12 | **answered** | **int** | Number of replies to the SMS | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetSmsCampaigns.md: -------------------------------------------------------------------------------- 1 | # GetSmsCampaigns 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **campaigns** | **list[object]** | | [optional] 7 | **count** | **int** | Number of SMS campaigns retrieved | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetSmsEventReport.md: -------------------------------------------------------------------------------- 1 | # GetSmsEventReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **events** | [**list[GetSmsEventReportEvents]**](GetSmsEventReportEvents.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetSmsEventReportEvents.md: -------------------------------------------------------------------------------- 1 | # GetSmsEventReportEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **phone_number** | **str** | Phone number which has generated the event | [optional] 7 | **_date** | **str** | UTC date-time on which the event has been generated | [optional] 8 | **message_id** | **str** | Message ID which generated the event | [optional] 9 | **event** | **str** | Event which occurred | [optional] 10 | **reason** | **str** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 11 | **reply** | **str** | | [optional] 12 | **tag** | **str** | Tag of the SMS which generated the event | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetSmtpTemplateOverview.md: -------------------------------------------------------------------------------- 1 | # GetSmtpTemplateOverview 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the template | 7 | **name** | **str** | Name of the template | 8 | **subject** | **str** | Subject of the template | 9 | **is_active** | **bool** | Status of template (true=active, false=inactive) | 10 | **test_sent** | **bool** | 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** | **str** | Email defined as the \"Reply to\" for the template | 13 | **to_field** | **str** | Customisation of the \"to\" field for the template | 14 | **tag** | **str** | Tag of the template | 15 | **html_content** | **str** | HTML content of the template | 16 | **created_at** | **str** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 17 | **modified_at** | **str** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 18 | **doi_template** | **bool** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [optional] 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/GetSmtpTemplateOverviewSender.md: -------------------------------------------------------------------------------- 1 | # GetSmtpTemplateOverviewSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | From email for the template | [optional] 7 | **email** | **str** | From email for the template | [optional] 8 | **id** | **str** | Sender id of the template | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GetSmtpTemplates.md: -------------------------------------------------------------------------------- 1 | # GetSmtpTemplates 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | Count of transactional email templates | [optional] 7 | **templates** | [**list[GetSmtpTemplateOverview]**](GetSmtpTemplateOverview.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetSsoToken.md: -------------------------------------------------------------------------------- 1 | # GetSsoToken 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **token** | **str** | Session token, it will remain valid for 15 days. | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetStatsByBrowser.md: -------------------------------------------------------------------------------- 1 | # GetStatsByBrowser 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetStatsByDevice.md: -------------------------------------------------------------------------------- 1 | # GetStatsByDevice 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **desktop** | [**dict(str, GetDeviceBrowserStats)**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional] 7 | **mobile** | [**dict(str, GetDeviceBrowserStats)**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional] 8 | **tablet** | [**dict(str, GetDeviceBrowserStats)**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional] 9 | **unknown** | [**dict(str, GetDeviceBrowserStats)**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetStatsByDomain.md: -------------------------------------------------------------------------------- 1 | # GetStatsByDomain 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/GetTransacAggregatedSmsReport.md: -------------------------------------------------------------------------------- 1 | # GetTransacAggregatedSmsReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **range** | **str** | Time frame of the report | [optional] 7 | **requests** | **int** | Number of requests for the timeframe | [optional] 8 | **delivered** | **int** | Number of delivered SMS for the timeframe | [optional] 9 | **hard_bounces** | **int** | Number of hardbounces for the timeframe | [optional] 10 | **soft_bounces** | **int** | Number of softbounces for the timeframe | [optional] 11 | **blocked** | **int** | Number of blocked contact for the timeframe | [optional] 12 | **unsubscribed** | **int** | Number of unsubscription for the timeframe | [optional] 13 | **replied** | **int** | Number of answered SMS for the timeframe | [optional] 14 | **accepted** | **int** | Number of accepted for the timeframe | [optional] 15 | **rejected** | **int** | Number of rejected for the timeframe | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/GetTransacBlockedContacts.md: -------------------------------------------------------------------------------- 1 | # GetTransacBlockedContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | Count of blocked or unsubscribed contact | [optional] 7 | **contacts** | [**list[GetTransacBlockedContactsContacts]**](GetTransacBlockedContactsContacts.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetTransacBlockedContactsContacts.md: -------------------------------------------------------------------------------- 1 | # GetTransacBlockedContactsContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address of the blocked or unsubscribed contact | 7 | **sender_email** | **str** | Sender email address of the blocked or unsubscribed contact | 8 | **reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | | 9 | **blocked_at** | **str** | Date when the contact was blocked or unsubscribed on | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetTransacBlockedContactsReason.md: -------------------------------------------------------------------------------- 1 | # GetTransacBlockedContactsReason 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **code** | **str** | Reason code for blocking / unsubscribing (This code is safe for comparison) | [optional] 7 | **message** | **str** | Reason for blocking / unsubscribing (This string is not safe for comparison) | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetTransacEmailContent.md: -------------------------------------------------------------------------------- 1 | # GetTransacEmailContent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address to which transactional email has been sent | 7 | **subject** | **str** | Subject of the sent email | 8 | **template_id** | **int** | Id of the template | [optional] 9 | **_date** | **str** | Date on which transactional email was sent | 10 | **events** | [**list[GetTransacEmailContentEvents]**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email | 11 | **body** | **str** | Actual content of the transactional email that has been sent | 12 | **attachment_count** | **int** | Count of the attachments that were sent in the email | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetTransacEmailContentEvents.md: -------------------------------------------------------------------------------- 1 | # GetTransacEmailContentEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the event that occurred on the sent email | 7 | **time** | **str** | Time at which the event occurred | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetTransacEmailsList.md: -------------------------------------------------------------------------------- 1 | # GetTransacEmailsList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | Total number of transactional emails available on your account according to the passed filter | [optional] 7 | **transactional_emails** | [**list[GetTransacEmailsListTransactionalEmails]**](GetTransacEmailsListTransactionalEmails.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetTransacEmailsListTransactionalEmails.md: -------------------------------------------------------------------------------- 1 | # GetTransacEmailsListTransactionalEmails 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address to which transactional email has been sent | 7 | **subject** | **str** | Subject of the sent email | 8 | **template_id** | **int** | Id of the template | [optional] 9 | **message_id** | **str** | Message Id of the sent email | 10 | **uuid** | **str** | Unique id of the email sent to a particular contact | 11 | **_date** | **str** | Date on which transactional email was sent | 12 | **_from** | **str** | Email address of the sender from which the email was sent | [optional] 13 | **tags** | **list[str]** | Tags used for your email | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetTransacSmsReport.md: -------------------------------------------------------------------------------- 1 | # GetTransacSmsReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **reports** | [**list[GetTransacSmsReportReports]**](GetTransacSmsReportReports.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetTransacSmsReportReports.md: -------------------------------------------------------------------------------- 1 | # GetTransacSmsReportReports 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **_date** | **date** | Date for which statistics are retrieved | [optional] 7 | **requests** | **int** | Number of requests for the date | [optional] 8 | **delivered** | **int** | Number of delivered SMS for the date | [optional] 9 | **hard_bounces** | **int** | Number of hardbounces for the date | [optional] 10 | **soft_bounces** | **int** | Number of softbounces for the date | [optional] 11 | **blocked** | **int** | Number of blocked contact for the date | [optional] 12 | **unsubscribed** | **int** | Number of unsubscription for the date | [optional] 13 | **replied** | **int** | Number of answered SMS for the date | [optional] 14 | **accepted** | **int** | Number of accepted for the date | [optional] 15 | **rejected** | **int** | Number of rejected for the date | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/GetWATemplates.md: -------------------------------------------------------------------------------- 1 | # GetWATemplates 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **templates** | [**list[GetWATemplatesTemplates]**](GetWATemplatesTemplates.md) | | 7 | **count** | **int** | Number of whatsapp templates retrived | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/GetWATemplatesTemplates.md: -------------------------------------------------------------------------------- 1 | # GetWATemplatesTemplates 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | id of the template | 7 | **name** | **str** | Name of the Whatsapp template | 8 | **status** | **str** | Status of the Whatsapp template | 9 | **language** | **str** | Language in which template exists | 10 | **category** | **str** | category of the template | 11 | **error_reason** | **str** | Error reason in the template creation | [optional] 12 | **created_at** | **str** | Creation UTC date-time of the whatsapp template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | **modified_at** | **str** | UTC date-time of last modification of the whatsapp template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GetWebhook.md: -------------------------------------------------------------------------------- 1 | # GetWebhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **str** | URL of the webhook | 7 | **id** | **int** | ID of the webhook | 8 | **description** | **str** | Description of the webhook | 9 | **events** | **list[str]** | | 10 | **type** | **str** | Type of webhook (marketing or transactional) | 11 | **created_at** | **str** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 12 | **modified_at** | **str** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetWebhooks.md: -------------------------------------------------------------------------------- 1 | # GetWebhooks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **webhooks** | **list[object]** | | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetWhatsappCampaignOverview.md: -------------------------------------------------------------------------------- 1 | # GetWhatsappCampaignOverview 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | ID of the Whatsapp Campaign | 7 | **campaign_name** | **str** | Name of the Whatsapp Campaign | 8 | **campaign_status** | **str** | Status of the Whatsapp Campaign | 9 | **scheduled_at** | **str** | UTC date-time on which Whatsapp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 10 | **sender_number** | **str** | Sender of the Whatsapp Campaign | 11 | **stats** | [**WhatsappCampStats**](WhatsappCampStats.md) | | [optional] 12 | **template** | [**WhatsappCampTemplate**](WhatsappCampTemplate.md) | | 13 | **created_at** | **str** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 14 | **modified_at** | **str** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/GetWhatsappEventReport.md: -------------------------------------------------------------------------------- 1 | # GetWhatsappEventReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **events** | [**list[GetWhatsappEventReportEvents]**](GetWhatsappEventReportEvents.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetWhatsappEventReportEvents.md: -------------------------------------------------------------------------------- 1 | # GetWhatsappEventReportEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **contact_number** | **str** | WhatsApp Number with country code. Example, 85264318721 | 7 | **_date** | **str** | UTC date-time on which the event has been generated | 8 | **message_id** | **str** | Message ID which generated the event | 9 | **event** | **str** | Event which occurred | 10 | **reason** | **str** | Reason for the event (will be there in case of `error` and `soft-bounce` events) | [optional] 11 | **body** | **str** | Text of the reply (will be there only in case of `reply` event with text) | [optional] 12 | **media_url** | **str** | Url of the media reply (will be there only in case of `reply` event with media) | [optional] 13 | **sender_number** | **str** | WhatsApp Number with country code. Example, 85264318721 | 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/InlineResponse200.md: -------------------------------------------------------------------------------- 1 | # InlineResponse200 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique company id | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/InlineResponse201.md: -------------------------------------------------------------------------------- 1 | # InlineResponse201 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique deal id | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/InlineResponse2011.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2011 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique task id | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/InlineResponse2012.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2012 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **message_id** | **str** | messageId of sent message | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/InlineResponse2013.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2013 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | ID of the object created | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ManageIp.md: -------------------------------------------------------------------------------- 1 | # ManageIp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ip** | **str** | Dedicated ID | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # MasterDetailsResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email id of master account | [optional] 7 | **company_name** | **str** | Company name of master account organization | [optional] 8 | **id** | **int** | Unique identifier of the master account organization | [optional] 9 | **currency_code** | **str** | Currency code of the master account organization | [optional] 10 | **timezone** | **str** | Timezone of the master account organization | [optional] 11 | **billing_info** | [**MasterDetailsResponseBillingInfo**](MasterDetailsResponseBillingInfo.md) | | [optional] 12 | **plan_info** | [**MasterDetailsResponsePlanInfo**](MasterDetailsResponsePlanInfo.md) | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponseBillingInfo.md: -------------------------------------------------------------------------------- 1 | # MasterDetailsResponseBillingInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Billing email id of master account | [optional] 7 | **company_name** | **str** | Company name of master account | [optional] 8 | **name** | [**MasterDetailsResponseBillingInfoName**](MasterDetailsResponseBillingInfoName.md) | | [optional] 9 | **address** | [**MasterDetailsResponseBillingInfoAddress**](MasterDetailsResponseBillingInfoAddress.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponseBillingInfoAddress.md: -------------------------------------------------------------------------------- 1 | # MasterDetailsResponseBillingInfoAddress 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **street_address** | **str** | Street address | [optional] 7 | **locality** | **str** | Locality | [optional] 8 | **postal_code** | **str** | Postal code | [optional] 9 | **state_code** | **str** | State code | [optional] 10 | **country_code** | **str** | Country code | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponseBillingInfoName.md: -------------------------------------------------------------------------------- 1 | # MasterDetailsResponseBillingInfoName 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **given_name** | **str** | First name for billing | [optional] 7 | **family_name** | **str** | Last name for billing | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponsePlanInfo.md: -------------------------------------------------------------------------------- 1 | # MasterDetailsResponsePlanInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **currency_code** | **str** | Plan currency | [optional] 7 | **next_billing_at** | **int** | Timestamp of next billing date | [optional] 8 | **price** | **float** | Plan amount | [optional] 9 | **plan_period** | **str** | Plan period type | [optional] 10 | **sub_accounts** | **int** | Number of sub-accounts | [optional] 11 | **features** | [**list[MasterDetailsResponsePlanInfoFeatures]**](MasterDetailsResponsePlanInfoFeatures.md) | List of provided features in the plan | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MasterDetailsResponsePlanInfoFeatures.md: -------------------------------------------------------------------------------- 1 | # MasterDetailsResponsePlanInfoFeatures 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the feature | [optional] 7 | **unit_value** | **str** | Unit value of the feature | [optional] 8 | **quantity** | **int** | Quantity provided in the plan | [optional] 9 | **used** | **int** | Quantity consumed by master | [optional] 10 | **remaining** | **int** | Quantity remaining in the plan | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Note.md: -------------------------------------------------------------------------------- 1 | # Note 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique note Id | [optional] 7 | **text** | **str** | Text content of a note | 8 | **contact_ids** | **list[int]** | Contact ids linked to a note | [optional] 9 | **deal_ids** | **list[str]** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/NoteData.md: -------------------------------------------------------------------------------- 1 | # NoteData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **text** | **str** | Text content of a note | 7 | **contact_ids** | **list[int]** | Contact Ids linked to a note | [optional] 8 | **deal_ids** | **list[str]** | Deal Ids linked to a note | [optional] 9 | **company_ids** | **list[str]** | Company Ids linked to a note | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/NoteId.md: -------------------------------------------------------------------------------- 1 | # NoteId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique note Id | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/NoteList.md: -------------------------------------------------------------------------------- 1 | # NoteList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Order.md: -------------------------------------------------------------------------------- 1 | # Order 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique ID of the order. | 7 | **created_at** | **str** | Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created. | 8 | **updated_at** | **str** | Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated. | 9 | **status** | **str** | State of the order. | 10 | **amount** | **float** | Total amount of the order, including all shipping expenses, tax and the price of items. | 11 | **products** | [**list[OrderProducts]**](OrderProducts.md) | | 12 | **email** | **str** | Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter. | [optional] 13 | **billing** | [**OrderBilling**](OrderBilling.md) | | [optional] 14 | **coupons** | **list[str]** | Coupons applied to the order. Stored case insensitive. | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/OrderBatch.md: -------------------------------------------------------------------------------- 1 | # OrderBatch 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **orders** | [**list[Order]**](Order.md) | array of order objects | 7 | **notify_url** | **str** | Notify Url provided by client to get the status of batch request | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/OrderBilling.md: -------------------------------------------------------------------------------- 1 | # OrderBilling 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **address** | **str** | Full billing address. | [optional] 7 | **city** | **str** | Exact city of the address. | [optional] 8 | **country_code** | **str** | Billing country 2-letter ISO code. | [optional] 9 | **phone** | **str** | Phone number to contact for further details about the order, Mandatory if \"email\" field is not passed. | [optional] 10 | **post_code** | **str** | Postcode for delivery and billing. | [optional] 11 | **payment_method** | **str** | How the visitor will pay for the item(s), e.g. paypal, check, etc. | [optional] 12 | **region** | **str** | Exact region (state/province) for delivery and billing. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OrderProducts.md: -------------------------------------------------------------------------------- 1 | # OrderProducts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **product_id** | **str** | ID of the product. | 7 | **quantity** | **float** | How many pieces of the product the visitor has added to the cart. | 8 | **variant_id** | **str** | Product ID of the red color shirts. | [optional] 9 | **price** | **float** | The price of a unit of product | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Pipeline.md: -------------------------------------------------------------------------------- 1 | # Pipeline 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **stages** | [**list[PipelineStage]**](PipelineStage.md) | List of stages | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PipelineStage.md: -------------------------------------------------------------------------------- 1 | # PipelineStage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Stage id | [optional] 7 | **name** | **str** | Stage name | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PostContactInfo.md: -------------------------------------------------------------------------------- 1 | # PostContactInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **contacts** | [**PostContactInfoContacts**](PostContactInfoContacts.md) | | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PostContactInfoContacts.md: -------------------------------------------------------------------------------- 1 | # PostContactInfoContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **success** | **list[str]** | | [optional] 7 | **failure** | **list[str]** | | [optional] 8 | **total** | **int** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional] 9 | **process_id** | **int** | Id of the process created to remove contacts from list when user opts for \"all\" option. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PostSendFailed.md: -------------------------------------------------------------------------------- 1 | # PostSendFailed 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **code** | **int** | Response code | 7 | **message** | **str** | Response message | 8 | **unexisting_emails** | **list[str]** | | [optional] 9 | **without_list_emails** | **list[str]** | | [optional] 10 | **black_listed_emails** | **list[str]** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/PostSendSmsTestFailed.md: -------------------------------------------------------------------------------- 1 | # PostSendSmsTestFailed 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **code** | **int** | Response code | 7 | **message** | **str** | Response message | 8 | **unexisting_sms** | **list[str]** | | [optional] 9 | **without_list_sms** | **list[str]** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RemainingCreditModel.md: -------------------------------------------------------------------------------- 1 | # RemainingCreditModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **child** | [**RemainingCreditModelChild**](RemainingCreditModelChild.md) | | 7 | **reseller** | [**RemainingCreditModelReseller**](RemainingCreditModelReseller.md) | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RemainingCreditModelChild.md: -------------------------------------------------------------------------------- 1 | # 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RemainingCreditModelReseller.md: -------------------------------------------------------------------------------- 1 | # 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RemoveContactFromList.md: -------------------------------------------------------------------------------- 1 | # RemoveContactFromList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **emails** | **list[str]** | 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** | **list[int]** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 8 | **all** | **bool** | Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RemoveCredits.md: -------------------------------------------------------------------------------- 1 | # RemoveCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sms** | **int** | Required if email credits are empty. SMS credits to be removed from the child account | [optional] 7 | **email** | **int** | Required if sms credits are empty. Email credits to be removed from the child account | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RequestContactExport.md: -------------------------------------------------------------------------------- 1 | # RequestContactExport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **export_attributes** | **list[str]** | 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** | **str** | Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RequestContactImportNewList.md: -------------------------------------------------------------------------------- 1 | # RequestContactImportNewList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **list_name** | **str** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional] 7 | **folder_id** | **int** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RequestSMSRecipientExport.md: -------------------------------------------------------------------------------- 1 | # RequestSmsRecipientExport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **notify_url** | **str** | 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** | **str** | Filter the recipients based on how they interacted with the campaign | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ScheduleSmtpEmail.md: -------------------------------------------------------------------------------- 1 | # ScheduleSmtpEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **message_id** | **str** | Message ID of the transactional email scheduled | [optional] 7 | **message_ids** | **list[str]** | | [optional] 8 | **batch_id** | **str** | Batch ID of the batch transactional email scheduled | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SendEmailAttachment.md: -------------------------------------------------------------------------------- 1 | # SendEmailAttachment 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content** | **str** | Base64 encoded chunk data of the attachment generated on the fly | 7 | **name** | **str** | Required for content. Name of the attachment | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendReport.md: -------------------------------------------------------------------------------- 1 | # SendReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **language** | **str** | Language of email content for campaign report sending. | [optional] [default to 'fr'] 7 | **email** | [**SendReportEmail**](SendReportEmail.md) | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendReportEmail.md: -------------------------------------------------------------------------------- 1 | # SendReportEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **to** | **list[str]** | Email addresses of the recipients | 7 | **body** | **str** | Custom text message to be presented in the report email. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSms.md: -------------------------------------------------------------------------------- 1 | # SendSms 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **reference** | **str** | | 7 | **message_id** | **int** | | 8 | **sms_count** | **int** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailAttachment.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailAttachment 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **str** | Absolute url of the attachment (no local file). | [optional] 7 | **content** | **str** | Base64 encoded chunk data of the attachment generated on the fly | [optional] 8 | **name** | **str** | Required if content is passed. Name of the attachment | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailBcc.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailBcc 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address of the recipient in bcc | 7 | **name** | **str** | Name of the recipient in bcc. Maximum allowed characters are 70. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailCc.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailCc 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address of the recipient in cc | 7 | **name** | **str** | Name of the recipient in cc. Maximum allowed characters are 70. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailMessageVersions.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailMessageVersions 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **to** | [**list[SendSmtpEmailTo1]**](SendSmtpEmailTo1.md) | List of email addresses and names (_optional_) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | 7 | **params** | **dict(str, 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** | [**list[SendSmtpEmailBcc]**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional] 9 | **cc** | [**list[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** | **str** | Custom subject specific to message version | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailReplyTo.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailReplyTo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address in reply to | 7 | **name** | **str** | Name in reply to. Maximum allowed characters are 70. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailReplyTo1.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailReplyTo1 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address in reply to | 7 | **name** | **str** | Name in reply to. Maximum allowed characters are 70. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailSender.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | 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** | **str** | Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. | [optional] 8 | **id** | **int** | Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailTo.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailTo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address of the recipient | 7 | **name** | **str** | Name of the recipient. Maximum allowed characters are 70. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendSmtpEmailTo1.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailTo1 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | Email address of the recipient | 7 | **name** | **str** | Name of the recipient. **Maximum allowed characters are 70**. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SendTemplateEmail.md: -------------------------------------------------------------------------------- 1 | # SendTemplateEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **message_id** | **str** | Message ID of the template Email sent | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SendTestEmail.md: -------------------------------------------------------------------------------- 1 | # SendTestEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email_to** | **list[str]** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SendTestSms.md: -------------------------------------------------------------------------------- 1 | # SendTestSms 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **phone_number** | **str** | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SendWhatsappMessage.md: -------------------------------------------------------------------------------- 1 | # SendWhatsappMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **template_id** | **int** | ID of the template to send | [optional] 7 | **text** | **str** | Text to be sent as message body (will be overridden if templateId is passed in the same request) | [optional] 8 | **sender_number** | **str** | WhatsApp Number with country code. Example, 85264318721 | 9 | **contact_numbers** | **list[str]** | List of phone numbers of the contacts | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SsoTokenRequest.md: -------------------------------------------------------------------------------- 1 | # SsoTokenRequest 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | Id of the sub-account organization | 7 | **email** | **str** | User email of sub-account organization | [optional] 8 | **target** | **str** | Set target after login success * automation - Redirect to Automation after login * email_campaign - Redirect to Email Campaign after login * contacts - Redirect to Contacts after login * landing_pages - Redirect to Landing Pages after login * email_transactional - Redirect to Email Transactional after login * senders - Redirect to Contacts after login * sms_campaign - Redirect to Sms Campaign after login * sms_transactional - Redirect to Sms Transactional after login | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # SubAccountDetailsResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the sub-account user | [optional] 7 | **email** | **str** | Email id of the sub-account organization | [optional] 8 | **company_name** | **str** | Sub-account company name | [optional] 9 | **plan_info** | [**SubAccountDetailsResponsePlanInfo**](SubAccountDetailsResponsePlanInfo.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfo.md: -------------------------------------------------------------------------------- 1 | # 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** | **str** | type of the plan | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoCredits.md: -------------------------------------------------------------------------------- 1 | # SubAccountDetailsResponsePlanInfoCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sms** | **int** | SMS credits remaining on the sub-account | [optional] 7 | **emails** | [**SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md: -------------------------------------------------------------------------------- 1 | # SubAccountDetailsResponsePlanInfoCreditsEmails 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **quantity** | **int** | Quantity of email messaging limits provided | [optional] 7 | **remaining** | **int** | Available email messaging limits for use | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeatures.md: -------------------------------------------------------------------------------- 1 | # 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md: -------------------------------------------------------------------------------- 1 | # SubAccountDetailsResponsePlanInfoFeaturesInbox 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **quantity** | **int** | Quantity of inbox provided | [optional] 7 | **remaining** | **int** | Available inboxes for use | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md: -------------------------------------------------------------------------------- 1 | # SubAccountDetailsResponsePlanInfoFeaturesLandingPage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **quantity** | **int** | Quantity of landing pages provided | [optional] 7 | **remaining** | **int** | Available landing pages for use | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md: -------------------------------------------------------------------------------- 1 | # SubAccountDetailsResponsePlanInfoFeaturesUsers 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **quantity** | **int** | Quantity of multi-account's provided | [optional] 7 | **remaining** | **int** | Available multi-accounts for use | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountUpdatePlanRequest.md: -------------------------------------------------------------------------------- 1 | # SubAccountUpdatePlanRequest 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **credits** | [**SubAccountUpdatePlanRequestCredits**](SubAccountUpdatePlanRequestCredits.md) | | [optional] 7 | **features** | [**SubAccountUpdatePlanRequestFeatures**](SubAccountUpdatePlanRequestFeatures.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountUpdatePlanRequestCredits.md: -------------------------------------------------------------------------------- 1 | # SubAccountUpdatePlanRequestCredits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **int** | Number of email credits | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SubAccountUpdatePlanRequestFeatures.md: -------------------------------------------------------------------------------- 1 | # SubAccountUpdatePlanRequestFeatures 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **users** | **int** | Number of multi-users | [optional] 7 | **landing_page** | **int** | Number of landing pages | [optional] 8 | **inbox** | **int** | Number of inboxes | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountsResponse.md: -------------------------------------------------------------------------------- 1 | # SubAccountsResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | Total number of subaccounts | [optional] 7 | **sub_accounts** | [**list[SubAccountsResponseSubAccounts]**](SubAccountsResponseSubAccounts.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SubAccountsResponseSubAccounts.md: -------------------------------------------------------------------------------- 1 | # SubAccountsResponseSubAccounts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | id of the sub-account | 7 | **company_name** | **str** | Name of the sub-account company | 8 | **active** | **bool** | Whether the sub-account is active or not | 9 | **created_at** | **int** | Timestamp when the sub-account was created | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Task.md: -------------------------------------------------------------------------------- 1 | # Task 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Unique task id | [optional] 7 | **task_type_id** | **str** | Id for type of task e.g Call / Email / Meeting etc. | 8 | **name** | **str** | Name of task | 9 | **contacts_ids** | **list[int]** | Contact ids for contacts linked to this task | [optional] 10 | **deals_ids** | **list[str]** | Deal ids for deals a task is linked to | [optional] 11 | **companies_ids** | **list[str]** | Companies ids for companies a task is linked to | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TaskList.md: -------------------------------------------------------------------------------- 1 | # TaskList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **items** | [**list[Task]**](Task.md) | List of tasks | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/TaskReminder.md: -------------------------------------------------------------------------------- 1 | # TaskReminder 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **int** | Value of time unit before reminder is to be sent | 7 | **unit** | **str** | Unit of time before reminder is to be sent | 8 | **types** | **list[str]** | Type of task reminder e.g email, push | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/TaskTypes.md: -------------------------------------------------------------------------------- 1 | # TaskTypes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | Id of task type | [optional] 7 | **title** | **str** | Title of task type | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateAttribute.md: -------------------------------------------------------------------------------- 1 | # UpdateAttribute 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **str** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional] 7 | **enumeration** | [**list[UpdateAttributeEnumeration]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateAttributeEnumeration.md: -------------------------------------------------------------------------------- 1 | # UpdateAttributeEnumeration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **value** | **int** | Id of the value | 7 | **label** | **str** | Label of the value | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateBatchContacts.md: -------------------------------------------------------------------------------- 1 | # UpdateBatchContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **contacts** | [**list[UpdateBatchContactsContacts]**](UpdateBatchContactsContacts.md) | List of contacts to be updated | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UpdateBatchContactsModel.md: -------------------------------------------------------------------------------- 1 | # UpdateBatchContactsModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **success_ids** | **list[int]** | | [optional] 7 | **failure_ids** | **list[int]** | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateCampaignStatus.md: -------------------------------------------------------------------------------- 1 | # UpdateCampaignStatus 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **status** | **str** | Note:- replicateTemplate status will be available only for template type campaigns. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UpdateChild.md: -------------------------------------------------------------------------------- 1 | # UpdateChild 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **str** | New Email address to update the child account | [optional] 7 | **first_name** | **str** | New First name to use to update the child account | [optional] 8 | **last_name** | **str** | New Last name to use to update the child account | [optional] 9 | **company_name** | **str** | New Company name to use to update the child account | [optional] 10 | **password** | **str** | New password for the child account to login | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UpdateChildAccountStatus.md: -------------------------------------------------------------------------------- 1 | # UpdateChildAccountStatus 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **transactional_email** | **bool** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional] 7 | **transactional_sms** | **bool** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] 8 | **marketing_automation** | **bool** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional] 9 | **sms_campaign** | **bool** | Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UpdateChildDomain.md: -------------------------------------------------------------------------------- 1 | # UpdateChildDomain 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **domain** | **str** | Value for the sender domain that will replace the existing domain | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UpdateEmailCampaignRecipients.md: -------------------------------------------------------------------------------- 1 | # UpdateEmailCampaignRecipients 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **exclusion_list_ids** | **list[int]** | List ids which have to be excluded from a campaign | [optional] 7 | **list_ids** | **list[int]** | 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** | **list[int]** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateEmailCampaignSender.md: -------------------------------------------------------------------------------- 1 | # UpdateEmailCampaignSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Sender Name from which the campaign emails are sent | [optional] 7 | **email** | **str** | Sender email from which the campaign emails are sent | [optional] 8 | **id** | **int** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateExternalFeed.md: -------------------------------------------------------------------------------- 1 | # UpdateExternalFeed 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the feed | [optional] 7 | **url** | **str** | URL of the feed | [optional] 8 | **auth_type** | **str** | Auth type of the feed: * `basic` * `token` * `noAuth` | [optional] 9 | **username** | **str** | Username for authType `basic` | [optional] 10 | **password** | **str** | Password for authType `basic` | [optional] 11 | **token** | **str** | Token for authType `token` | [optional] 12 | **headers** | [**list[GetExternalFeedByUUIDHeaders]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | [optional] 13 | **max_retries** | **int** | Maximum number of retries on the feed url | [optional] 14 | **cache** | **bool** | Toggle caching of feed url response | [optional] [default to False] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/UpdateList.md: -------------------------------------------------------------------------------- 1 | # UpdateList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the list. Either of the two parameters (name, folderId) can be updated at a time. | [optional] 7 | **folder_id** | **int** | Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateSender.md: -------------------------------------------------------------------------------- 1 | # UpdateSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | From Name to update the sender | [optional] 7 | **email** | **str** | From Email to update the sender | [optional] 8 | **ips** | [**list[CreateSenderIps]**](CreateSenderIps.md) | Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateSmtpTemplateSender.md: -------------------------------------------------------------------------------- 1 | # UpdateSmtpTemplateSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | Name of the sender | [optional] 7 | **email** | **str** | Email of the sender | [optional] 8 | **id** | **int** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UpdateWebhook.md: -------------------------------------------------------------------------------- 1 | # UpdateWebhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **str** | URL of the webhook | [optional] 7 | **description** | **str** | Description of the webhook | [optional] 8 | **events** | **list[str]** | - 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** | **str** | Inbound domain of webhook, used in case of event type `inbound` | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UploadImageModel.md: -------------------------------------------------------------------------------- 1 | # UploadImageModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **str** | URL of the image uploaded | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UploadImageToGallery.md: -------------------------------------------------------------------------------- 1 | # UploadImageToGallery 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **image_url** | **str** | 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** | **str** | Name of the image. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/VariablesItems.md: -------------------------------------------------------------------------------- 1 | # VariablesItems 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | | [optional] 7 | **default** | **str** | | [optional] 8 | **datatype** | **str** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/WhatsappCampStats.md: -------------------------------------------------------------------------------- 1 | # WhatsappCampStats 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sent** | **int** | | 7 | **delivered** | **int** | | 8 | **read** | **int** | | 9 | **unsubscribe** | **int** | | 10 | **not_sent** | **int** | | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/WhatsappCampTemplate.md: -------------------------------------------------------------------------------- 1 | # WhatsappCampTemplate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | name of the template | [optional] 7 | **category** | **str** | description of the template | [optional] 8 | **language** | **str** | language of the template | [optional] 9 | **contains_button** | **bool** | | [optional] 10 | **display_header** | **bool** | | [optional] 11 | **header_type** | **str** | type of header | [optional] 12 | **components** | [**list[ComponentItems]**](ComponentItems.md) | array of component item objects | [optional] 13 | **header_variables** | [**list[VariablesItems]**](VariablesItems.md) | array of variables item object | [optional] 14 | **body_variables** | [**list[VariablesItems]**](VariablesItems.md) | array of variables item variables | [optional] 15 | **button_type** | **str** | | [optional] 16 | **hide_footer** | **bool** | | [optional] 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi >= 14.05.14 2 | six >= 1.10 3 | python_dateutil >= 2.5.3 4 | setuptools >= 21.0.0 5 | urllib3 >= 1.15.1 6 | -------------------------------------------------------------------------------- /sib_api_v3_sdk/api/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | 3 | # flake8: noqa 4 | 5 | # import apis into api package 6 | from sib_api_v3_sdk.api.account_api import AccountApi 7 | from sib_api_v3_sdk.api.companies_api import CompaniesApi 8 | from sib_api_v3_sdk.api.contacts_api import ContactsApi 9 | from sib_api_v3_sdk.api.conversations_api import ConversationsApi 10 | from sib_api_v3_sdk.api.deals_api import DealsApi 11 | from sib_api_v3_sdk.api.ecommerce_api import EcommerceApi 12 | from sib_api_v3_sdk.api.email_campaigns_api import EmailCampaignsApi 13 | from sib_api_v3_sdk.api.external_feeds_api import ExternalFeedsApi 14 | from sib_api_v3_sdk.api.files_api import FilesApi 15 | from sib_api_v3_sdk.api.inbound_parsing_api import InboundParsingApi 16 | from sib_api_v3_sdk.api.master_account_api import MasterAccountApi 17 | from sib_api_v3_sdk.api.notes_api import NotesApi 18 | from sib_api_v3_sdk.api.process_api import ProcessApi 19 | from sib_api_v3_sdk.api.reseller_api import ResellerApi 20 | from sib_api_v3_sdk.api.sms_campaigns_api import SMSCampaignsApi 21 | from sib_api_v3_sdk.api.senders_api import SendersApi 22 | from sib_api_v3_sdk.api.tasks_api import TasksApi 23 | from sib_api_v3_sdk.api.transactional_sms_api import TransactionalSMSApi 24 | from sib_api_v3_sdk.api.transactional_whats_app_api import TransactionalWhatsAppApi 25 | from sib_api_v3_sdk.api.transactional_emails_api import TransactionalEmailsApi 26 | from sib_api_v3_sdk.api.webhooks_api import WebhooksApi 27 | from sib_api_v3_sdk.api.whatsapp_campaigns_api import WhatsappCampaignsApi 28 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | coverage>=4.0.3 2 | nose>=1.3.7 3 | pluggy>=0.3.1 4 | py>=1.4.31 5 | randomize>=0.13 6 | -------------------------------------------------------------------------------- /test/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sendinblue/APIv3-python-library/9a5807c149db7855eca346b1d7829a96481f495c/test/__init__.py -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py27, py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | nosetests \ 10 | [] 11 | --------------------------------------------------------------------------------