sib-api-v3-sdk 7.5.0 → 9.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +130 -4
- data/docs/Body.md +9 -0
- data/docs/Body1.md +9 -0
- data/docs/Body10.md +11 -0
- data/docs/{SendTemplateEmail.md → Body11.md} +2 -2
- data/docs/Body12.md +11 -0
- data/docs/Body2.md +11 -0
- data/docs/Body3.md +9 -0
- data/docs/Body4.md +9 -0
- data/docs/Body5.md +11 -0
- data/docs/Body6.md +18 -0
- data/docs/Body7.md +17 -0
- data/docs/Body8.md +13 -0
- data/docs/Body9.md +8 -0
- data/docs/CompaniesApi.md +425 -0
- data/docs/CompaniesList.md +8 -0
- data/docs/Company.md +11 -0
- data/docs/CompanyAttributes.md +7 -0
- data/docs/CompanyAttributesInner.md +12 -0
- data/docs/ContactsApi.md +69 -4
- data/docs/ConversationsApi.md +542 -0
- data/docs/ConversationsMessage.md +17 -0
- data/docs/ConversationsMessageFile.md +12 -0
- data/docs/ConversationsMessageFileImageInfo.md +10 -0
- data/docs/CreateContact.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -0
- data/docs/CreateSubAccount.md +11 -0
- data/docs/CreateSubAccountResponse.md +8 -0
- data/docs/CreateWebhook.md +2 -1
- data/docs/Deal.md +11 -0
- data/docs/DealAttributes.md +7 -0
- data/docs/DealAttributesInner.md +12 -0
- data/docs/DealsApi.md +476 -0
- data/docs/DealsList.md +8 -0
- data/docs/EmailCampaignsApi.md +6 -5
- data/docs/FileData.md +14 -0
- data/docs/FileDownloadableLink.md +8 -0
- data/docs/FileList.md +7 -0
- data/docs/FilesApi.md +318 -0
- data/docs/GetCampaignStats.md +3 -0
- data/docs/GetContactCampaignStats.md +1 -0
- data/docs/GetExtendedContactDetailsStatistics.md +1 -0
- data/docs/GetExtendedContactDetailsStatisticsDelivered.md +9 -0
- data/docs/GetInboundEmailEvents.md +8 -0
- data/docs/GetInboundEmailEventsByUuid.md +15 -0
- data/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
- data/docs/GetInboundEmailEventsByUuidLogs.md +9 -0
- data/docs/GetInboundEmailEventsEvents.md +11 -0
- data/docs/GetScheduledEmailByBatchId.md +9 -0
- data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
- data/docs/GetScheduledEmailByMessageId.md +10 -0
- data/docs/GetSsoToken.md +1 -1
- data/docs/InboundParsingApi.md +199 -0
- data/docs/InlineResponse200.md +8 -0
- data/docs/InlineResponse201.md +8 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/MasterAccountApi.md +424 -0
- data/docs/MasterDetailsResponse.md +14 -0
- data/docs/MasterDetailsResponseBillingInfo.md +11 -0
- data/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
- data/docs/MasterDetailsResponseBillingInfoName.md +9 -0
- data/docs/MasterDetailsResponsePlanInfo.md +13 -0
- data/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
- data/docs/Note.md +14 -0
- data/docs/NoteData.md +10 -0
- data/docs/NoteId.md +8 -0
- data/docs/NoteList.md +7 -0
- data/docs/NotesApi.md +312 -0
- data/docs/Pipeline.md +8 -0
- data/docs/PipelineStage.md +9 -0
- data/docs/RequestContactExport.md +1 -2
- data/docs/RequestContactImport.md +3 -2
- data/docs/ScheduleSmtpEmail.md +10 -0
- data/docs/SendSmtpEmail.md +6 -4
- data/docs/SendTransacSms.md +1 -0
- data/docs/SsoTokenRequest.md +9 -0
- data/docs/SubAccountDetailsResponse.md +11 -0
- data/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
- data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
- data/docs/SubAccountUpdatePlanRequest.md +9 -0
- data/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
- data/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
- data/docs/SubAccountsResponse.md +9 -0
- data/docs/SubAccountsResponseSubAccounts.md +11 -0
- data/docs/Task.md +13 -0
- data/docs/TaskList.md +8 -0
- data/docs/TaskReminder.md +10 -0
- data/docs/TaskTypes.md +9 -0
- data/docs/TasksApi.md +376 -0
- data/docs/TransactionalEmailsApi.md +203 -63
- data/docs/UpdateBatchContacts.md +8 -0
- data/docs/UpdateBatchContactsContacts.md +16 -0
- data/docs/UpdateBatchContactsModel.md +9 -0
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +1 -1
- data/docs/UpdateSmsCampaign.md +1 -0
- data/docs/UpdateSmtpTemplate.md +1 -1
- data/docs/UpdateWebhook.md +2 -1
- data/docs/UploadImageModel.md +8 -0
- data/lib/sib-api-v3-sdk/api/companies_api.rb +409 -0
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +61 -2
- data/lib/sib-api-v3-sdk/api/conversations_api.rb +504 -0
- data/lib/sib-api-v3-sdk/api/deals_api.rb +454 -0
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +9 -8
- data/lib/sib-api-v3-sdk/api/files_api.rb +313 -0
- data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +213 -0
- data/lib/sib-api-v3-sdk/api/master_account_api.rb +416 -0
- data/lib/sib-api-v3-sdk/api/notes_api.rb +308 -0
- data/lib/sib-api-v3-sdk/api/tasks_api.rb +375 -0
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +201 -62
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +2 -2
- data/lib/sib-api-v3-sdk/models/{send_email_attachment.rb → body.rb} +16 -40
- data/lib/sib-api-v3-sdk/models/body_1.rb +195 -0
- data/lib/sib-api-v3-sdk/models/body_10.rb +225 -0
- data/lib/sib-api-v3-sdk/models/{send_template_email.rb → body_11.rb} +12 -12
- data/lib/sib-api-v3-sdk/models/body_12.rb +215 -0
- data/lib/sib-api-v3-sdk/models/body_2.rb +223 -0
- data/lib/sib-api-v3-sdk/models/body_3.rb +200 -0
- data/lib/sib-api-v3-sdk/models/body_4.rb +195 -0
- data/lib/sib-api-v3-sdk/models/body_5.rb +223 -0
- data/lib/sib-api-v3-sdk/models/body_6.rb +320 -0
- data/lib/sib-api-v3-sdk/models/body_7.rb +281 -0
- data/lib/sib-api-v3-sdk/models/body_8.rb +245 -0
- data/lib/sib-api-v3-sdk/models/body_9.rb +190 -0
- data/lib/sib-api-v3-sdk/models/companies_list.rb +188 -0
- data/lib/sib-api-v3-sdk/models/{send_email.rb → company.rb} +30 -90
- data/lib/sib-api-v3-sdk/models/company_attributes.rb +176 -0
- data/lib/sib-api-v3-sdk/models/company_attributes_inner.rb +223 -0
- data/lib/sib-api-v3-sdk/models/conversations_message.rb +324 -0
- data/lib/sib-api-v3-sdk/models/conversations_message_file.rb +239 -0
- data/lib/sib-api-v3-sdk/models/conversations_message_file_image_info.rb +236 -0
- data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +16 -4
- data/lib/sib-api-v3-sdk/models/create_sub_account.rb +259 -0
- data/lib/sib-api-v3-sdk/models/create_sub_account_response.rb +190 -0
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +17 -7
- data/lib/sib-api-v3-sdk/models/deal.rb +220 -0
- data/lib/sib-api-v3-sdk/models/deal_attributes.rb +176 -0
- data/lib/sib-api-v3-sdk/models/deal_attributes_inner.rb +223 -0
- data/lib/sib-api-v3-sdk/models/deals_list.rb +188 -0
- data/lib/sib-api-v3-sdk/models/file_data.rb +246 -0
- data/lib/sib-api-v3-sdk/models/file_downloadable_link.rb +190 -0
- data/lib/sib-api-v3-sdk/models/file_list.rb +176 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +36 -1
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +15 -4
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +16 -4
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_delivered.rb +205 -0
- data/lib/sib-api-v3-sdk/models/get_inbound_email_events.rb +186 -0
- data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid.rb +259 -0
- data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid_attachments.rb +215 -0
- data/lib/sib-api-v3-sdk/models/get_inbound_email_events_by_uuid_logs.rb +229 -0
- data/lib/sib-api-v3-sdk/models/get_inbound_email_events_events.rb +235 -0
- data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_batch_id.rb +196 -0
- data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_batch_id_batches.rb +254 -0
- data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_message_id.rb +254 -0
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +1 -1
- data/lib/sib-api-v3-sdk/models/inline_response_200.rb +191 -0
- data/lib/sib-api-v3-sdk/models/inline_response_201.rb +191 -0
- data/lib/sib-api-v3-sdk/models/inline_response_201_1.rb +191 -0
- data/lib/sib-api-v3-sdk/models/master_details_response.rb +243 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_billing_info.rb +214 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_billing_info_address.rb +226 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_billing_info_name.rb +196 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_plan_info.rb +272 -0
- data/lib/sib-api-v3-sdk/models/master_details_response_plan_info_features.rb +225 -0
- data/lib/sib-api-v3-sdk/models/note.rb +283 -0
- data/lib/sib-api-v3-sdk/models/note_data.rb +243 -0
- data/lib/sib-api-v3-sdk/models/note_id.rb +186 -0
- data/lib/sib-api-v3-sdk/models/note_list.rb +176 -0
- data/lib/sib-api-v3-sdk/models/pipeline.rb +188 -0
- data/lib/sib-api-v3-sdk/models/pipeline_stage.rb +196 -0
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +6 -11
- data/lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb +1 -1
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +15 -3
- data/lib/sib-api-v3-sdk/models/schedule_smtp_email.rb +206 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +28 -8
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +16 -4
- data/lib/sib-api-v3-sdk/models/sso_token_request.rb +200 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response.rb +214 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info.rb +204 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits.rb +195 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits_emails.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features.rb +203 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_inbox.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_landing_page.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features_users.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request.rb +194 -0
- data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request_credits.rb +186 -0
- data/lib/sib-api-v3-sdk/models/sub_account_update_plan_request_features.rb +206 -0
- data/lib/sib-api-v3-sdk/models/sub_accounts_response.rb +196 -0
- data/lib/sib-api-v3-sdk/models/sub_accounts_response_sub_accounts.rb +235 -0
- data/lib/sib-api-v3-sdk/models/task.rb +252 -0
- data/lib/sib-api-v3-sdk/models/task_list.rb +188 -0
- data/lib/sib-api-v3-sdk/models/task_reminder.rb +257 -0
- data/lib/sib-api-v3-sdk/models/task_types.rb +196 -0
- data/lib/sib-api-v3-sdk/models/update_batch_contacts.rb +187 -0
- data/lib/sib-api-v3-sdk/models/update_batch_contacts_contacts.rb +273 -0
- data/lib/sib-api-v3-sdk/models/update_batch_contacts_model.rb +197 -0
- data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +16 -4
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +15 -5
- data/lib/sib-api-v3-sdk/models/upload_image_model.rb +190 -0
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/lib/sib-api-v3-sdk.rb +84 -3
- data/sib-api-v3-sdk.gemspec +2 -1
- data/spec/api/companies_api_spec.rb +119 -0
- data/spec/api/contacts_api_spec.rb +15 -1
- data/spec/api/conversations_api_spec.rb +140 -0
- data/spec/api/deals_api_spec.rb +129 -0
- data/spec/api/email_campaigns_api_spec.rb +1 -1
- data/spec/api/files_api_spec.rb +99 -0
- data/spec/api/inbound_parsing_api_spec.rb +76 -0
- data/spec/api/master_account_api_spec.rb +119 -0
- data/spec/api/notes_api_spec.rb +97 -0
- data/spec/api/tasks_api_spec.rb +113 -0
- data/spec/api/transactional_emails_api_spec.rb +46 -13
- data/spec/models/body_10_spec.rb +59 -0
- data/spec/models/{send_template_email_spec.rb → body_11_spec.rb} +7 -7
- data/spec/models/body_12_spec.rb +59 -0
- data/spec/models/{send_email_attachment_spec.rb → body_1_spec.rb} +8 -8
- data/spec/models/body_2_spec.rb +59 -0
- data/spec/models/body_3_spec.rb +47 -0
- data/spec/models/body_4_spec.rb +47 -0
- data/spec/models/body_5_spec.rb +59 -0
- data/spec/models/body_6_spec.rb +101 -0
- data/spec/models/body_7_spec.rb +95 -0
- data/spec/models/body_8_spec.rb +71 -0
- data/spec/models/body_9_spec.rb +41 -0
- data/spec/models/body_spec.rb +47 -0
- data/spec/models/companies_list_spec.rb +41 -0
- data/spec/models/company_attributes_inner_spec.rb +65 -0
- data/spec/models/company_attributes_spec.rb +35 -0
- data/spec/models/company_spec.rb +59 -0
- data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
- data/spec/models/conversations_message_file_spec.rb +65 -0
- data/spec/models/conversations_message_spec.rb +99 -0
- data/spec/models/create_sms_campaign_spec.rb +6 -0
- data/spec/models/create_sub_account_response_spec.rb +41 -0
- data/spec/models/create_sub_account_spec.rb +63 -0
- data/spec/models/create_webhook_spec.rb +8 -2
- data/spec/models/deal_attributes_inner_spec.rb +65 -0
- data/spec/models/deal_attributes_spec.rb +35 -0
- data/spec/models/deal_spec.rb +59 -0
- data/spec/models/deals_list_spec.rb +41 -0
- data/spec/models/file_data_spec.rb +77 -0
- data/spec/models/file_downloadable_link_spec.rb +41 -0
- data/spec/models/file_list_spec.rb +35 -0
- data/spec/models/get_campaign_stats_spec.rb +18 -0
- data/spec/models/get_contact_campaign_stats_spec.rb +6 -0
- data/spec/models/get_email_event_report_events_spec.rb +1 -1
- data/spec/models/get_extended_contact_details_statistics_delivered_spec.rb +47 -0
- data/spec/models/get_extended_contact_details_statistics_spec.rb +6 -0
- data/spec/models/get_inbound_email_events_by_uuid_attachments_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_by_uuid_logs_spec.rb +51 -0
- data/spec/models/get_inbound_email_events_by_uuid_spec.rb +83 -0
- data/spec/models/get_inbound_email_events_events_spec.rb +59 -0
- data/spec/models/get_inbound_email_events_spec.rb +41 -0
- data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
- data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
- data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
- data/spec/models/inline_response_200_spec.rb +41 -0
- data/spec/models/inline_response_201_1_spec.rb +41 -0
- data/spec/models/inline_response_201_spec.rb +41 -0
- data/spec/models/master_details_response_billing_info_address_spec.rb +65 -0
- data/spec/models/master_details_response_billing_info_name_spec.rb +47 -0
- data/spec/models/master_details_response_billing_info_spec.rb +59 -0
- data/spec/models/master_details_response_plan_info_features_spec.rb +65 -0
- data/spec/models/master_details_response_plan_info_spec.rb +75 -0
- data/spec/models/master_details_response_spec.rb +77 -0
- data/spec/models/note_data_spec.rb +53 -0
- data/spec/models/note_id_spec.rb +41 -0
- data/spec/models/note_list_spec.rb +35 -0
- data/spec/models/note_spec.rb +77 -0
- data/spec/models/pipeline_spec.rb +41 -0
- data/spec/models/pipeline_stage_spec.rb +47 -0
- data/spec/models/request_contact_export_spec.rb +0 -6
- data/spec/models/request_contact_import_spec.rb +6 -0
- data/spec/models/schedule_smtp_email_spec.rb +53 -0
- data/spec/models/send_smtp_email_spec.rb +12 -0
- data/spec/models/send_transac_sms_spec.rb +6 -0
- data/spec/models/sso_token_request_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_emails_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_credits_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_inbox_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_landing_page_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_features_spec.rb +53 -0
- data/spec/models/sub_account_details_response_plan_info_features_users_spec.rb +47 -0
- data/spec/models/sub_account_details_response_plan_info_spec.rb +53 -0
- data/spec/models/sub_account_details_response_spec.rb +59 -0
- data/spec/models/sub_account_update_plan_request_credits_spec.rb +41 -0
- data/spec/models/sub_account_update_plan_request_features_spec.rb +53 -0
- data/spec/models/sub_account_update_plan_request_spec.rb +47 -0
- data/spec/models/sub_accounts_response_spec.rb +47 -0
- data/spec/models/sub_accounts_response_sub_accounts_spec.rb +59 -0
- data/spec/models/task_list_spec.rb +41 -0
- data/spec/models/task_reminder_spec.rb +57 -0
- data/spec/models/task_spec.rb +71 -0
- data/spec/models/task_types_spec.rb +47 -0
- data/spec/models/{send_email_spec.rb → update_batch_contacts_contacts_spec.rb} +15 -15
- data/spec/models/update_batch_contacts_model_spec.rb +47 -0
- data/spec/models/update_batch_contacts_spec.rb +41 -0
- data/spec/models/update_sms_campaign_spec.rb +6 -0
- data/spec/models/update_webhook_spec.rb +7 -1
- data/spec/models/upload_image_model_spec.rb +41 -0
- metadata +359 -15
- data/docs/SendEmail.md +0 -16
- data/docs/SendEmailAttachment.md +0 -9
data/docs/TasksApi.md
ADDED
@@ -0,0 +1,376 @@
|
|
1
|
+
# SibApiV3Sdk::TasksApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**crm_tasks_get**](TasksApi.md#crm_tasks_get) | **GET** /crm/tasks | Get all tasks
|
8
|
+
[**crm_tasks_id_delete**](TasksApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task
|
9
|
+
[**crm_tasks_id_get**](TasksApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task
|
10
|
+
[**crm_tasks_id_patch**](TasksApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task
|
11
|
+
[**crm_tasks_post**](TasksApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a task
|
12
|
+
[**crm_tasktypes_get**](TasksApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types
|
13
|
+
|
14
|
+
|
15
|
+
# **crm_tasks_get**
|
16
|
+
> TaskList crm_tasks_get(opts)
|
17
|
+
|
18
|
+
Get all tasks
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'sib-api-v3-sdk'
|
24
|
+
# setup authorization
|
25
|
+
SibApiV3Sdk.configure do |config|
|
26
|
+
# Configure API key authorization: api-key
|
27
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
30
|
+
|
31
|
+
# Configure API key authorization: partner-key
|
32
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = SibApiV3Sdk::TasksApi.new
|
38
|
+
|
39
|
+
opts = {
|
40
|
+
filter_type: 'filter_type_example', # String | Filter by task type (ID)
|
41
|
+
filter_status: 'filter_status_example', # String | Filter by task status
|
42
|
+
filter_date: 'filter_date_example', # String | Filter by date
|
43
|
+
filter_assign_to: 'filter_assign_to_example', # String | Filter by assignTo id
|
44
|
+
filter_contacts: 'filter_contacts_example', # String | Filter by contact ids
|
45
|
+
filter_deals: 'filter_deals_example', # String | Filter by deals ids
|
46
|
+
filter_companies: 'filter_companies_example', # String | Filter by companies ids
|
47
|
+
date_from: 56, # Integer | dateFrom to date range filter type (timestamp in milliseconds)
|
48
|
+
date_to: 56, # Integer | dateTo to date range filter type (timestamp in milliseconds)
|
49
|
+
offset: 789, # Integer | Index of the first document of the page
|
50
|
+
limit: 50, # Integer | Number of documents per page
|
51
|
+
sort: 'sort_example', # String | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
52
|
+
sort_by: 'sort_by_example' # String | The field used to sort field names.
|
53
|
+
}
|
54
|
+
|
55
|
+
begin
|
56
|
+
#Get all tasks
|
57
|
+
result = api_instance.crm_tasks_get(opts)
|
58
|
+
p result
|
59
|
+
rescue SibApiV3Sdk::ApiError => e
|
60
|
+
puts "Exception when calling TasksApi->crm_tasks_get: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
Name | Type | Description | Notes
|
67
|
+
------------- | ------------- | ------------- | -------------
|
68
|
+
**filter_type** | **String**| Filter by task type (ID) | [optional]
|
69
|
+
**filter_status** | **String**| Filter by task status | [optional]
|
70
|
+
**filter_date** | **String**| Filter by date | [optional]
|
71
|
+
**filter_assign_to** | **String**| Filter by assignTo id | [optional]
|
72
|
+
**filter_contacts** | **String**| Filter by contact ids | [optional]
|
73
|
+
**filter_deals** | **String**| Filter by deals ids | [optional]
|
74
|
+
**filter_companies** | **String**| Filter by companies ids | [optional]
|
75
|
+
**date_from** | **Integer**| dateFrom to date range filter type (timestamp in milliseconds) | [optional]
|
76
|
+
**date_to** | **Integer**| dateTo to date range filter type (timestamp in milliseconds) | [optional]
|
77
|
+
**offset** | **Integer**| Index of the first document of the page | [optional]
|
78
|
+
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
79
|
+
**sort** | **String**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
|
80
|
+
**sort_by** | **String**| The field used to sort field names. | [optional]
|
81
|
+
|
82
|
+
### Return type
|
83
|
+
|
84
|
+
[**TaskList**](TaskList.md)
|
85
|
+
|
86
|
+
### Authorization
|
87
|
+
|
88
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
89
|
+
|
90
|
+
### HTTP request headers
|
91
|
+
|
92
|
+
- **Content-Type**: application/json
|
93
|
+
- **Accept**: application/json
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
# **crm_tasks_id_delete**
|
98
|
+
> crm_tasks_id_delete(id)
|
99
|
+
|
100
|
+
Delete a task
|
101
|
+
|
102
|
+
### Example
|
103
|
+
```ruby
|
104
|
+
# load the gem
|
105
|
+
require 'sib-api-v3-sdk'
|
106
|
+
# setup authorization
|
107
|
+
SibApiV3Sdk.configure do |config|
|
108
|
+
# Configure API key authorization: api-key
|
109
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
110
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
111
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
112
|
+
|
113
|
+
# Configure API key authorization: partner-key
|
114
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
115
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
116
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
117
|
+
end
|
118
|
+
|
119
|
+
api_instance = SibApiV3Sdk::TasksApi.new
|
120
|
+
|
121
|
+
id = 'id_example' # String |
|
122
|
+
|
123
|
+
|
124
|
+
begin
|
125
|
+
#Delete a task
|
126
|
+
api_instance.crm_tasks_id_delete(id)
|
127
|
+
rescue SibApiV3Sdk::ApiError => e
|
128
|
+
puts "Exception when calling TasksApi->crm_tasks_id_delete: #{e}"
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
### Parameters
|
133
|
+
|
134
|
+
Name | Type | Description | Notes
|
135
|
+
------------- | ------------- | ------------- | -------------
|
136
|
+
**id** | **String**| |
|
137
|
+
|
138
|
+
### Return type
|
139
|
+
|
140
|
+
nil (empty response body)
|
141
|
+
|
142
|
+
### Authorization
|
143
|
+
|
144
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
145
|
+
|
146
|
+
### HTTP request headers
|
147
|
+
|
148
|
+
- **Content-Type**: application/json
|
149
|
+
- **Accept**: application/json
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
# **crm_tasks_id_get**
|
154
|
+
> Task crm_tasks_id_get(id)
|
155
|
+
|
156
|
+
Get a task
|
157
|
+
|
158
|
+
### Example
|
159
|
+
```ruby
|
160
|
+
# load the gem
|
161
|
+
require 'sib-api-v3-sdk'
|
162
|
+
# setup authorization
|
163
|
+
SibApiV3Sdk.configure do |config|
|
164
|
+
# Configure API key authorization: api-key
|
165
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
166
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
167
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
168
|
+
|
169
|
+
# Configure API key authorization: partner-key
|
170
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
171
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
172
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
173
|
+
end
|
174
|
+
|
175
|
+
api_instance = SibApiV3Sdk::TasksApi.new
|
176
|
+
|
177
|
+
id = 'id_example' # String |
|
178
|
+
|
179
|
+
|
180
|
+
begin
|
181
|
+
#Get a task
|
182
|
+
result = api_instance.crm_tasks_id_get(id)
|
183
|
+
p result
|
184
|
+
rescue SibApiV3Sdk::ApiError => e
|
185
|
+
puts "Exception when calling TasksApi->crm_tasks_id_get: #{e}"
|
186
|
+
end
|
187
|
+
```
|
188
|
+
|
189
|
+
### Parameters
|
190
|
+
|
191
|
+
Name | Type | Description | Notes
|
192
|
+
------------- | ------------- | ------------- | -------------
|
193
|
+
**id** | **String**| |
|
194
|
+
|
195
|
+
### Return type
|
196
|
+
|
197
|
+
[**Task**](Task.md)
|
198
|
+
|
199
|
+
### Authorization
|
200
|
+
|
201
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
202
|
+
|
203
|
+
### HTTP request headers
|
204
|
+
|
205
|
+
- **Content-Type**: application/json
|
206
|
+
- **Accept**: application/json
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
# **crm_tasks_id_patch**
|
211
|
+
> crm_tasks_id_patch(id, body)
|
212
|
+
|
213
|
+
Update a task
|
214
|
+
|
215
|
+
### Example
|
216
|
+
```ruby
|
217
|
+
# load the gem
|
218
|
+
require 'sib-api-v3-sdk'
|
219
|
+
# setup authorization
|
220
|
+
SibApiV3Sdk.configure do |config|
|
221
|
+
# Configure API key authorization: api-key
|
222
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
223
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
224
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
225
|
+
|
226
|
+
# Configure API key authorization: partner-key
|
227
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
228
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
229
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
230
|
+
end
|
231
|
+
|
232
|
+
api_instance = SibApiV3Sdk::TasksApi.new
|
233
|
+
|
234
|
+
id = 'id_example' # String |
|
235
|
+
|
236
|
+
body = SibApiV3Sdk::Body7.new # Body7 | Updated task details.
|
237
|
+
|
238
|
+
|
239
|
+
begin
|
240
|
+
#Update a task
|
241
|
+
api_instance.crm_tasks_id_patch(id, body)
|
242
|
+
rescue SibApiV3Sdk::ApiError => e
|
243
|
+
puts "Exception when calling TasksApi->crm_tasks_id_patch: #{e}"
|
244
|
+
end
|
245
|
+
```
|
246
|
+
|
247
|
+
### Parameters
|
248
|
+
|
249
|
+
Name | Type | Description | Notes
|
250
|
+
------------- | ------------- | ------------- | -------------
|
251
|
+
**id** | **String**| |
|
252
|
+
**body** | [**Body7**](Body7.md)| Updated task details. |
|
253
|
+
|
254
|
+
### Return type
|
255
|
+
|
256
|
+
nil (empty response body)
|
257
|
+
|
258
|
+
### Authorization
|
259
|
+
|
260
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
261
|
+
|
262
|
+
### HTTP request headers
|
263
|
+
|
264
|
+
- **Content-Type**: application/json
|
265
|
+
- **Accept**: application/json
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
# **crm_tasks_post**
|
270
|
+
> InlineResponse2011 crm_tasks_post(body)
|
271
|
+
|
272
|
+
Create a task
|
273
|
+
|
274
|
+
### Example
|
275
|
+
```ruby
|
276
|
+
# load the gem
|
277
|
+
require 'sib-api-v3-sdk'
|
278
|
+
# setup authorization
|
279
|
+
SibApiV3Sdk.configure do |config|
|
280
|
+
# Configure API key authorization: api-key
|
281
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
282
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
283
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
284
|
+
|
285
|
+
# Configure API key authorization: partner-key
|
286
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
287
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
288
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
289
|
+
end
|
290
|
+
|
291
|
+
api_instance = SibApiV3Sdk::TasksApi.new
|
292
|
+
|
293
|
+
body = SibApiV3Sdk::Body6.new # Body6 | Task name.
|
294
|
+
|
295
|
+
|
296
|
+
begin
|
297
|
+
#Create a task
|
298
|
+
result = api_instance.crm_tasks_post(body)
|
299
|
+
p result
|
300
|
+
rescue SibApiV3Sdk::ApiError => e
|
301
|
+
puts "Exception when calling TasksApi->crm_tasks_post: #{e}"
|
302
|
+
end
|
303
|
+
```
|
304
|
+
|
305
|
+
### Parameters
|
306
|
+
|
307
|
+
Name | Type | Description | Notes
|
308
|
+
------------- | ------------- | ------------- | -------------
|
309
|
+
**body** | [**Body6**](Body6.md)| Task name. |
|
310
|
+
|
311
|
+
### Return type
|
312
|
+
|
313
|
+
[**InlineResponse2011**](InlineResponse2011.md)
|
314
|
+
|
315
|
+
### Authorization
|
316
|
+
|
317
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
318
|
+
|
319
|
+
### HTTP request headers
|
320
|
+
|
321
|
+
- **Content-Type**: application/json
|
322
|
+
- **Accept**: application/json
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
# **crm_tasktypes_get**
|
327
|
+
> TaskTypes crm_tasktypes_get
|
328
|
+
|
329
|
+
Get all task types
|
330
|
+
|
331
|
+
### Example
|
332
|
+
```ruby
|
333
|
+
# load the gem
|
334
|
+
require 'sib-api-v3-sdk'
|
335
|
+
# setup authorization
|
336
|
+
SibApiV3Sdk.configure do |config|
|
337
|
+
# Configure API key authorization: api-key
|
338
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
339
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
340
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
341
|
+
|
342
|
+
# Configure API key authorization: partner-key
|
343
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
344
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
345
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
346
|
+
end
|
347
|
+
|
348
|
+
api_instance = SibApiV3Sdk::TasksApi.new
|
349
|
+
|
350
|
+
begin
|
351
|
+
#Get all task types
|
352
|
+
result = api_instance.crm_tasktypes_get
|
353
|
+
p result
|
354
|
+
rescue SibApiV3Sdk::ApiError => e
|
355
|
+
puts "Exception when calling TasksApi->crm_tasktypes_get: #{e}"
|
356
|
+
end
|
357
|
+
```
|
358
|
+
|
359
|
+
### Parameters
|
360
|
+
This endpoint does not need any parameter.
|
361
|
+
|
362
|
+
### Return type
|
363
|
+
|
364
|
+
[**TaskTypes**](TaskTypes.md)
|
365
|
+
|
366
|
+
### Authorization
|
367
|
+
|
368
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
369
|
+
|
370
|
+
### HTTP request headers
|
371
|
+
|
372
|
+
- **Content-Type**: application/json
|
373
|
+
- **Accept**: application/json
|
374
|
+
|
375
|
+
|
376
|
+
|
@@ -8,17 +8,19 @@ Method | HTTP request | Description
|
|
8
8
|
[**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
|
9
9
|
[**delete_blocked_domain**](TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
|
10
10
|
[**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
11
|
+
[**delete_scheduled_email_by_id**](TransactionalEmailsApi.md#delete_scheduled_email_by_id) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
|
11
12
|
[**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
12
13
|
[**get_aggregated_smtp_report**](TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
13
14
|
[**get_blocked_domains**](TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
|
14
15
|
[**get_email_event_report**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
16
|
+
[**get_scheduled_email_by_batch_id**](TransactionalEmailsApi.md#get_scheduled_email_by_batch_id) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
|
17
|
+
[**get_scheduled_email_by_message_id**](TransactionalEmailsApi.md#get_scheduled_email_by_message_id) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
|
15
18
|
[**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
16
19
|
[**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
|
17
20
|
[**get_smtp_templates**](TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
|
18
21
|
[**get_transac_blocked_contacts**](TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
19
22
|
[**get_transac_email_content**](TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
20
23
|
[**get_transac_emails_list**](TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
21
|
-
[**send_template**](TransactionalEmailsApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
|
22
24
|
[**send_test_template**](TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
23
25
|
[**send_transac_email**](TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
24
26
|
[**smtp_blocked_contacts_email_delete**](TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
@@ -258,6 +260,64 @@ nil (empty response body)
|
|
258
260
|
|
259
261
|
|
260
262
|
|
263
|
+
# **delete_scheduled_email_by_id**
|
264
|
+
> delete_scheduled_email_by_id(identifier)
|
265
|
+
|
266
|
+
Delete scheduled emails by batchId or messageId
|
267
|
+
|
268
|
+
Delete scheduled batch of emails by batchId or single scheduled email by messageId
|
269
|
+
|
270
|
+
### Example
|
271
|
+
```ruby
|
272
|
+
# load the gem
|
273
|
+
require 'sib-api-v3-sdk'
|
274
|
+
# setup authorization
|
275
|
+
SibApiV3Sdk.configure do |config|
|
276
|
+
# Configure API key authorization: api-key
|
277
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
278
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
279
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
280
|
+
|
281
|
+
# Configure API key authorization: partner-key
|
282
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
283
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
284
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
285
|
+
end
|
286
|
+
|
287
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
288
|
+
|
289
|
+
identifier = 'identifier_example' # String | The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.
|
290
|
+
|
291
|
+
|
292
|
+
begin
|
293
|
+
#Delete scheduled emails by batchId or messageId
|
294
|
+
api_instance.delete_scheduled_email_by_id(identifier)
|
295
|
+
rescue SibApiV3Sdk::ApiError => e
|
296
|
+
puts "Exception when calling TransactionalEmailsApi->delete_scheduled_email_by_id: #{e}"
|
297
|
+
end
|
298
|
+
```
|
299
|
+
|
300
|
+
### Parameters
|
301
|
+
|
302
|
+
Name | Type | Description | Notes
|
303
|
+
------------- | ------------- | ------------- | -------------
|
304
|
+
**identifier** | **String**| The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. |
|
305
|
+
|
306
|
+
### Return type
|
307
|
+
|
308
|
+
nil (empty response body)
|
309
|
+
|
310
|
+
### Authorization
|
311
|
+
|
312
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
313
|
+
|
314
|
+
### HTTP request headers
|
315
|
+
|
316
|
+
- **Content-Type**: application/json
|
317
|
+
- **Accept**: application/json
|
318
|
+
|
319
|
+
|
320
|
+
|
261
321
|
# **delete_smtp_template**
|
262
322
|
> delete_smtp_template(template_id)
|
263
323
|
|
@@ -319,6 +379,8 @@ nil (empty response body)
|
|
319
379
|
|
320
380
|
Get your transactional email activity aggregated over a period of time
|
321
381
|
|
382
|
+
This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
383
|
+
|
322
384
|
### Example
|
323
385
|
```ruby
|
324
386
|
# load the gem
|
@@ -436,6 +498,8 @@ This endpoint does not need any parameter.
|
|
436
498
|
|
437
499
|
Get all your transactional email activity (unaggregated events)
|
438
500
|
|
501
|
+
This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
|
502
|
+
|
439
503
|
### Example
|
440
504
|
```ruby
|
441
505
|
# load the gem
|
@@ -509,6 +573,144 @@ Name | Type | Description | Notes
|
|
509
573
|
|
510
574
|
|
511
575
|
|
576
|
+
# **get_scheduled_email_by_batch_id**
|
577
|
+
> GetScheduledEmailByBatchId get_scheduled_email_by_batch_id(batch_id, opts)
|
578
|
+
|
579
|
+
Fetch scheduled emails by batchId
|
580
|
+
|
581
|
+
Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
|
582
|
+
|
583
|
+
### Example
|
584
|
+
```ruby
|
585
|
+
# load the gem
|
586
|
+
require 'sib-api-v3-sdk'
|
587
|
+
# setup authorization
|
588
|
+
SibApiV3Sdk.configure do |config|
|
589
|
+
# Configure API key authorization: api-key
|
590
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
591
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
592
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
593
|
+
|
594
|
+
# Configure API key authorization: partner-key
|
595
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
596
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
597
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
598
|
+
end
|
599
|
+
|
600
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
601
|
+
|
602
|
+
batch_id = 'batch_id_example' # String | The batchId of scheduled emails batch (Should be a valid UUIDv4)
|
603
|
+
|
604
|
+
opts = {
|
605
|
+
start_date: Date.parse('2013-10-20'), # Date | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
606
|
+
end_date: Date.parse('2013-10-20'), # Date | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
607
|
+
sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
608
|
+
status: 'status_example', # String | Filter the records by `status` of the scheduled email batch or message.
|
609
|
+
limit: 100, # Integer | Number of documents returned per page
|
610
|
+
offset: 0 # Integer | Index of the first document on the page
|
611
|
+
}
|
612
|
+
|
613
|
+
begin
|
614
|
+
#Fetch scheduled emails by batchId
|
615
|
+
result = api_instance.get_scheduled_email_by_batch_id(batch_id, opts)
|
616
|
+
p result
|
617
|
+
rescue SibApiV3Sdk::ApiError => e
|
618
|
+
puts "Exception when calling TransactionalEmailsApi->get_scheduled_email_by_batch_id: #{e}"
|
619
|
+
end
|
620
|
+
```
|
621
|
+
|
622
|
+
### Parameters
|
623
|
+
|
624
|
+
Name | Type | Description | Notes
|
625
|
+
------------- | ------------- | ------------- | -------------
|
626
|
+
**batch_id** | **String**| The batchId of scheduled emails batch (Should be a valid UUIDv4) |
|
627
|
+
**start_date** | **Date**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
|
628
|
+
**end_date** | **Date**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
629
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
630
|
+
**status** | **String**| Filter the records by `status` of the scheduled email batch or message. | [optional]
|
631
|
+
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 100]
|
632
|
+
**offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
|
633
|
+
|
634
|
+
### Return type
|
635
|
+
|
636
|
+
[**GetScheduledEmailByBatchId**](GetScheduledEmailByBatchId.md)
|
637
|
+
|
638
|
+
### Authorization
|
639
|
+
|
640
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
641
|
+
|
642
|
+
### HTTP request headers
|
643
|
+
|
644
|
+
- **Content-Type**: application/json
|
645
|
+
- **Accept**: application/json
|
646
|
+
|
647
|
+
|
648
|
+
|
649
|
+
# **get_scheduled_email_by_message_id**
|
650
|
+
> GetScheduledEmailByMessageId get_scheduled_email_by_message_id(message_id, opts)
|
651
|
+
|
652
|
+
Fetch scheduled email by messageId
|
653
|
+
|
654
|
+
Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
|
655
|
+
|
656
|
+
### Example
|
657
|
+
```ruby
|
658
|
+
# load the gem
|
659
|
+
require 'sib-api-v3-sdk'
|
660
|
+
# setup authorization
|
661
|
+
SibApiV3Sdk.configure do |config|
|
662
|
+
# Configure API key authorization: api-key
|
663
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
664
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
665
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
666
|
+
|
667
|
+
# Configure API key authorization: partner-key
|
668
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
669
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
670
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
671
|
+
end
|
672
|
+
|
673
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
674
|
+
|
675
|
+
message_id = 'message_id_example' # String | The messageId of scheduled email
|
676
|
+
|
677
|
+
opts = {
|
678
|
+
start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
|
679
|
+
end_date: Date.parse('2013-10-20') # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
|
680
|
+
}
|
681
|
+
|
682
|
+
begin
|
683
|
+
#Fetch scheduled email by messageId
|
684
|
+
result = api_instance.get_scheduled_email_by_message_id(message_id, opts)
|
685
|
+
p result
|
686
|
+
rescue SibApiV3Sdk::ApiError => e
|
687
|
+
puts "Exception when calling TransactionalEmailsApi->get_scheduled_email_by_message_id: #{e}"
|
688
|
+
end
|
689
|
+
```
|
690
|
+
|
691
|
+
### Parameters
|
692
|
+
|
693
|
+
Name | Type | Description | Notes
|
694
|
+
------------- | ------------- | ------------- | -------------
|
695
|
+
**message_id** | **String**| The messageId of scheduled email |
|
696
|
+
**start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
|
697
|
+
**end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
|
698
|
+
|
699
|
+
### Return type
|
700
|
+
|
701
|
+
[**GetScheduledEmailByMessageId**](GetScheduledEmailByMessageId.md)
|
702
|
+
|
703
|
+
### Authorization
|
704
|
+
|
705
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
706
|
+
|
707
|
+
### HTTP request headers
|
708
|
+
|
709
|
+
- **Content-Type**: application/json
|
710
|
+
- **Accept**: application/json
|
711
|
+
|
712
|
+
|
713
|
+
|
512
714
|
# **get_smtp_report**
|
513
715
|
> GetReports get_smtp_report(opts)
|
514
716
|
|
@@ -899,68 +1101,6 @@ Name | Type | Description | Notes
|
|
899
1101
|
|
900
1102
|
|
901
1103
|
|
902
|
-
# **send_template**
|
903
|
-
> SendTemplateEmail send_template(template_id, send_email)
|
904
|
-
|
905
|
-
Send a template
|
906
|
-
|
907
|
-
This endpoint is deprecated. Prefer v3/smtp/email instead.
|
908
|
-
|
909
|
-
### Example
|
910
|
-
```ruby
|
911
|
-
# load the gem
|
912
|
-
require 'sib-api-v3-sdk'
|
913
|
-
# setup authorization
|
914
|
-
SibApiV3Sdk.configure do |config|
|
915
|
-
# Configure API key authorization: api-key
|
916
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
917
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
918
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
919
|
-
|
920
|
-
# Configure API key authorization: partner-key
|
921
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
922
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
923
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
924
|
-
end
|
925
|
-
|
926
|
-
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
927
|
-
|
928
|
-
template_id = 789 # Integer | Id of the template
|
929
|
-
|
930
|
-
send_email = SibApiV3Sdk::SendEmail.new # SendEmail |
|
931
|
-
|
932
|
-
|
933
|
-
begin
|
934
|
-
#Send a template
|
935
|
-
result = api_instance.send_template(template_id, send_email)
|
936
|
-
p result
|
937
|
-
rescue SibApiV3Sdk::ApiError => e
|
938
|
-
puts "Exception when calling TransactionalEmailsApi->send_template: #{e}"
|
939
|
-
end
|
940
|
-
```
|
941
|
-
|
942
|
-
### Parameters
|
943
|
-
|
944
|
-
Name | Type | Description | Notes
|
945
|
-
------------- | ------------- | ------------- | -------------
|
946
|
-
**template_id** | **Integer**| Id of the template |
|
947
|
-
**send_email** | [**SendEmail**](SendEmail.md)| |
|
948
|
-
|
949
|
-
### Return type
|
950
|
-
|
951
|
-
[**SendTemplateEmail**](SendTemplateEmail.md)
|
952
|
-
|
953
|
-
### Authorization
|
954
|
-
|
955
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
956
|
-
|
957
|
-
### HTTP request headers
|
958
|
-
|
959
|
-
- **Content-Type**: application/json
|
960
|
-
- **Accept**: application/json
|
961
|
-
|
962
|
-
|
963
|
-
|
964
1104
|
# **send_test_template**
|
965
1105
|
> send_test_template(template_id, send_test_email)
|
966
1106
|
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# SibApiV3Sdk::UpdateBatchContacts
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**contacts** | [**Array<UpdateBatchContactsContacts>**](UpdateBatchContactsContacts.md) | List of contacts to be updated | [optional]
|
7
|
+
|
8
|
+
|