├── .gitignore ├── .travis.yml ├── CODEOWNERS ├── LICENSE ├── Makefile ├── README.md ├── api └── swagger.yaml ├── 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 ├── CRMApi.md ├── CompaniesApi.md ├── CompaniesList.md ├── Company.md ├── CompanyAttributes.md ├── CompanyAttributesInner.md ├── ContactsApi.md ├── ConversationsApi.md ├── ConversationsMessage.md ├── ConversationsMessageFile.md ├── ConversationsMessageFileImageInfo.md ├── CreateApiKeyRequest.md ├── CreateApiKeyResponse.md ├── CreateAttribute.md ├── CreateAttributeEnumeration.md ├── CreateCategoryModel.md ├── CreateChild.md ├── CreateContact.md ├── CreateDoiContact.md ├── CreateEmailCampaign.md ├── CreateEmailCampaignRecipients.md ├── CreateEmailCampaignSender.md ├── CreateList.md ├── CreateModel.md ├── CreateProductModel.md ├── CreateReseller.md ├── CreateSender.md ├── CreateSenderIps.md ├── CreateSenderModel.md ├── CreateSmsCampaign.md ├── CreateSmsCampaignRecipients.md ├── CreateSmtpEmail.md ├── CreateSmtpTemplate.md ├── CreateSmtpTemplateSender.md ├── CreateSubAccount.md ├── CreateSubAccountResponse.md ├── CreateUpdateBatchCategory.md ├── CreateUpdateBatchCategoryModel.md ├── CreateUpdateBatchProducts.md ├── CreateUpdateBatchProductsModel.md ├── CreateUpdateCategories.md ├── CreateUpdateCategory.md ├── CreateUpdateContactModel.md ├── CreateUpdateFolder.md ├── CreateUpdateProduct.md ├── CreateUpdateProducts.md ├── CreateWebhook.md ├── CreatedBatchId.md ├── CreatedProcessId.md ├── Deal.md ├── DealAttributes.md ├── DealAttributesInner.md ├── DealsApi.md ├── DealsList.md ├── DeleteHardbounces.md ├── EcommerceApi.md ├── EmailCampaignsApi.md ├── EmailExportRecipients.md ├── ErrorModel.md ├── FileData.md ├── FileDownloadableLink.md ├── FileList.md ├── FilesApi.md ├── FoldersApi.md ├── GetAccount.md ├── GetAccountMarketingAutomation.md ├── GetAccountPlan.md ├── GetAccountRelay.md ├── GetAccountRelayData.md ├── GetAggregatedReport.md ├── GetAttributes.md ├── GetAttributesAttributes.md ├── GetAttributesEnumeration.md ├── GetBlockedDomains.md ├── GetCampaignOverview.md ├── GetCampaignRecipients.md ├── GetCampaignStats.md ├── GetCategories.md ├── GetCategoryDetails.md ├── GetChildAccountCreationStatus.md ├── GetChildDomain.md ├── GetChildDomains.md ├── GetChildInfo.md ├── GetChildInfoApiKeys.md ├── GetChildInfoApiKeysV2.md ├── GetChildInfoApiKeysV3.md ├── GetChildInfoCredits.md ├── GetChildInfoStatistics.md ├── GetChildrenList.md ├── GetClient.md ├── GetContactCampaignStats.md ├── GetContactCampaignStatsClicked.md ├── GetContactCampaignStatsOpened.md ├── GetContactCampaignStatsTransacAttributes.md ├── GetContactCampaignStatsUnsubscriptions.md ├── GetContactDetails.md ├── GetContacts.md ├── GetDeviceBrowserStats.md ├── GetEmailCampaign.md ├── GetEmailCampaigns.md ├── GetEmailEventReport.md ├── GetEmailEventReportEvents.md ├── GetExtendedCampaignOverview.md ├── GetExtendedCampaignOverviewSender.md ├── GetExtendedCampaignStats.md ├── GetExtendedClient.md ├── GetExtendedClientAddress.md ├── GetExtendedContactDetails.md ├── GetExtendedContactDetailsStatistics.md ├── GetExtendedContactDetailsStatisticsClicked.md ├── GetExtendedContactDetailsStatisticsDelivered.md ├── GetExtendedContactDetailsStatisticsLinks.md ├── GetExtendedContactDetailsStatisticsMessagesSent.md ├── GetExtendedContactDetailsStatisticsOpened.md ├── GetExtendedContactDetailsStatisticsUnsubscriptions.md ├── GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md ├── GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md ├── GetExtendedList.md ├── GetExtendedListCampaignStats.md ├── GetFolder.md ├── GetFolderLists.md ├── GetFolders.md ├── GetInboundEmailEvents.md ├── GetInboundEmailEventsByUuid.md ├── GetInboundEmailEventsByUuidAttachments.md ├── GetInboundEmailEventsByUuidLogs.md ├── GetInboundEmailEventsEvents.md ├── GetIp.md ├── GetIpFromSender.md ├── GetIps.md ├── GetIpsFromSender.md ├── GetList.md ├── GetLists.md ├── GetProcess.md ├── GetProcesses.md ├── GetProductDetails.md ├── GetProducts.md ├── GetReports.md ├── GetReportsReports.md ├── GetScheduledEmailByBatchId.md ├── GetScheduledEmailByBatchIdBatches.md ├── GetScheduledEmailByMessageId.md ├── GetSendersList.md ├── GetSendersListIps.md ├── GetSendersListSenders.md ├── GetSharedTemplateUrl.md ├── GetSmsCampaign.md ├── GetSmsCampaignOverview.md ├── GetSmsCampaignStats.md ├── GetSmsCampaigns.md ├── GetSmsEventReport.md ├── GetSmsEventReportEvents.md ├── GetSmtpTemplateOverview.md ├── GetSmtpTemplateOverviewSender.md ├── GetSmtpTemplates.md ├── GetSsoToken.md ├── GetStatsByBrowser.md ├── GetStatsByDevice.md ├── GetStatsByDomain.md ├── GetTransacAggregatedSmsReport.md ├── GetTransacBlockedContacts.md ├── GetTransacBlockedContactsContacts.md ├── GetTransacBlockedContactsReason.md ├── GetTransacEmailContent.md ├── GetTransacEmailContentEvents.md ├── GetTransacEmailsList.md ├── GetTransacEmailsListTransactionalEmails.md ├── GetTransacSmsReport.md ├── GetTransacSmsReportReports.md ├── GetWebhook.md ├── GetWebhooks.md ├── InboundParsingApi.md ├── InlineResponse200.md ├── InlineResponse201.md ├── InlineResponse2011.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 ├── SendReport.md ├── SendReportEmail.md ├── SendSms.md ├── SendSmtpEmail.md ├── SendSmtpEmailAttachment.md ├── SendSmtpEmailBcc.md ├── SendSmtpEmailCc.md ├── SendSmtpEmailMessageVersions.md ├── SendSmtpEmailReplyTo.md ├── SendSmtpEmailReplyTo1.md ├── SendSmtpEmailSender.md ├── SendSmtpEmailTo.md ├── SendSmtpEmailTo1.md ├── SendTestEmail.md ├── SendTestSms.md ├── SendTransacSms.md ├── SendersApi.md ├── SsoTokenRequest.md ├── SubAccountDetailsResponse.md ├── SubAccountDetailsResponsePlanInfo.md ├── SubAccountDetailsResponsePlanInfoCredits.md ├── SubAccountDetailsResponsePlanInfoCreditsEmails.md ├── SubAccountDetailsResponsePlanInfoFeatures.md ├── SubAccountDetailsResponsePlanInfoFeaturesInbox.md ├── SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md ├── SubAccountDetailsResponsePlanInfoFeaturesUsers.md ├── SubAccountUpdatePlanRequest.md ├── SubAccountUpdatePlanRequestCredits.md ├── SubAccountUpdatePlanRequestFeatures.md ├── SubAccountsResponse.md ├── SubAccountsResponseSubAccounts.md ├── Task.md ├── TaskList.md ├── TaskReminder.md ├── TaskTypes.md ├── TasksApi.md ├── TransactionalEmailsApi.md ├── TransactionalSMSApi.md ├── UpdateAttribute.md ├── UpdateAttributeEnumeration.md ├── UpdateBatchContacts.md ├── UpdateBatchContactsContacts.md ├── UpdateBatchContactsModel.md ├── UpdateCampaignStatus.md ├── UpdateChild.md ├── UpdateChildAccountStatus.md ├── UpdateChildDomain.md ├── UpdateContact.md ├── UpdateEmailCampaign.md ├── UpdateEmailCampaignRecipients.md ├── UpdateEmailCampaignSender.md ├── UpdateList.md ├── UpdateSender.md ├── UpdateSmsCampaign.md ├── UpdateSmtpTemplate.md ├── UpdateSmtpTemplateSender.md ├── UpdateWebhook.md ├── UploadImageModel.md ├── UploadImageToGallery.md └── WebhooksApi.md ├── go.mod ├── go.sum └── lib ├── api_account.go ├── api_companies.go ├── api_contacts.go ├── api_conversations.go ├── api_deals.go ├── api_ecommerce.go ├── api_email_campaigns.go ├── api_files.go ├── api_inbound_parsing.go ├── api_master_account.go ├── api_notes.go ├── api_process.go ├── api_reseller.go ├── api_senders.go ├── api_sms_campaigns.go ├── api_tasks.go ├── api_transactional_emails.go ├── api_transactional_sms.go ├── api_webhooks.go ├── client.go ├── configuration.go ├── model_ab_test_campaign_result.go ├── model_ab_test_campaign_result_clicked_links.go ├── model_ab_test_campaign_result_statistics.go ├── model_ab_test_version_clicks.go ├── model_ab_test_version_clicks_inner.go ├── model_ab_test_version_stats.go ├── model_add_child_domain.go ├── model_add_contact_to_list.go ├── model_add_credits.go ├── model_block_domain.go ├── model_body.go ├── model_body_1.go ├── model_body_10.go ├── model_body_11.go ├── model_body_12.go ├── model_body_2.go ├── model_body_3.go ├── model_body_4.go ├── model_body_5.go ├── model_body_6.go ├── model_body_7.go ├── model_body_8.go ├── model_body_9.go ├── model_companies_list.go ├── model_company.go ├── model_company_attributes.go ├── model_company_attributes_inner.go ├── model_conversations_message.go ├── model_conversations_message_file.go ├── model_conversations_message_file_image_info.go ├── model_create_api_key_request.go ├── model_create_api_key_response.go ├── model_create_attribute.go ├── model_create_attribute_enumeration.go ├── model_create_category_model.go ├── model_create_child.go ├── model_create_contact.go ├── model_create_doi_contact.go ├── model_create_email_campaign.go ├── model_create_email_campaign_recipients.go ├── model_create_email_campaign_sender.go ├── model_create_list.go ├── model_create_model.go ├── model_create_product_model.go ├── model_create_reseller.go ├── model_create_sender.go ├── model_create_sender_ips.go ├── model_create_sender_model.go ├── model_create_sms_campaign.go ├── model_create_sms_campaign_recipients.go ├── model_create_smtp_email.go ├── model_create_smtp_template.go ├── model_create_smtp_template_sender.go ├── model_create_sub_account.go ├── model_create_sub_account_response.go ├── model_create_update_batch_category.go ├── model_create_update_batch_category_model.go ├── model_create_update_batch_products.go ├── model_create_update_batch_products_model.go ├── model_create_update_categories.go ├── model_create_update_category.go ├── model_create_update_contact_model.go ├── model_create_update_folder.go ├── model_create_update_product.go ├── model_create_update_products.go ├── model_create_webhook.go ├── model_created_batch_id.go ├── model_created_process_id.go ├── model_deal.go ├── model_deal_attributes.go ├── model_deal_attributes_inner.go ├── model_deals_list.go ├── model_delete_hardbounces.go ├── model_email_export_recipients.go ├── model_error_model.go ├── model_file_data.go ├── model_file_downloadable_link.go ├── model_file_list.go ├── model_get_account.go ├── model_get_account_marketing_automation.go ├── model_get_account_plan.go ├── model_get_account_relay.go ├── model_get_account_relay_data.go ├── model_get_aggregated_report.go ├── model_get_attributes.go ├── model_get_attributes_attributes.go ├── model_get_attributes_enumeration.go ├── model_get_blocked_domains.go ├── model_get_campaign_overview.go ├── model_get_campaign_recipients.go ├── model_get_campaign_stats.go ├── model_get_categories.go ├── model_get_category_details.go ├── model_get_child_account_creation_status.go ├── model_get_child_domain.go ├── model_get_child_domains.go ├── model_get_child_info.go ├── model_get_child_info_api_keys.go ├── model_get_child_info_api_keys_v2.go ├── model_get_child_info_api_keys_v3.go ├── model_get_child_info_credits.go ├── model_get_child_info_statistics.go ├── model_get_children_list.go ├── model_get_client.go ├── model_get_contact_campaign_stats.go ├── model_get_contact_campaign_stats_clicked.go ├── model_get_contact_campaign_stats_opened.go ├── model_get_contact_campaign_stats_transac_attributes.go ├── model_get_contact_campaign_stats_unsubscriptions.go ├── model_get_contact_details.go ├── model_get_contacts.go ├── model_get_device_browser_stats.go ├── model_get_email_campaign.go ├── model_get_email_campaigns.go ├── model_get_email_event_report.go ├── model_get_email_event_report_events.go ├── model_get_extended_campaign_overview.go ├── model_get_extended_campaign_overview_sender.go ├── model_get_extended_campaign_stats.go ├── model_get_extended_client.go ├── model_get_extended_client_address.go ├── model_get_extended_contact_details.go ├── model_get_extended_contact_details_statistics.go ├── model_get_extended_contact_details_statistics_clicked.go ├── model_get_extended_contact_details_statistics_delivered.go ├── model_get_extended_contact_details_statistics_links.go ├── model_get_extended_contact_details_statistics_messages_sent.go ├── model_get_extended_contact_details_statistics_opened.go ├── model_get_extended_contact_details_statistics_unsubscriptions.go ├── model_get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.go ├── model_get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.go ├── model_get_extended_list.go ├── model_get_extended_list_campaign_stats.go ├── model_get_folder.go ├── model_get_folder_lists.go ├── model_get_folders.go ├── model_get_inbound_email_events.go ├── model_get_inbound_email_events_by_uuid.go ├── model_get_inbound_email_events_by_uuid_attachments.go ├── model_get_inbound_email_events_by_uuid_logs.go ├── model_get_inbound_email_events_events.go ├── model_get_ip.go ├── model_get_ip_from_sender.go ├── model_get_ips.go ├── model_get_ips_from_sender.go ├── model_get_list.go ├── model_get_lists.go ├── model_get_process.go ├── model_get_processes.go ├── model_get_product_details.go ├── model_get_products.go ├── model_get_reports.go ├── model_get_reports_reports.go ├── model_get_scheduled_email_by_batch_id.go ├── model_get_scheduled_email_by_batch_id_batches.go ├── model_get_scheduled_email_by_message_id.go ├── model_get_senders_list.go ├── model_get_senders_list_ips.go ├── model_get_senders_list_senders.go ├── model_get_shared_template_url.go ├── model_get_sms_campaign.go ├── model_get_sms_campaign_overview.go ├── model_get_sms_campaign_stats.go ├── model_get_sms_campaigns.go ├── model_get_sms_event_report.go ├── model_get_sms_event_report_events.go ├── model_get_smtp_template_overview.go ├── model_get_smtp_template_overview_sender.go ├── model_get_smtp_templates.go ├── model_get_sso_token.go ├── model_get_stats_by_browser.go ├── model_get_stats_by_device.go ├── model_get_stats_by_domain.go ├── model_get_transac_aggregated_sms_report.go ├── model_get_transac_blocked_contacts.go ├── model_get_transac_blocked_contacts_contacts.go ├── model_get_transac_blocked_contacts_reason.go ├── model_get_transac_email_content.go ├── model_get_transac_email_content_events.go ├── model_get_transac_emails_list.go ├── model_get_transac_emails_list_transactional_emails.go ├── model_get_transac_sms_report.go ├── model_get_transac_sms_report_reports.go ├── model_get_webhook.go ├── model_get_webhooks.go ├── model_inline_response_200.go ├── model_inline_response_201.go ├── model_inline_response_201_1.go ├── model_manage_ip.go ├── model_master_details_response.go ├── model_master_details_response_billing_info.go ├── model_master_details_response_billing_info_address.go ├── model_master_details_response_billing_info_name.go ├── model_master_details_response_plan_info.go ├── model_master_details_response_plan_info_features.go ├── model_note.go ├── model_note_data.go ├── model_note_id.go ├── model_note_list.go ├── model_order.go ├── model_order_batch.go ├── model_order_billing.go ├── model_order_products.go ├── model_pipeline.go ├── model_pipeline_stage.go ├── model_post_contact_info.go ├── model_post_contact_info_contacts.go ├── model_post_send_failed.go ├── model_post_send_sms_test_failed.go ├── model_remaining_credit_model.go ├── model_remaining_credit_model_child.go ├── model_remaining_credit_model_reseller.go ├── model_remove_contact_from_list.go ├── model_remove_credits.go ├── model_request_contact_export.go ├── model_request_contact_export_custom_contact_filter.go ├── model_request_contact_import.go ├── model_request_contact_import_new_list.go ├── model_request_sms_recipient_export.go ├── model_schedule_smtp_email.go ├── model_send_report.go ├── model_send_report_email.go ├── model_send_sms.go ├── model_send_smtp_email.go ├── model_send_smtp_email_attachment.go ├── model_send_smtp_email_bcc.go ├── model_send_smtp_email_cc.go ├── model_send_smtp_email_message_versions.go ├── model_send_smtp_email_reply_to.go ├── model_send_smtp_email_reply_to_1.go ├── model_send_smtp_email_sender.go ├── model_send_smtp_email_to.go ├── model_send_smtp_email_to_1.go ├── model_send_test_email.go ├── model_send_test_sms.go ├── model_send_transac_sms.go ├── model_sso_token_request.go ├── model_sub_account_details_response.go ├── model_sub_account_details_response_plan_info.go ├── model_sub_account_details_response_plan_info_credits.go ├── model_sub_account_details_response_plan_info_credits_emails.go ├── model_sub_account_details_response_plan_info_features.go ├── model_sub_account_details_response_plan_info_features_inbox.go ├── model_sub_account_details_response_plan_info_features_landing_page.go ├── model_sub_account_details_response_plan_info_features_users.go ├── model_sub_account_update_plan_request.go ├── model_sub_account_update_plan_request_credits.go ├── model_sub_account_update_plan_request_features.go ├── model_sub_accounts_response.go ├── model_sub_accounts_response_sub_accounts.go ├── model_task.go ├── model_task_list.go ├── model_task_reminder.go ├── model_task_types.go ├── model_update_attribute.go ├── model_update_attribute_enumeration.go ├── model_update_batch_contacts.go ├── model_update_batch_contacts_contacts.go ├── model_update_batch_contacts_model.go ├── model_update_campaign_status.go ├── model_update_child.go ├── model_update_child_account_status.go ├── model_update_child_domain.go ├── model_update_contact.go ├── model_update_email_campaign.go ├── model_update_email_campaign_recipients.go ├── model_update_email_campaign_sender.go ├── model_update_list.go ├── model_update_sender.go ├── model_update_sms_campaign.go ├── model_update_smtp_template.go ├── model_update_smtp_template_sender.go ├── model_update_webhook.go ├── model_upload_image_model.go ├── model_upload_image_to_gallery.go └── response.go /.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | /vendor 3 | /Gopkg.lock 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | 3 | install: 4 | - go get -d -v . 5 | 6 | script: 7 | - go build -v ./ 8 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @ekta-slit 2 | * @jain-raunak -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 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 all 13 | 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 THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | SWAGGER_DEFINITION_URL=https://api.sendinblue.com/v3/swagger_definition.yml 2 | GO_SWAGGER_PACKAGE=github.com/go-swagger/go-swagger/cmd/swagger 3 | 4 | generate: \ 5 | build/swagger_definition.yml \ 6 | install-go-swagger 7 | rm -rf client models 8 | swagger generate client -f build/swagger_definition.yml --additional-initialism=SMS 9 | 10 | build/swagger_definition.yml: Makefile 11 | mkdir -p build 12 | curl -o $@ $(SWAGGER_DEFINITION_URL) 13 | 14 | install-go-swagger: 15 | go get -v -u $(GO_SWAGGER_PACKAGE) 16 | 17 | install-dependencies: 18 | go get -v -u github.com/golang/dep/cmd/dep 19 | dep ensure -v 20 | dep prune -v 21 | 22 | clean: 23 | go clean -i ./... ./vendor/... 24 | rm -rf build vendor 25 | 26 | .PHONY: generate install-go-swagger install-dependencies test clean -------------------------------------------------------------------------------- /docs/AbTestCampaignResultClickedLinks.md: -------------------------------------------------------------------------------- 1 | # AbTestCampaignResultClickedLinks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **VersionA** | [***AbTestVersionClicks**](ABTestVersionClicks.md) | | [default to null] 7 | **VersionB** | [***AbTestVersionClicks**](ABTestVersionClicks.md) | | [default to null] 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) | | [default to null] 7 | **Clicks** | [***AbTestVersionStats**](AbTestVersionStats.md) | | [default to null] 8 | **Unsubscribed** | [***AbTestVersionStats**](AbTestVersionStats.md) | | [default to null] 9 | **HardBounces** | [***AbTestVersionStats**](AbTestVersionStats.md) | | [default to null] 10 | **SoftBounces** | [***AbTestVersionStats**](AbTestVersionStats.md) | | [default to null] 11 | **Complaints** | [***AbTestVersionStats**](AbTestVersionStats.md) | | [default to null] 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** | **string** | URL of the link | [default to null] 7 | **ClicksCount** | **float32** | Number of times a link is clicked | [default to null] 8 | **ClickRate** | **string** | Percentage of clicks of link with respect to total clicks | [default to null] 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 | **VersionA** | **string** | percentage of an event for version A | [default to null] 7 | **VersionB** | **string** | percentage of an event for version B | [default to null] 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/AccountApi.md: -------------------------------------------------------------------------------- 1 | # \AccountApi 2 | 3 | All URIs are relative to *https://api.sendinblue.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**GetAccount**](AccountApi.md#GetAccount) | **Get** /account | Get your account information, plan and credits details 8 | 9 | 10 | # **GetAccount** 11 | > GetAccount GetAccount(ctx, ) 12 | Get your account information, plan and credits details 13 | 14 | ### Required Parameters 15 | This endpoint does not need any parameter. 16 | 17 | ### Return type 18 | 19 | [**GetAccount**](GetAccount.md) 20 | 21 | ### Authorization 22 | 23 | [api-key](../README.md#api-key), [partner-key](../README.md#partner-key) 24 | 25 | ### HTTP request headers 26 | 27 | - **Content-Type**: application/json 28 | - **Accept**: application/json 29 | 30 | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 31 | 32 | -------------------------------------------------------------------------------- /docs/AddChildDomain.md: -------------------------------------------------------------------------------- 1 | # AddChildDomain 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Domain** | **string** | Sender domain to add for a specific child account | [optional] [default to null] 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** | **[]string** | Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] [default to null] 7 | **Ids** | **[]int64** | 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] [default to null] 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** | **int64** | Required if email credits are empty. SMS credits to be added to the child account | [optional] [default to null] 7 | **Email** | **int64** | Required if sms credits are empty. Email credits to be added to the child account | [optional] [default to null] 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** | **string** | name of the domain to be blocked | [default to null] 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** | **string** | Name of company | [default to null] 7 | **Attributes** | [***interface{}**](interface{}.md) | Attributes for company creation | [optional] [default to null] 8 | **CountryCode** | **int64** | Country code if phone_number is passed in attributes. | [optional] [default to null] 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** | **string** | Name of company | [optional] [default to null] 7 | **Attributes** | [***interface{}**](interface{}.md) | Attributes for company update | [optional] [default to null] 8 | **CountryCode** | **int64** | Country code if phone_number is passed in attributes. | [optional] [default to null] 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 | **VisitorId** | **string** | visitor’s ID received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> | [default to null] 7 | **Text** | **string** | message text | [default to null] 8 | **AgentId** | **string** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set. | [optional] [default to null] 9 | **GroupId** | **string** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional] [default to null] 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** | **string** | edited message text | [default to null] 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/Body2.md: -------------------------------------------------------------------------------- 1 | # Body2 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **LinkContactIds** | **[]int64** | Contact ids for contacts to be linked with company | [optional] [default to null] 7 | **UnlinkContactIds** | **[]int64** | Contact ids for contacts to be unlinked from company | [optional] [default to null] 8 | **LinkDealsIds** | **[]string** | Deals ids for deals to be linked with company | [optional] [default to null] 9 | **UnlinkDealsIds** | **[]string** | Deals ids for deals to be unlinked from company | [optional] [default to null] 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** | **string** | Name of deal | [default to null] 7 | **Attributes** | [***interface{}**](interface{}.md) | Attributes fo\\r deal creation | [optional] [default to null] 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** | **string** | Name of deal | [optional] [default to null] 7 | **Attributes** | [***interface{}**](interface{}.md) | Attributes for deal update | [optional] [default to null] 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 | **LinkContactIds** | **[]int64** | Contact ids for contacts to be linked with deal | [optional] [default to null] 7 | **UnlinkContactIds** | **[]int64** | Contact ids for contacts to be unlinked from deal | [optional] [default to null] 8 | **LinkCompanyIds** | **[]string** | Company ids to be linked with deal | [optional] [default to null] 9 | **UnlinkCompanyIds** | **[]string** | Company ids to be unlinked from deal | [optional] [default to null] 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/Body9.md: -------------------------------------------------------------------------------- 1 | # Body9 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Text** | **string** | edited message text | [default to null] 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/CompaniesList.md: -------------------------------------------------------------------------------- 1 | # CompaniesList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Items** | [**[]Company**](Company.md) | List of compaies | [optional] [default to null] 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** | **string** | Unique company id | [optional] [default to null] 7 | **Attributes** | [***interface{}**](interface{}.md) | Company attributes with values | [optional] [default to null] 8 | **LinkedContactsIds** | **[]int32** | Contact ids for contacts linked to this company | [optional] [default to null] 9 | **LinkedDealsIds** | **[]string** | Deals ids for companies linked to this company | [optional] [default to null] 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 | **InternalName** | **string** | | [optional] [default to null] 7 | **Label** | **string** | | [optional] [default to null] 8 | **AttributeTypeName** | **string** | | [optional] [default to null] 9 | **AttributeOptions** | [**[]interface{}**](interface{}.md) | | [optional] [default to null] 10 | **IsRequired** | **bool** | | [optional] [default to null] 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/ConversationsMessageFile.md: -------------------------------------------------------------------------------- 1 | # ConversationsMessageFile 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Filename** | **string** | Name of the file | [optional] [default to null] 7 | **Size** | **int64** | Size in bytes | [optional] [default to null] 8 | **IsImage** | **bool** | Whether the file is an image | [optional] [default to null] 9 | **Url** | **string** | URL of the file | [optional] [default to null] 10 | **ImageInfo** | [***ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) | | [optional] [default to null] 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** | **int64** | Width of the image | [optional] [default to null] 7 | **Height** | **int64** | height of the image | [optional] [default to null] 8 | **PreviewUrl** | **string** | URL of the preview | [optional] [default to null] 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** | **int64** | Id of the sub-account organization | [default to null] 7 | **Name** | **string** | Name of the API key | [optional] [default to null] 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** | **string** | Status of the API operation. | [optional] [default to null] 7 | **Key** | **string** | API Key | [optional] [default to null] 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/CreateAttributeEnumeration.md: -------------------------------------------------------------------------------- 1 | # CreateAttributeEnumeration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Value** | **int32** | Id of the value | [default to null] 7 | **Label** | **string** | Label of the value | [default to null] 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** | **int64** | ID of the category when a new category is created | [optional] [default to null] 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** | **string** | Email address to create the child account | [default to null] 7 | **FirstName** | **string** | First name to use to create the child account | [default to null] 8 | **LastName** | **string** | Last name to use to create the child account | [default to null] 9 | **CompanyName** | **string** | Company name to use to create the child account | [default to null] 10 | **Password** | **string** | Password for the child account to login | [default to null] 11 | **Language** | **string** | Language of the child account | [optional] [default to null] 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 | **ExclusionListIds** | **[]int64** | List ids to exclude from the campaign | [optional] [default to null] 7 | **ListIds** | **[]int64** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional] [default to null] 8 | **SegmentIds** | **[]int64** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional] [default to null] 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** | **string** | Sender Name | [optional] [default to null] 7 | **Email** | **string** | Sender email | [default to null] 8 | **Id** | **int64** | 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] [default to null] 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/CreateList.md: -------------------------------------------------------------------------------- 1 | # CreateList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Name** | **string** | Name of the list | [default to null] 7 | **FolderId** | **int64** | Id of the parent folder in which this list is to be created | [default to null] 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** | **int64** | ID of the object created | [default to null] 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** | **int64** | ID of the Product when a new product is created | [optional] [default to null] 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 | **AuthKey** | **string** | AuthKey of Reseller child created | [default to null] 7 | **Id** | **int64** | Id of Reseller child created | [optional] [default to null] 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** | **string** | From Name to use for the sender | [default to null] 7 | **Email** | **string** | From email to use for the sender. A verification email will be sent to this address. | [default to null] 8 | **Ips** | [**[]CreateSenderIps**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional] [default to null] 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** | **string** | Dedicated IP available in your account | [default to null] 7 | **Domain** | **string** | Domain of the IP | [default to null] 8 | **Weight** | **int64** | 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] [default to null] 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** | **int64** | ID of the Sender created | [default to null] 7 | **SpfError** | **bool** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional] [default to null] 8 | **DkimError** | **bool** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional] [default to null] 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 | **ListIds** | **[]int64** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty | [default to null] 7 | **ExclusionListIds** | **[]int64** | List ids which have to be excluded from a campaign | [optional] [default to null] 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 | **MessageId** | **string** | Message ID of the transactional email sent | [optional] [default to null] 7 | **MessageIds** | **[]string** | | [optional] [default to null] 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** | **string** | Name of the sender. If not passed, will be set to default | [optional] [default to null] 7 | **Email** | **string** | Email of the sender | [optional] [default to null] 8 | **Id** | **int64** | 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] [default to null] 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 | **CompanyName** | **string** | Set the name of the sub-account company | [default to null] 7 | **Email** | **string** | Email address for the organization | [default to null] 8 | **Language** | **string** | Set the language of the sub-account | [optional] [default to null] 9 | **Timezone** | **string** | Set the timezone of the sub-account | [optional] [default to null] 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** | **int64** | ID of the sub-account created | [default to null] 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** | [**[]CreateUpdateCategories**](CreateUpdateCategories.md) | array of categories objects | [default to null] 7 | **UpdateEnabled** | **bool** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] [default to null] 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 | **CreatedCount** | **int64** | Number of the new created categories | [optional] [default to null] 7 | **UpdatedCount** | **int64** | Number of the existing categories updated | [optional] [default to null] 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** | [**[]CreateUpdateProducts**](CreateUpdateProducts.md) | array of products objects | [default to null] 7 | **UpdateEnabled** | **bool** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] [default to null] 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 | **CreatedCount** | **int64** | Number of the new created products | [optional] [default to null] 7 | **UpdatedCount** | **int64** | Number of the existing products updated | [optional] [default to null] 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** | **string** | Unique Category ID as saved in the shop | [default to null] 7 | **Name** | **string** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] [default to null] 8 | **Url** | **string** | URL to the category | [optional] [default to null] 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/CreateUpdateCategory.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateCategory 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Id** | **string** | Unique Category ID as saved in the shop | [default to null] 7 | **Name** | **string** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] [default to null] 8 | **Url** | **string** | URL to the category | [optional] [default to null] 9 | **UpdateEnabled** | **bool** | Facilitate to update the existing category in the same request (updateEnabled = true) | [optional] [default to null] 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/CreateUpdateContactModel.md: -------------------------------------------------------------------------------- 1 | # CreateUpdateContactModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Id** | **int64** | ID of the contact when a new contact is created | [optional] [default to null] 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** | **string** | Name of the folder | [optional] [default to null] 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/CreatedBatchId.md: -------------------------------------------------------------------------------- 1 | # CreatedBatchId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **BatchId** | **float32** | Batch ID of the request | [default to null] 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 | **ProcessId** | **int64** | Id of the process created | [default to null] 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** | **string** | Unique deal id | [optional] [default to null] 7 | **Attributes** | [***interface{}**](interface{}.md) | Deal attributes with values | [optional] [default to null] 8 | **LinkedContactsIds** | **[]int32** | Contact ids for contacts linked to this deal | [optional] [default to null] 9 | **LinkedCompaniesIds** | **[]string** | Companies ids for companies linked to this deal | [optional] [default to null] 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 | **InternalName** | **string** | | [optional] [default to null] 7 | **Label** | **string** | | [optional] [default to null] 8 | **AttributeTypeName** | **string** | | [optional] [default to null] 9 | **AttributeOptions** | [**[]interface{}**](interface{}.md) | | [optional] [default to null] 10 | **IsRequired** | **bool** | | [optional] [default to null] 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** | [**[]Deal**](Deal.md) | List of deals | [optional] [default to null] 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 | **StartDate** | **string** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional] [default to null] 7 | **EndDate** | **string** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional] [default to null] 8 | **ContactEmail** | **string** | Target a specific email address | [optional] [default to null] 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 | **NotifyURL** | **string** | Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] [default to null] 7 | **RecipientsType** | **string** | Type of recipients to export for a campaign | [default to null] 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** | **string** | Error code displayed in case of a failure | [default to null] 7 | **Message** | **string** | Readable message associated to the failure | [default to null] 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** | **string** | Name of uploaded file | [optional] [default to null] 7 | **AuthorId** | **string** | Account id of user which created the file | [optional] [default to null] 8 | **ContactId** | **int64** | Contact id of contact on which file is uploaded | [optional] [default to null] 9 | **DealId** | **string** | Deal id linked to a file | [optional] [default to null] 10 | **CompanyId** | **string** | Company id linked to a file | [optional] [default to null] 11 | **Size** | **int64** | Size of file in bytes | [optional] [default to null] 12 | **CreatedAt** | [**time.Time**](time.Time.md) | File created date/time | [optional] [default to null] 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 | **FileUrl** | **string** | A unique link to download the requested file. | [default to null] 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** | **string** | Login Email | [default to null] 7 | **FirstName** | **string** | First Name | [default to null] 8 | **LastName** | **string** | Last Name | [default to null] 9 | **CompanyName** | **string** | Name of the company | [default to null] 10 | **Address** | [***GetExtendedClientAddress**](GetExtendedClientAddress.md) | | [default to null] 11 | **Plan** | [**[]GetAccountPlan**](GetAccountPlan.md) | Information about your plans and credits | [default to null] 12 | **Relay** | [***GetAccountRelay**](GetAccountRelay.md) | | [default to null] 13 | **MarketingAutomation** | [***GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) | | [optional] [default to null] 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** | **string** | Marketing Automation Tracker ID | [optional] [default to null] 7 | **Enabled** | **bool** | Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) | [default to null] 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/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) | [default to null] 7 | **Data** | [***GetAccountRelayData**](GetAccountRelayData.md) | | [default to null] 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 | **UserName** | **string** | Email to use as login on transactional platform | [default to null] 7 | **Relay** | **string** | URL of the SMTP Relay | [default to null] 8 | **Port** | **int32** | Port used for SMTP Relay | [default to null] 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/GetAttributes.md: -------------------------------------------------------------------------------- 1 | # GetAttributes 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Attributes** | [**[]GetAttributesAttributes**](GetAttributesAttributes.md) | Listing of available contact attributes in your account | [default to null] 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** | **string** | Name of the attribute | [default to null] 7 | **Category** | **string** | Category of the attribute | [default to null] 8 | **Type_** | **string** | Type of the attribute | [optional] [default to null] 9 | **Enumeration** | [**[]GetAttributesEnumeration**](GetAttributesEnumeration.md) | Parameter only available for \"category\" type attributes. | [optional] [default to null] 10 | **CalculatedValue** | **string** | Calculated value formula | [optional] [default to null] 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** | **int64** | ID of Value of the \"category\" type attribute | [default to null] 7 | **Label** | **string** | Label of the \"category\" type attribute | [default to null] 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** | **[]string** | List of all blocked domains | [default to null] 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** | **[]int64** | | [default to null] 7 | **ExclusionLists** | **[]int64** | | [default to null] 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** | [**[]interface{}**](interface{}.md) | | [default to null] 7 | **Count** | **int64** | Number of categories | [default to null] 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** | **string** | Category ID for which you requested the details | [default to null] 7 | **Name** | **string** | Name of the category for which you requested the details | [default to null] 8 | **CreatedAt** | **string** | Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) | [default to null] 9 | **ModifiedAt** | **string** | Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) | [default to null] 10 | **Url** | **string** | URL to the category | [optional] [default to null] 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/GetChildAccountCreationStatus.md: -------------------------------------------------------------------------------- 1 | # GetChildAccountCreationStatus 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ChildAccountCreated** | **bool** | Status of child account creation whether it is successfully created (exists) or not. | [default to null] 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** | **string** | Sender domain | [optional] [default to null] 7 | **Active** | **bool** | indicates whether a domain is verified or not | [optional] [default to null] 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** | **string** | Login Email | [default to null] 7 | **FirstName** | **string** | First Name | [default to null] 8 | **LastName** | **string** | Last Name | [default to null] 9 | **CompanyName** | **string** | Name of the company | [default to null] 10 | **Credits** | [***GetChildInfoCredits**](GetChildInfoCredits.md) | | [optional] [default to null] 11 | **Statistics** | [***GetChildInfoStatistics**](GetChildInfoStatistics.md) | | [optional] [default to null] 12 | **Password** | **string** | The encrypted password of child account | [default to null] 13 | **Ips** | **[]string** | IP(s) associated to a child account user | [optional] [default to null] 14 | **ApiKeys** | [***GetChildInfoApiKeys**](GetChildInfoApiKeys.md) | | [optional] [default to null] 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** | [**[]GetChildInfoApiKeysV2**](GetChildInfoApiKeysV2.md) | | [default to null] 7 | **V3** | [**[]GetChildInfoApiKeysV3**](GetChildInfoApiKeysV3.md) | | [optional] [default to null] 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** | **string** | Name of the key for version 2 | [default to null] 7 | **Key** | **string** | API Key for version 2 | [default to null] 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** | **string** | Name of the key for version 3 | [default to null] 7 | **Key** | **string** | API Key for version 3 | [default to null] 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 | **EmailCredits** | **int64** | Email credits available for your child | [optional] [default to null] 7 | **SmsCredits** | **int64** | SMS credits available for your child | [optional] [default to null] 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 | **PreviousMonthTotalSent** | **int64** | Overall emails sent for the previous month | [optional] [default to null] 7 | **CurrentMonthTotalSent** | **int64** | Overall emails sent for current month | [optional] [default to null] 8 | **TotalSent** | **int64** | Overall emails sent for since the account exists | [optional] [default to null] 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** | [**[]interface{}**](interface{}.md) | Your children's account information | [optional] [default to null] 7 | **Count** | **int64** | Number of child accounts | [optional] [default to null] 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** | **string** | Login Email | [default to null] 7 | **FirstName** | **string** | First Name | [default to null] 8 | **LastName** | **string** | Last Name | [default to null] 9 | **CompanyName** | **string** | Name of the company | [default to null] 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 | **CampaignId** | **int64** | ID of the campaign which generated the event | [default to null] 7 | **Links** | [**[]GetExtendedContactDetailsStatisticsLinks**](GetExtendedContactDetailsStatisticsLinks.md) | | [default to null] 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 | **CampaignId** | **int64** | ID of the campaign which generated the event | [default to null] 7 | **Count** | **int64** | Number of openings of the campaign | [default to null] 8 | **EventTime** | **string** | UTC date-time of the event | [default to null] 9 | **Ip** | **string** | IP from which the user has opened the campaign | [default to null] 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 | **OrderDate** | **string** | Date of the order | [default to null] 7 | **OrderPrice** | **float32** | Price of the order | [default to null] 8 | **OrderId** | **int64** | ID of the order | [default to null] 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 | **UserUnsubscription** | [**[]GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email | [default to null] 7 | **AdminUnsubscription** | [**[]GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | [default to null] 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/GetContacts.md: -------------------------------------------------------------------------------- 1 | # GetContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Contacts** | [**[]interface{}**](interface{}.md) | | [default to null] 7 | **Count** | **int64** | Number of contacts | [default to null] 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** | **int64** | Number of total clicks for the campaign using the particular browser | [default to null] 7 | **UniqueClicks** | **int64** | Number of unique clicks for the campaign using the particular browser | [default to null] 8 | **Viewed** | **int64** | Number of openings for the campaign using the particular browser | [default to null] 9 | **UniqueViews** | **int64** | Number of unique openings for the campaign using the particular browser | [default to null] 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** | [**[]interface{}**](interface{}.md) | | [optional] [default to null] 7 | **Count** | **int64** | Number of Email campaigns retrieved | [optional] [default to null] 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** | [**[]GetEmailEventReportEvents**](GetEmailEventReportEvents.md) | | [optional] [default to null] 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/GetExtendedCampaignOverviewSender.md: -------------------------------------------------------------------------------- 1 | # GetExtendedCampaignOverviewSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Name** | **string** | Sender name of the campaign | [optional] [default to null] 7 | **Email** | **string** | Sender email of the campaign | [optional] [default to null] 8 | **Id** | **string** | Sender id of the campaign | [optional] [default to null] 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/GetExtendedClient.md: -------------------------------------------------------------------------------- 1 | # GetExtendedClient 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Email** | **string** | Login Email | [default to null] 7 | **FirstName** | **string** | First Name | [default to null] 8 | **LastName** | **string** | Last Name | [default to null] 9 | **CompanyName** | **string** | Name of the company | [default to null] 10 | **Address** | [***GetExtendedClientAddress**](GetExtendedClientAddress.md) | | [default to null] 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** | **string** | Street information | [default to null] 7 | **City** | **string** | City information | [default to null] 8 | **ZipCode** | **string** | Zip Code information | [default to null] 9 | **Country** | **string** | Country information | [default to null] 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/GetExtendedContactDetailsStatisticsClicked.md: -------------------------------------------------------------------------------- 1 | # GetExtendedContactDetailsStatisticsClicked 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **CampaignId** | **int64** | ID of the campaign which generated the event | [default to null] 7 | **Links** | [**[]GetExtendedContactDetailsStatisticsLinks**](GetExtendedContactDetailsStatisticsLinks.md) | Listing of the clicked links for the campaign | [default to null] 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 | **CampaignId** | **int64** | ID of the campaign which generated the event | [default to null] 7 | **EventTime** | **string** | UTC date-time of the event | [default to null] 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** | **int64** | Number of clicks on this link for the campaign | [default to null] 7 | **EventTime** | **string** | UTC date-time of the event | [default to null] 8 | **Ip** | **string** | IP from which the user has clicked on the link | [default to null] 9 | **Url** | **string** | URL of the clicked link | [default to null] 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 | **CampaignId** | **int64** | ID of the campaign which generated the event | [default to null] 7 | **EventTime** | **string** | UTC date-time of the event | [default to null] 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 | **CampaignId** | **int64** | ID of the campaign which generated the event | [default to null] 7 | **Count** | **int64** | Number of openings for the campaign | [default to null] 8 | **EventTime** | **string** | UTC date-time of the event | [default to null] 9 | **Ip** | **string** | IP from which the user has opened the email | [default to null] 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 | **UserUnsubscription** | [**[]GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact unsubscribe via unsubscription link in a campaign | [default to null] 7 | **AdminUnsubscription** | [**[]GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | [default to null] 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 | **EventTime** | **string** | UTC date-time of the event | [default to null] 7 | **Ip** | **string** | IP from which the user has been unsubscribed | [optional] [default to null] 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 | **CampaignId** | **int64** | ID of the campaign which generated the event | [default to null] 7 | **EventTime** | **string** | UTC date-time of the event | [default to null] 8 | **Ip** | **string** | IP from which the user has unsubscribed | [optional] [default to null] 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** | **int64** | ID of the list | [default to null] 7 | **Name** | **string** | Name of the list | [default to null] 8 | **TotalBlacklisted** | **int64** | Number of blacklisted contacts in the list | [default to null] 9 | **TotalSubscribers** | **int64** | Number of contacts in the list | [default to null] 10 | **UniqueSubscribers** | **int64** | Number of unique contacts in the list | [default to null] 11 | **FolderId** | **int64** | ID of the folder | [default to null] 12 | **CreatedAt** | **string** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) | [default to null] 13 | **CampaignStats** | [**[]GetExtendedListCampaignStats**](GetExtendedListCampaignStats.md) | | [optional] [default to null] 14 | **DynamicList** | **bool** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional] [default to null] 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 | **CampaignId** | **int64** | ID of the campaign | [default to null] 7 | **Stats** | [***GetCampaignStats**](GetCampaignStats.md) | | [default to null] 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** | **int64** | ID of the folder | [default to null] 7 | **Name** | **string** | Name of the folder | [default to null] 8 | **TotalBlacklisted** | **int64** | Number of blacklisted contacts in the folder | [default to null] 9 | **TotalSubscribers** | **int64** | Number of contacts in the folder | [default to null] 10 | **UniqueSubscribers** | **int64** | Number of unique contacts in the folder | [default to null] 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** | [**[]interface{}**](interface{}.md) | | [optional] [default to null] 7 | **Count** | **int64** | Number of lists in the folder | [optional] [default to null] 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** | [**[]interface{}**](interface{}.md) | | [optional] [default to null] 7 | **Count** | **int64** | Number of folders available in your account | [optional] [default to null] 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** | [**[]GetInboundEmailEventsEvents**](GetInboundEmailEventsEvents.md) | | [optional] [default to null] 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/GetInboundEmailEventsByUuidAttachments.md: -------------------------------------------------------------------------------- 1 | # GetInboundEmailEventsByUuidAttachments 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Name** | **string** | filename specified in the Content-Disposition header of the attachment | [optional] [default to null] 7 | **ContentType** | **string** | value of the Content-Type header of the attachment | [optional] [default to null] 8 | **ContentId** | **string** | value of the Content-ID header of the attachment. | [optional] [default to null] 9 | **ContentLength** | **int32** | size of the attachment in bytes | [optional] [default to null] 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** | [**time.Time**](time.Time.md) | Date of the event | [optional] [default to null] 7 | **Type_** | **string** | Type of the event | [optional] [default to null] 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** | **string** | UUID that can be used to fetch additional data | [default to null] 7 | **Date** | [**time.Time**](time.Time.md) | Date when email was received on SMTP relay | [default to null] 8 | **Sender** | **string** | Sender’s email address | [default to null] 9 | **Recipient** | **string** | Recipient’s email address | [default to null] 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** | **int64** | ID of the dedicated IP | [default to null] 7 | **Ip** | **string** | Dedicated IP | [default to null] 8 | **Active** | **bool** | Status of the IP (true=active, false=inactive) | [default to null] 9 | **Domain** | **string** | Domain associated to the IP | [default to null] 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** | **int64** | ID of the dedicated IP | [default to null] 7 | **Ip** | **string** | Dedicated IP | [default to null] 8 | **Domain** | **string** | Domain associated to the IP | [default to null] 9 | **Weight** | **int64** | Weight of the IP | [default to null] 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** | [**[]GetIp**](GetIp.md) | Dedicated IP(s) available on your account | [default to null] 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** | [**[]GetIpFromSender**](GetIpFromSender.md) | Dedicated IP(s) linked to a sender | [default to null] 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** | **int64** | ID of the list | [default to null] 7 | **Name** | **string** | Name of the list | [default to null] 8 | **TotalBlacklisted** | **int64** | Number of blacklisted contacts in the list | [default to null] 9 | **TotalSubscribers** | **int64** | Number of contacts in the list | [default to null] 10 | **UniqueSubscribers** | **int64** | Number of unique contacts in the list | [default to null] 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** | [**[]interface{}**](interface{}.md) | Listing of all the lists available in your account | [optional] [default to null] 7 | **Count** | **int64** | Number of lists in your account | [optional] [default to null] 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** | **int64** | Id of the process | [default to null] 7 | **Status** | **string** | Status of the process | [default to null] 8 | **Name** | **string** | Process name | [default to null] 9 | **ExportUrl** | **string** | URL on which send export the of contacts once the process is completed | [optional] [default to null] 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** | [**[]GetProcess**](GetProcess.md) | List of processes available on your account | [optional] [default to null] 7 | **Count** | **int64** | Number of processes available on your account | [optional] [default to null] 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** | [**[]interface{}**](interface{}.md) | | [default to null] 7 | **Count** | **int64** | Number of products | [default to null] 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** | [**[]GetReportsReports**](GetReportsReports.md) | | [optional] [default to null] 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/GetScheduledEmailByBatchId.md: -------------------------------------------------------------------------------- 1 | # GetScheduledEmailByBatchId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Count** | **int32** | Total number of batches | [optional] [default to null] 7 | **Batches** | [**[]GetScheduledEmailByBatchIdBatches**](GetScheduledEmailByBatchIdBatches.md) | | [optional] [default to null] 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 | **ScheduledAt** | [**time.Time**](time.Time.md) | Datetime for which the batch was scheduled | [default to null] 7 | **CreatedAt** | [**time.Time**](time.Time.md) | Datetime on which the batch was scheduled | [default to null] 8 | **Status** | **string** | Current status of the scheduled batch | [default to null] 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 | **ScheduledAt** | [**time.Time**](time.Time.md) | Datetime for which the email was scheduled | [default to null] 7 | **CreatedAt** | [**time.Time**](time.Time.md) | Datetime on which the email was scheduled | [default to null] 8 | **Status** | **string** | Current status of the scheduled email | [default to null] 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** | [**[]GetSendersListSenders**](GetSendersListSenders.md) | List of the senders available in your account | [optional] [default to null] 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** | **string** | Dedicated IP available in your account | [default to null] 7 | **Domain** | **string** | Domain of the IP | [default to null] 8 | **Weight** | **int64** | Weight of the IP for this sender | [default to null] 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** | **int64** | Id of the sender | [default to null] 7 | **Name** | **string** | From Name associated to the sender | [default to null] 8 | **Email** | **string** | From Email associated to the sender | [default to null] 9 | **Active** | **bool** | Status of sender (true=activated, false=deactivated) | [default to null] 10 | **Ips** | [**[]GetSendersListIps**](GetSendersListIps.md) | List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs | [optional] [default to null] 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 | **SharedUrl** | **string** | A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users. | [default to null] 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/GetSmsCampaignOverview.md: -------------------------------------------------------------------------------- 1 | # GetSmsCampaignOverview 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Id** | **int64** | ID of the SMS Campaign | [default to null] 7 | **Name** | **string** | Name of the SMS Campaign | [default to null] 8 | **Status** | **string** | Status of the SMS Campaign | [default to null] 9 | **Content** | **string** | Content of the SMS Campaign | [default to null] 10 | **ScheduledAt** | **string** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] [default to null] 11 | **Sender** | **string** | Sender of the SMS Campaign | [default to null] 12 | **CreatedAt** | **string** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | [default to null] 13 | **ModifiedAt** | **string** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | [default to null] 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** | **int64** | Number of delivered SMS | [default to null] 7 | **Sent** | **int64** | Number of sent SMS | [default to null] 8 | **Processing** | **int64** | Number of processing SMS | [default to null] 9 | **SoftBounces** | **int64** | Number of softbounced SMS | [default to null] 10 | **HardBounces** | **int64** | Number of hardbounced SMS | [default to null] 11 | **Unsubscriptions** | **int64** | Number of unsubscription SMS | [default to null] 12 | **Answered** | **int64** | Number of replies to the SMS | [default to null] 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** | [**[]interface{}**](interface{}.md) | | [optional] [default to null] 7 | **Count** | **int64** | Number of SMS campaigns retrieved | [optional] [default to null] 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** | [**[]GetSmsEventReportEvents**](getSmsEventReportEvents.md) | | [optional] [default to null] 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 | **PhoneNumber** | **string** | Phone number which has generated the event | [optional] [default to null] 7 | **Date** | **string** | UTC date-time on which the event has been generated | [optional] [default to null] 8 | **MessageId** | **string** | Message ID which generated the event | [optional] [default to null] 9 | **Event** | **string** | Event which occurred | [optional] [default to null] 10 | **Reason** | **string** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] [default to null] 11 | **Reply** | **string** | | [optional] [default to null] 12 | **Tag** | **string** | Tag of the SMS which generated the event | [optional] [default to null] 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/GetSmtpTemplateOverviewSender.md: -------------------------------------------------------------------------------- 1 | # GetSmtpTemplateOverviewSender 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Name** | **string** | From email for the template | [optional] [default to null] 7 | **Email** | **string** | From email for the template | [optional] [default to null] 8 | **Id** | **string** | Sender id of the template | [optional] [default to null] 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** | **int64** | Count of transactional email templates | [optional] [default to null] 7 | **Templates** | [**[]GetSmtpTemplateOverview**](GetSmtpTemplateOverview.md) | | [optional] [default to null] 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** | **string** | Session token, it will remain valid for 15 days. | [default to null] 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** | [**map[string]GetDeviceBrowserStats**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional] [default to null] 7 | **Mobile** | [**map[string]GetDeviceBrowserStats**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional] [default to null] 8 | **Tablet** | [**map[string]GetDeviceBrowserStats**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional] [default to null] 9 | **Unknown** | [**map[string]GetDeviceBrowserStats**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional] [default to null] 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/GetTransacBlockedContacts.md: -------------------------------------------------------------------------------- 1 | # GetTransacBlockedContacts 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Count** | **int64** | Count of blocked or unsubscribed contact | [optional] [default to null] 7 | **Contacts** | [**[]GetTransacBlockedContactsContacts**](GetTransacBlockedContactsContacts.md) | | [optional] [default to null] 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** | **string** | Email address of the blocked or unsubscribed contact | [default to null] 7 | **SenderEmail** | **string** | Sender email address of the blocked or unsubscribed contact | [default to null] 8 | **Reason** | [***GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | | [default to null] 9 | **BlockedAt** | **string** | Date when the contact was blocked or unsubscribed on | [default to null] 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** | **string** | Reason code for blocking / unsubscribing (This code is safe for comparison) | [optional] [default to null] 7 | **Message** | **string** | Reason for blocking / unsubscribing (This string is not safe for comparison) | [optional] [default to null] 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** | **string** | Email address to which transactional email has been sent | [default to null] 7 | **Subject** | **string** | Subject of the sent email | [default to null] 8 | **TemplateId** | **int64** | Id of the template | [optional] [default to null] 9 | **Date** | **string** | Date on which transactional email was sent | [default to null] 10 | **Events** | [**[]GetTransacEmailContentEvents**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email | [default to null] 11 | **Body** | **string** | Actual content of the transactional email that has been sent | [default to null] 12 | **AttachmentCount** | **int64** | Count of the attachments that were sent in the email | [default to null] 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** | **string** | Name of the event that occurred on the sent email | [default to null] 7 | **Time** | **string** | Time at which the event occurred | [default to null] 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** | **int64** | Total number of transactional emails available on your account according to the passed filter | [optional] [default to null] 7 | **TransactionalEmails** | [**[]GetTransacEmailsListTransactionalEmails**](GetTransacEmailsListTransactionalEmails.md) | | [optional] [default to null] 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** | **string** | Email address to which transactional email has been sent | [default to null] 7 | **Subject** | **string** | Subject of the sent email | [default to null] 8 | **TemplateId** | **int64** | Id of the template | [optional] [default to null] 9 | **MessageId** | **string** | Message Id of the sent email | [default to null] 10 | **Uuid** | **string** | Unique id of the email sent to a particular contact | [default to null] 11 | **Date** | **string** | Date on which transactional email was sent | [default to null] 12 | **From** | **string** | Email address of the sender from which the email was sent | [optional] [default to null] 13 | **Tags** | **[]string** | Tags used for your email | [optional] [default to null] 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** | [**[]GetTransacSmsReportReports**](GetTransacSmsReportReports.md) | | [optional] [default to null] 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/GetWebhook.md: -------------------------------------------------------------------------------- 1 | # GetWebhook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Url** | **string** | URL of the webhook | [default to null] 7 | **Id** | **int64** | ID of the webhook | [default to null] 8 | **Description** | **string** | Description of the webhook | [default to null] 9 | **Events** | **[]string** | | [default to null] 10 | **Type_** | **string** | Type of webhook (marketing or transactional) | [default to null] 11 | **CreatedAt** | **string** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | [default to null] 12 | **ModifiedAt** | **string** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | [default to null] 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** | [**[]interface{}**](interface{}.md) | | [default to null] 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/InlineResponse200.md: -------------------------------------------------------------------------------- 1 | # InlineResponse200 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Id** | **string** | Unique company id | [default to null] 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** | **string** | Unique deal id | [default to null] 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** | **string** | Unique task id | [default to null] 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** | **string** | Dedicated ID | [optional] [default to null] 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** | **string** | Email id of master account | [optional] [default to null] 7 | **CompanyName** | **string** | Company name of master account organization | [optional] [default to null] 8 | **Id** | **int64** | Unique identifier of the master account organization | [optional] [default to null] 9 | **CurrencyCode** | **string** | Currency code of the master account organization | [optional] [default to null] 10 | **Timezone** | **string** | Timezone of the master account organization | [optional] [default to null] 11 | **BillingInfo** | [***MasterDetailsResponseBillingInfo**](MasterDetailsResponseBillingInfo.md) | | [optional] [default to null] 12 | **PlanInfo** | [***MasterDetailsResponsePlanInfo**](MasterDetailsResponsePlanInfo.md) | | [optional] [default to null] 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** | **string** | Billing email id of master account | [optional] [default to null] 7 | **CompanyName** | **string** | Company name of master account | [optional] [default to null] 8 | **Name** | [***MasterDetailsResponseBillingInfoName**](MasterDetailsResponseBillingInfoName.md) | | [optional] [default to null] 9 | **Address** | [***MasterDetailsResponseBillingInfoAddress**](MasterDetailsResponseBillingInfoAddress.md) | | [optional] [default to null] 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 | **StreetAddress** | **string** | Street address | [optional] [default to null] 7 | **Locality** | **string** | Locality | [optional] [default to null] 8 | **PostalCode** | **string** | Postal code | [optional] [default to null] 9 | **StateCode** | **string** | State code | [optional] [default to null] 10 | **CountryCode** | **string** | Country code | [optional] [default to null] 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 | **GivenName** | **string** | First name for billing | [optional] [default to null] 7 | **FamilyName** | **string** | Last name for billing | [optional] [default to null] 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 | **CurrencyCode** | **string** | Plan currency | [optional] [default to null] 7 | **NextBillingAt** | **int64** | Timestamp of next billing date | [optional] [default to null] 8 | **Price** | **float32** | Plan amount | [optional] [default to null] 9 | **PlanPeriod** | **string** | Plan period type | [optional] [default to null] 10 | **SubAccounts** | **int32** | Number of sub-accounts | [optional] [default to null] 11 | **Features** | [**[]MasterDetailsResponsePlanInfoFeatures**](MasterDetailsResponsePlanInfoFeatures.md) | List of provided features in the plan | [optional] [default to null] 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** | **string** | Name of the feature | [optional] [default to null] 7 | **UnitValue** | **string** | Unit value of the feature | [optional] [default to null] 8 | **Quantity** | **int64** | Quantity provided in the plan | [optional] [default to null] 9 | **Used** | **int64** | Quantity consumed by master | [optional] [default to null] 10 | **Remaining** | **int64** | Quantity remaining in the plan | [optional] [default to null] 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** | **string** | Unique note Id | [optional] [default to null] 7 | **Text** | **string** | Text content of a note | [default to null] 8 | **ContactIds** | **[]int32** | Contact ids linked to a note | [optional] [default to null] 9 | **DealIds** | **[]string** | Deal ids linked to a note | [optional] [default to null] 10 | **AuthorId** | [***interface{}**](interface{}.md) | Account details of user which created the note | [optional] [default to null] 11 | **CreatedAt** | [**time.Time**](time.Time.md) | Note created date/time | [optional] [default to null] 12 | **UpdatedAt** | [**time.Time**](time.Time.md) | Note updated date/time | [optional] [default to null] 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** | **string** | Text content of a note | [default to null] 7 | **ContactIds** | **[]int32** | Contact Ids linked to a note | [optional] [default to null] 8 | **DealIds** | **[]string** | Deal Ids linked to a note | [optional] [default to null] 9 | **CompanyIds** | **[]string** | Company Ids linked to a note | [optional] [default to null] 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** | **string** | Unique note Id | [optional] [default to null] 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/OrderBatch.md: -------------------------------------------------------------------------------- 1 | # OrderBatch 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Orders** | [**[]Order**](Order.md) | array of order objects | [default to null] 7 | **NotifyUrl** | **string** | Notify Url provided by client to get the status of batch request | [optional] [default to null] 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** | **string** | Full billing address. | [optional] [default to null] 7 | **City** | **string** | Exact city of the address. | [optional] [default to null] 8 | **CountryCode** | **string** | Billing country 2-letter ISO code. | [optional] [default to null] 9 | **Phone** | **string** | Phone number to contact for further details about the order, Mandatory if \"email\" field is not passed. | [optional] [default to null] 10 | **PostCode** | **string** | Postcode for delivery and billing. | [optional] [default to null] 11 | **PaymentMethod** | **string** | How the visitor will pay for the item(s), e.g. paypal, check, etc. | [optional] [default to null] 12 | **Region** | **string** | Exact region (state/province) for delivery and billing. | [optional] [default to null] 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 | **ProductId** | **string** | ID of the product. | [default to null] 7 | **Quantity** | **float32** | How many pieces of the product the visitor has added to the cart. | [default to null] 8 | **VariantId** | **string** | Product ID of the red color shirts. | [optional] [default to null] 9 | **Price** | **float32** | The price of a unit of product | [default to null] 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** | [**[]PipelineStage**](PipelineStage.md) | List of stages | [optional] [default to null] 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** | **string** | Stage id | [optional] [default to null] 7 | **Name** | **string** | Stage name | [optional] [default to null] 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) | | [default to null] 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** | **[]string** | | [optional] [default to null] 7 | **Failure** | **[]string** | | [optional] [default to null] 8 | **Total** | **int64** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional] [default to null] 9 | **ProcessId** | **int64** | Id of the process created to remove contacts from list when user opts for \"all\" option. | [optional] [default to null] 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** | **int64** | Response code | [default to null] 7 | **Message** | **string** | Response message | [default to null] 8 | **UnexistingEmails** | **[]string** | | [optional] [default to null] 9 | **WithoutListEmails** | **[]string** | | [optional] [default to null] 10 | **BlackListedEmails** | **[]string** | | [optional] [default to null] 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** | **int64** | Response code | [default to null] 7 | **Message** | **string** | Response message | [default to null] 8 | **UnexistingSms** | **[]string** | | [optional] [default to null] 9 | **WithoutListSms** | **[]string** | | [optional] [default to null] 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) | | [default to null] 7 | **Reseller** | [***RemainingCreditModelReseller**](RemainingCreditModelReseller.md) | | [default to null] 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** | **float64** | SMS Credits remaining for child account | [default to null] 7 | **Email** | **float64** | Email Credits remaining for child account | [default to null] 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** | **float64** | SMS Credits remaining for reseller account | [default to null] 7 | **Email** | **float64** | Email Credits remaining for reseller account | [default to null] 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** | **[]string** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional] [default to null] 7 | **Ids** | **[]int64** | 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] [default to null] 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] [default to null] 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** | **int64** | Required if email credits are empty. SMS credits to be removed from the child account | [optional] [default to null] 7 | **Email** | **int64** | Required if sms credits are empty. Email credits to be removed from the child account | [optional] [default to null] 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 | **ExportAttributes** | **[]string** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] [default to null] 7 | **CustomContactFilter** | [***RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | [default to null] 8 | **NotifyUrl** | **string** | Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] [default to null] 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 | **ListName** | **string** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional] [default to null] 7 | **FolderId** | **int64** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional] [default to null] 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 | **NotifyURL** | **string** | URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] [default to null] 7 | **RecipientsType** | **string** | Filter the recipients based on how they interacted with the campaign | [default to null] 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 | **MessageId** | **string** | Message ID of the transactional email scheduled | [optional] [default to null] 7 | **MessageIds** | **[]string** | | [optional] [default to null] 8 | **BatchId** | **string** | Batch ID of the batch transactional email scheduled | [optional] [default to null] 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/SendReport.md: -------------------------------------------------------------------------------- 1 | # SendReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Language** | **string** | Language of email content for campaign report sending. | [optional] [default to null] 7 | **Email** | [***SendReportEmail**](SendReportEmail.md) | | [default to null] 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** | **[]string** | Email addresses of the recipients | [default to null] 7 | **Body** | **string** | Custom text message to be presented in the report email. | [default to null] 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** | **string** | | [default to null] 7 | **MessageId** | **int64** | | [default to null] 8 | **SmsCount** | **int64** | Count of SMS's to send multiple text messages | [optional] [default to null] 9 | **UsedCredits** | **float32** | SMS credits used per text message | [optional] [default to null] 10 | **RemainingCredits** | **float32** | Remaining SMS credits of the user | [optional] [default to null] 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** | **string** | Absolute url of the attachment (no local file). | [optional] [default to null] 7 | **Content** | **string** | Base64 encoded chunk data of the attachment generated on the fly | [optional] [default to null] 8 | **Name** | **string** | Required if content is passed. Name of the attachment | [optional] [default to null] 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** | **string** | Email address of the recipient in bcc | [default to null] 7 | **Name** | **string** | Name of the recipient in bcc. Maximum allowed characters are 70. | [optional] [default to null] 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** | **string** | Email address of the recipient in cc | [default to null] 7 | **Name** | **string** | Name of the recipient in cc. Maximum allowed characters are 70. | [optional] [default to null] 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/SendSmtpEmailReplyTo.md: -------------------------------------------------------------------------------- 1 | # SendSmtpEmailReplyTo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Email** | **string** | Email address in reply to | [default to null] 7 | **Name** | **string** | Name in reply to. Maximum allowed characters are 70. | [optional] [default to null] 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** | **string** | Email address in reply to | [default to null] 7 | **Name** | **string** | Name in reply to. Maximum allowed characters are 70. | [optional] [default to null] 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** | **string** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed. | [optional] [default to null] 7 | **Email** | **string** | Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. | [optional] [default to null] 8 | **Id** | **int64** | 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] [default to null] 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** | **string** | Email address of the recipient | [default to null] 7 | **Name** | **string** | Name of the recipient. Maximum allowed characters are 70. | [optional] [default to null] 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** | **string** | Email address of the recipient | [default to null] 7 | **Name** | **string** | Name of the recipient. **Maximum allowed characters are 70**. | [optional] [default to null] 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/SendTestEmail.md: -------------------------------------------------------------------------------- 1 | # SendTestEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **EmailTo** | **[]string** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day. | [optional] [default to null] 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 | **PhoneNumber** | **string** | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted | [optional] [default to null] 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/SsoTokenRequest.md: -------------------------------------------------------------------------------- 1 | # SsoTokenRequest 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Id** | **int64** | Id of the sub-account organization | [default to null] 7 | **Email** | **string** | User email of sub-account organization | [optional] [default to null] 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/SubAccountDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # SubAccountDetailsResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Name** | **string** | Name of the sub-account user | [optional] [default to null] 7 | **Email** | **string** | Email id of the sub-account organization | [optional] [default to null] 8 | **CompanyName** | **string** | Sub-account company name | [optional] [default to null] 9 | **PlanInfo** | [***SubAccountDetailsResponsePlanInfo**](SubAccountDetailsResponsePlanInfo.md) | | [optional] [default to null] 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] [default to null] 7 | **Features** | [***SubAccountDetailsResponsePlanInfoFeatures**](SubAccountDetailsResponsePlanInfoFeatures.md) | | [optional] [default to null] 8 | **PlanType** | **string** | type of the plan | [optional] [default to null] 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** | **int64** | SMS credits remaining on the sub-account | [optional] [default to null] 7 | **Emails** | [***SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.md) | | [optional] [default to null] 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** | **int64** | Quantity of email messaging limits provided | [optional] [default to null] 7 | **Remaining** | **int64** | Available email messaging limits for use | [optional] [default to null] 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] [default to null] 7 | **LandingPage** | [***SubAccountDetailsResponsePlanInfoFeaturesLandingPage**](SubAccountDetailsResponsePlanInfoFeatureslandingPage.md) | | [optional] [default to null] 8 | **Users** | [***SubAccountDetailsResponsePlanInfoFeaturesUsers**](SubAccountDetailsResponsePlanInfoFeaturesusers.md) | | [optional] [default to null] 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** | **int64** | Quantity of inbox provided | [optional] [default to null] 7 | **Remaining** | **int64** | Available inboxes for use | [optional] [default to null] 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** | **int64** | Quantity of landing pages provided | [optional] [default to null] 7 | **Remaining** | **int64** | Available landing pages for use | [optional] [default to null] 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** | **int64** | Quantity of multi-account's provided | [optional] [default to null] 7 | **Remaining** | **int64** | Available multi-accounts for use | [optional] [default to null] 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] [default to null] 7 | **Features** | [***SubAccountUpdatePlanRequestFeatures**](SubAccountUpdatePlanRequestfeatures.md) | | [optional] [default to null] 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** | **int64** | Number of email credits | [optional] [default to null] 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** | **int64** | Number of multi-users | [optional] [default to null] 7 | **LandingPage** | **int64** | Number of landing pages | [optional] [default to null] 8 | **Inbox** | **int64** | Number of inboxes | [optional] [default to null] 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** | **int32** | Total number of subaccounts | [optional] [default to null] 7 | **SubAccounts** | [**[]SubAccountsResponseSubAccounts**](SubAccountsResponsesubAccounts.md) | | [optional] [default to null] 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** | **int64** | id of the sub-account | [default to null] 7 | **CompanyName** | **string** | Name of the sub-account company | [default to null] 8 | **Active** | **bool** | Whether the sub-account is active or not | [default to null] 9 | **CreatedAt** | **int64** | Timestamp when the sub-account was created | [default to null] 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** | **string** | Unique task id | [optional] [default to null] 7 | **TaskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. | [default to null] 8 | **Name** | **string** | Name of task | [default to null] 9 | **ContactsIds** | **[]int32** | Contact ids for contacts linked to this task | [optional] [default to null] 10 | **DealsIds** | **[]string** | Deal ids for deals a task is linked to | [optional] [default to null] 11 | **CompaniesIds** | **[]string** | Companies ids for companies a task is linked to | [optional] [default to null] 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** | [**[]Task**](Task.md) | List of tasks | [optional] [default to null] 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** | **int32** | Value of time unit before reminder is to be sent | [default to null] 7 | **Unit** | **string** | Unit of time before reminder is to be sent | [default to null] 8 | **Types** | **[]string** | Type of task reminder e.g email, push | [default to null] 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** | **string** | Id of task type | [optional] [default to null] 7 | **Title** | **string** | Title of task type | [optional] [default to null] 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** | **string** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional] [default to null] 7 | **Enumeration** | [**[]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] [default to null] 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** | **int32** | Id of the value | [default to null] 7 | **Label** | **string** | Label of the value | [default to null] 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** | [**[]UpdateBatchContactsContacts**](UpdateBatchContactscontacts.md) | List of contacts to be updated | [optional] [default to null] 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 | **SuccessIds** | **[]int64** | | [optional] [default to null] 7 | **FailureIds** | **[]int64** | | [optional] [default to null] 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** | **string** | Note:- replicateTemplate status will be available only for template type campaigns. | [optional] [default to null] 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** | **string** | New Email address to update the child account | [optional] [default to null] 7 | **FirstName** | **string** | New First name to use to update the child account | [optional] [default to null] 8 | **LastName** | **string** | New Last name to use to update the child account | [optional] [default to null] 9 | **CompanyName** | **string** | New Company name to use to update the child account | [optional] [default to null] 10 | **Password** | **string** | New password for the child account to login | [optional] [default to null] 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 | **TransactionalEmail** | **bool** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional] [default to null] 7 | **TransactionalSms** | **bool** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] [default to null] 8 | **MarketingAutomation** | **bool** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional] [default to null] 9 | **SmsCampaign** | **bool** | Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) | [optional] [default to null] 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** | **string** | Value for the sender domain that will replace the existing domain | [optional] [default to null] 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 | **ExclusionListIds** | **[]int64** | List ids which have to be excluded from a campaign | [optional] [default to null] 7 | **ListIds** | **[]int64** | 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] [default to null] 8 | **SegmentIds** | **[]int64** | 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] [default to null] 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** | **string** | Sender Name from which the campaign emails are sent | [optional] [default to null] 7 | **Email** | **string** | Sender email from which the campaign emails are sent | [optional] [default to null] 8 | **Id** | **int64** | 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] [default to null] 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/UpdateList.md: -------------------------------------------------------------------------------- 1 | # UpdateList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Name** | **string** | Name of the list. Either of the two parameters (name, folderId) can be updated at a time. | [optional] [default to null] 7 | **FolderId** | **int64** | 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] [default to null] 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** | **string** | From Name to update the sender | [optional] [default to null] 7 | **Email** | **string** | From Email to update the sender | [optional] [default to null] 8 | **Ips** | [**[]CreateSenderIps**](CreateSenderips.md) | Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. | [optional] [default to null] 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** | **string** | Name of the sender | [optional] [default to null] 7 | **Email** | **string** | Email of the sender | [optional] [default to null] 8 | **Id** | **int64** | 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] [default to null] 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/UploadImageModel.md: -------------------------------------------------------------------------------- 1 | # UploadImageModel 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **Url** | **string** | URL of the image uploaded | [default to null] 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 | **ImageUrl** | **string** | The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. | [default to null] 7 | **Name** | **string** | Name of the image. | [optional] [default to null] 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 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/sendinblue/APIv3-go-library/v2 2 | 3 | go 1.17 4 | 5 | require ( 6 | github.com/antihax/optional v1.0.0 7 | golang.org/x/oauth2 v0.0.0-20220608161450-d0670ef3b1eb 8 | ) 9 | 10 | require ( 11 | github.com/golang/protobuf v1.4.2 // indirect 12 | golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd // indirect 13 | google.golang.org/appengine v1.6.6 // indirect 14 | google.golang.org/protobuf v1.25.0 // indirect 15 | ) 16 | -------------------------------------------------------------------------------- /lib/model_ab_test_version_clicks.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // Information on clicked links for a particular version 14 | type AbTestVersionClicks struct { 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_block_domain.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type BlockDomain struct { 14 | // name of the domain to be blocked 15 | Domain string `json:"domain"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_body_11.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type Body11 struct { 14 | // edited message text 15 | Text string `json:"text"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_body_9.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type Body9 struct { 14 | // edited message text 15 | Text string `json:"text"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_companies_list.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // List of companies 14 | type CompaniesList struct { 15 | // List of compaies 16 | Items []Company `json:"items,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /lib/model_company_attributes.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // List of company attributes 14 | type CompanyAttributes struct { 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_create_model.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type CreateModel struct { 14 | // ID of the object created 15 | Id int64 `json:"id"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_create_product_model.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type CreateProductModel struct { 14 | // ID of the Product when a new product is created 15 | Id string `json:"id,omitempty"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_create_sub_account_response.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type CreateSubAccountResponse struct { 14 | // ID of the sub-account created 15 | Id int64 `json:"id"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_create_update_folder.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type CreateUpdateFolder struct { 14 | // Name of the folder 15 | Name string `json:"name,omitempty"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_created_batch_id.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type CreatedBatchId struct { 14 | BatchId int64 `json:"batch_id"` 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_created_process_id.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type CreatedProcessId struct { 14 | // Id of the process created 15 | ProcessId int64 `json:"processId"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_deal_attributes.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // List of deal attributes 14 | type DealAttributes struct { 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_deals_list.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // List of Deals 14 | type DealsList struct { 15 | // List of deals 16 | Items []Deal `json:"items,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /lib/model_file_list.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // List of files 14 | type FileList struct { 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_get_child_domains.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetChildDomains struct { 14 | } 15 | -------------------------------------------------------------------------------- /lib/model_get_contacts.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetContacts struct { 14 | Contacts []interface{} `json:"contacts"` 15 | // Number of contacts 16 | Count int64 `json:"count"` 17 | } 18 | -------------------------------------------------------------------------------- /lib/model_get_email_event_report.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetEmailEventReport struct { 14 | Events []GetEmailEventReportEvents `json:"events,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_get_inbound_email_events.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetInboundEmailEvents struct { 14 | Events []GetInboundEmailEventsEvents `json:"events,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_get_ips.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetIps struct { 14 | // Dedicated IP(s) available on your account 15 | Ips []GetIp `json:"ips"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_get_ips_from_sender.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetIpsFromSender struct { 14 | // Dedicated IP(s) linked to a sender 15 | Ips []GetIpFromSender `json:"ips"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_get_reports.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetReports struct { 14 | Reports []GetReportsReports `json:"reports,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_get_sms_event_report.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetSmsEventReport struct { 14 | Events []GetSmsEventReportEvents `json:"events,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_get_sso_token.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetSsoToken struct { 14 | // Session token, it will remain valid for 15 days. 15 | Token string `json:"token"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_get_stats_by_browser.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetStatsByBrowser struct { 14 | } 15 | -------------------------------------------------------------------------------- /lib/model_get_stats_by_domain.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetStatsByDomain struct { 14 | } 15 | -------------------------------------------------------------------------------- /lib/model_get_transac_sms_report.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetTransacSmsReport struct { 14 | Reports []GetTransacSmsReportReports `json:"reports,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_get_webhooks.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type GetWebhooks struct { 14 | Webhooks []interface{} `json:"webhooks"` 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_inline_response_200.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // Created company id 14 | type InlineResponse200 struct { 15 | // Unique company id 16 | Id string `json:"id"` 17 | } 18 | -------------------------------------------------------------------------------- /lib/model_inline_response_201.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // Created deal id 14 | type InlineResponse201 struct { 15 | // Unique deal id 16 | Id string `json:"id"` 17 | } 18 | -------------------------------------------------------------------------------- /lib/model_inline_response_201_1.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // Task Details 14 | type InlineResponse2011 struct { 15 | // Unique task id 16 | Id string `json:"id"` 17 | } 18 | -------------------------------------------------------------------------------- /lib/model_manage_ip.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type ManageIp struct { 14 | // Dedicated ID 15 | Ip string `json:"ip,omitempty"` 16 | } 17 | -------------------------------------------------------------------------------- /lib/model_note_id.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // Updated Note ID 14 | type NoteId struct { 15 | // Unique note Id 16 | Id string `json:"id,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /lib/model_note_list.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // List of notes 14 | type NoteList struct { 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_pipeline.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // List of stages 14 | type Pipeline struct { 15 | // List of stages 16 | Stages []PipelineStage `json:"stages,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /lib/model_post_contact_info.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type PostContactInfo struct { 14 | Contacts *PostContactInfoContacts `json:"contacts"` 15 | } 16 | -------------------------------------------------------------------------------- /lib/model_task_list.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | // List of tasks 14 | type TaskList struct { 15 | // List of tasks 16 | Items []Task `json:"items,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /lib/model_upload_image_model.go: -------------------------------------------------------------------------------- 1 | /* 2 | * SendinBlue API 3 | * 4 | * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | 5 | * 6 | * API version: 3.0.0 7 | * Contact: contact@sendinblue.com 8 | * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) 9 | */ 10 | 11 | package lib 12 | 13 | type UploadImageModel struct { 14 | // URL of the image uploaded 15 | Url string `json:"url"` 16 | } 17 | --------------------------------------------------------------------------------