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
@@ -0,0 +1,542 @@
|
|
1
|
+
# SibApiV3Sdk::ConversationsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.sendinblue.com/v3*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**conversations_agent_online_ping_post**](ConversationsApi.md#conversations_agent_online_ping_post) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes
|
8
|
+
[**conversations_messages_id_delete**](ConversationsApi.md#conversations_messages_id_delete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent
|
9
|
+
[**conversations_messages_id_get**](ConversationsApi.md#conversations_messages_id_get) | **GET** /conversations/messages/{id} | Get a message
|
10
|
+
[**conversations_messages_id_put**](ConversationsApi.md#conversations_messages_id_put) | **PUT** /conversations/messages/{id} | Update a message sent by an agent
|
11
|
+
[**conversations_messages_post**](ConversationsApi.md#conversations_messages_post) | **POST** /conversations/messages | Send a message as an agent
|
12
|
+
[**conversations_pushed_messages_id_delete**](ConversationsApi.md#conversations_pushed_messages_id_delete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message
|
13
|
+
[**conversations_pushed_messages_id_get**](ConversationsApi.md#conversations_pushed_messages_id_get) | **GET** /conversations/pushedMessages/{id} | Get an automated message
|
14
|
+
[**conversations_pushed_messages_id_put**](ConversationsApi.md#conversations_pushed_messages_id_put) | **PUT** /conversations/pushedMessages/{id} | Update an automated message
|
15
|
+
[**conversations_pushed_messages_post**](ConversationsApi.md#conversations_pushed_messages_post) | **POST** /conversations/pushedMessages | Send an automated message to a visitor
|
16
|
+
|
17
|
+
|
18
|
+
# **conversations_agent_online_ping_post**
|
19
|
+
> conversations_agent_online_ping_post(body)
|
20
|
+
|
21
|
+
Sets agent’s status to online for 2-3 minutes
|
22
|
+
|
23
|
+
We recommend pinging this endpoint every minute for as long as the agent has to be considered online.
|
24
|
+
|
25
|
+
### Example
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'sib-api-v3-sdk'
|
29
|
+
# setup authorization
|
30
|
+
SibApiV3Sdk.configure do |config|
|
31
|
+
# Configure API key authorization: api-key
|
32
|
+
config.api_key['api-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['api-key'] = 'Bearer'
|
35
|
+
|
36
|
+
# Configure API key authorization: partner-key
|
37
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
38
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
39
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
40
|
+
end
|
41
|
+
|
42
|
+
api_instance = SibApiV3Sdk::ConversationsApi.new
|
43
|
+
|
44
|
+
body = SibApiV3Sdk::Body12.new # Body12 | Agent fields.
|
45
|
+
|
46
|
+
|
47
|
+
begin
|
48
|
+
#Sets agent’s status to online for 2-3 minutes
|
49
|
+
api_instance.conversations_agent_online_ping_post(body)
|
50
|
+
rescue SibApiV3Sdk::ApiError => e
|
51
|
+
puts "Exception when calling ConversationsApi->conversations_agent_online_ping_post: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
Name | Type | Description | Notes
|
58
|
+
------------- | ------------- | ------------- | -------------
|
59
|
+
**body** | [**Body12**](Body12.md)| Agent fields. |
|
60
|
+
|
61
|
+
### Return type
|
62
|
+
|
63
|
+
nil (empty response body)
|
64
|
+
|
65
|
+
### Authorization
|
66
|
+
|
67
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
68
|
+
|
69
|
+
### HTTP request headers
|
70
|
+
|
71
|
+
- **Content-Type**: application/json
|
72
|
+
- **Accept**: application/json
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
# **conversations_messages_id_delete**
|
77
|
+
> conversations_messages_id_delete(id)
|
78
|
+
|
79
|
+
Delete a message sent by an agent
|
80
|
+
|
81
|
+
Only agents’ messages can be deleted.
|
82
|
+
|
83
|
+
### Example
|
84
|
+
```ruby
|
85
|
+
# load the gem
|
86
|
+
require 'sib-api-v3-sdk'
|
87
|
+
# setup authorization
|
88
|
+
SibApiV3Sdk.configure do |config|
|
89
|
+
# Configure API key authorization: api-key
|
90
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
91
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
92
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
93
|
+
|
94
|
+
# Configure API key authorization: partner-key
|
95
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
96
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
97
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
98
|
+
end
|
99
|
+
|
100
|
+
api_instance = SibApiV3Sdk::ConversationsApi.new
|
101
|
+
|
102
|
+
id = 'id_example' # String | ID of the message
|
103
|
+
|
104
|
+
|
105
|
+
begin
|
106
|
+
#Delete a message sent by an agent
|
107
|
+
api_instance.conversations_messages_id_delete(id)
|
108
|
+
rescue SibApiV3Sdk::ApiError => e
|
109
|
+
puts "Exception when calling ConversationsApi->conversations_messages_id_delete: #{e}"
|
110
|
+
end
|
111
|
+
```
|
112
|
+
|
113
|
+
### Parameters
|
114
|
+
|
115
|
+
Name | Type | Description | Notes
|
116
|
+
------------- | ------------- | ------------- | -------------
|
117
|
+
**id** | **String**| ID of the message |
|
118
|
+
|
119
|
+
### Return type
|
120
|
+
|
121
|
+
nil (empty response body)
|
122
|
+
|
123
|
+
### Authorization
|
124
|
+
|
125
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
126
|
+
|
127
|
+
### HTTP request headers
|
128
|
+
|
129
|
+
- **Content-Type**: application/json
|
130
|
+
- **Accept**: application/json
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
# **conversations_messages_id_get**
|
135
|
+
> ConversationsMessage conversations_messages_id_get(id)
|
136
|
+
|
137
|
+
Get a message
|
138
|
+
|
139
|
+
### Example
|
140
|
+
```ruby
|
141
|
+
# load the gem
|
142
|
+
require 'sib-api-v3-sdk'
|
143
|
+
# setup authorization
|
144
|
+
SibApiV3Sdk.configure do |config|
|
145
|
+
# Configure API key authorization: api-key
|
146
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
147
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
148
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
149
|
+
|
150
|
+
# Configure API key authorization: partner-key
|
151
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
152
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
153
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
154
|
+
end
|
155
|
+
|
156
|
+
api_instance = SibApiV3Sdk::ConversationsApi.new
|
157
|
+
|
158
|
+
id = 'id_example' # String | ID of the message
|
159
|
+
|
160
|
+
|
161
|
+
begin
|
162
|
+
#Get a message
|
163
|
+
result = api_instance.conversations_messages_id_get(id)
|
164
|
+
p result
|
165
|
+
rescue SibApiV3Sdk::ApiError => e
|
166
|
+
puts "Exception when calling ConversationsApi->conversations_messages_id_get: #{e}"
|
167
|
+
end
|
168
|
+
```
|
169
|
+
|
170
|
+
### Parameters
|
171
|
+
|
172
|
+
Name | Type | Description | Notes
|
173
|
+
------------- | ------------- | ------------- | -------------
|
174
|
+
**id** | **String**| ID of the message |
|
175
|
+
|
176
|
+
### Return type
|
177
|
+
|
178
|
+
[**ConversationsMessage**](ConversationsMessage.md)
|
179
|
+
|
180
|
+
### Authorization
|
181
|
+
|
182
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
183
|
+
|
184
|
+
### HTTP request headers
|
185
|
+
|
186
|
+
- **Content-Type**: application/json
|
187
|
+
- **Accept**: application/json
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
# **conversations_messages_id_put**
|
192
|
+
> ConversationsMessage conversations_messages_id_put(id, opts)
|
193
|
+
|
194
|
+
Update a message sent by an agent
|
195
|
+
|
196
|
+
Only agents’ messages can be edited.
|
197
|
+
|
198
|
+
### Example
|
199
|
+
```ruby
|
200
|
+
# load the gem
|
201
|
+
require 'sib-api-v3-sdk'
|
202
|
+
# setup authorization
|
203
|
+
SibApiV3Sdk.configure do |config|
|
204
|
+
# Configure API key authorization: api-key
|
205
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
206
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
207
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
208
|
+
|
209
|
+
# Configure API key authorization: partner-key
|
210
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
211
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
212
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
213
|
+
end
|
214
|
+
|
215
|
+
api_instance = SibApiV3Sdk::ConversationsApi.new
|
216
|
+
|
217
|
+
id = 'id_example' # String | ID of the message
|
218
|
+
|
219
|
+
opts = {
|
220
|
+
body: SibApiV3Sdk::Body9.new # Body9 |
|
221
|
+
}
|
222
|
+
|
223
|
+
begin
|
224
|
+
#Update a message sent by an agent
|
225
|
+
result = api_instance.conversations_messages_id_put(id, opts)
|
226
|
+
p result
|
227
|
+
rescue SibApiV3Sdk::ApiError => e
|
228
|
+
puts "Exception when calling ConversationsApi->conversations_messages_id_put: #{e}"
|
229
|
+
end
|
230
|
+
```
|
231
|
+
|
232
|
+
### Parameters
|
233
|
+
|
234
|
+
Name | Type | Description | Notes
|
235
|
+
------------- | ------------- | ------------- | -------------
|
236
|
+
**id** | **String**| ID of the message |
|
237
|
+
**body** | [**Body9**](Body9.md)| | [optional]
|
238
|
+
|
239
|
+
### Return type
|
240
|
+
|
241
|
+
[**ConversationsMessage**](ConversationsMessage.md)
|
242
|
+
|
243
|
+
### Authorization
|
244
|
+
|
245
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
246
|
+
|
247
|
+
### HTTP request headers
|
248
|
+
|
249
|
+
- **Content-Type**: application/json
|
250
|
+
- **Accept**: application/json
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
# **conversations_messages_post**
|
255
|
+
> ConversationsMessage conversations_messages_post(body)
|
256
|
+
|
257
|
+
Send a message as an agent
|
258
|
+
|
259
|
+
### Example
|
260
|
+
```ruby
|
261
|
+
# load the gem
|
262
|
+
require 'sib-api-v3-sdk'
|
263
|
+
# setup authorization
|
264
|
+
SibApiV3Sdk.configure do |config|
|
265
|
+
# Configure API key authorization: api-key
|
266
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
267
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
268
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
269
|
+
|
270
|
+
# Configure API key authorization: partner-key
|
271
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
272
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
273
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
274
|
+
end
|
275
|
+
|
276
|
+
api_instance = SibApiV3Sdk::ConversationsApi.new
|
277
|
+
|
278
|
+
body = SibApiV3Sdk::Body8.new # Body8 | Message fields.
|
279
|
+
|
280
|
+
|
281
|
+
begin
|
282
|
+
#Send a message as an agent
|
283
|
+
result = api_instance.conversations_messages_post(body)
|
284
|
+
p result
|
285
|
+
rescue SibApiV3Sdk::ApiError => e
|
286
|
+
puts "Exception when calling ConversationsApi->conversations_messages_post: #{e}"
|
287
|
+
end
|
288
|
+
```
|
289
|
+
|
290
|
+
### Parameters
|
291
|
+
|
292
|
+
Name | Type | Description | Notes
|
293
|
+
------------- | ------------- | ------------- | -------------
|
294
|
+
**body** | [**Body8**](Body8.md)| Message fields. |
|
295
|
+
|
296
|
+
### Return type
|
297
|
+
|
298
|
+
[**ConversationsMessage**](ConversationsMessage.md)
|
299
|
+
|
300
|
+
### Authorization
|
301
|
+
|
302
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
303
|
+
|
304
|
+
### HTTP request headers
|
305
|
+
|
306
|
+
- **Content-Type**: application/json
|
307
|
+
- **Accept**: application/json
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
# **conversations_pushed_messages_id_delete**
|
312
|
+
> conversations_pushed_messages_id_delete(id)
|
313
|
+
|
314
|
+
Delete an automated message
|
315
|
+
|
316
|
+
### Example
|
317
|
+
```ruby
|
318
|
+
# load the gem
|
319
|
+
require 'sib-api-v3-sdk'
|
320
|
+
# setup authorization
|
321
|
+
SibApiV3Sdk.configure do |config|
|
322
|
+
# Configure API key authorization: api-key
|
323
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
324
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
325
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
326
|
+
|
327
|
+
# Configure API key authorization: partner-key
|
328
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
329
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
330
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
331
|
+
end
|
332
|
+
|
333
|
+
api_instance = SibApiV3Sdk::ConversationsApi.new
|
334
|
+
|
335
|
+
id = 'id_example' # String | ID of the message
|
336
|
+
|
337
|
+
|
338
|
+
begin
|
339
|
+
#Delete an automated message
|
340
|
+
api_instance.conversations_pushed_messages_id_delete(id)
|
341
|
+
rescue SibApiV3Sdk::ApiError => e
|
342
|
+
puts "Exception when calling ConversationsApi->conversations_pushed_messages_id_delete: #{e}"
|
343
|
+
end
|
344
|
+
```
|
345
|
+
|
346
|
+
### Parameters
|
347
|
+
|
348
|
+
Name | Type | Description | Notes
|
349
|
+
------------- | ------------- | ------------- | -------------
|
350
|
+
**id** | **String**| ID of the message |
|
351
|
+
|
352
|
+
### Return type
|
353
|
+
|
354
|
+
nil (empty response body)
|
355
|
+
|
356
|
+
### Authorization
|
357
|
+
|
358
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
359
|
+
|
360
|
+
### HTTP request headers
|
361
|
+
|
362
|
+
- **Content-Type**: application/json
|
363
|
+
- **Accept**: application/json
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
# **conversations_pushed_messages_id_get**
|
368
|
+
> ConversationsMessage conversations_pushed_messages_id_get(id)
|
369
|
+
|
370
|
+
Get an automated message
|
371
|
+
|
372
|
+
### Example
|
373
|
+
```ruby
|
374
|
+
# load the gem
|
375
|
+
require 'sib-api-v3-sdk'
|
376
|
+
# setup authorization
|
377
|
+
SibApiV3Sdk.configure do |config|
|
378
|
+
# Configure API key authorization: api-key
|
379
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
380
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
381
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
382
|
+
|
383
|
+
# Configure API key authorization: partner-key
|
384
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
385
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
386
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
387
|
+
end
|
388
|
+
|
389
|
+
api_instance = SibApiV3Sdk::ConversationsApi.new
|
390
|
+
|
391
|
+
id = 'id_example' # String | ID of the message sent previously
|
392
|
+
|
393
|
+
|
394
|
+
begin
|
395
|
+
#Get an automated message
|
396
|
+
result = api_instance.conversations_pushed_messages_id_get(id)
|
397
|
+
p result
|
398
|
+
rescue SibApiV3Sdk::ApiError => e
|
399
|
+
puts "Exception when calling ConversationsApi->conversations_pushed_messages_id_get: #{e}"
|
400
|
+
end
|
401
|
+
```
|
402
|
+
|
403
|
+
### Parameters
|
404
|
+
|
405
|
+
Name | Type | Description | Notes
|
406
|
+
------------- | ------------- | ------------- | -------------
|
407
|
+
**id** | **String**| ID of the message sent previously |
|
408
|
+
|
409
|
+
### Return type
|
410
|
+
|
411
|
+
[**ConversationsMessage**](ConversationsMessage.md)
|
412
|
+
|
413
|
+
### Authorization
|
414
|
+
|
415
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
416
|
+
|
417
|
+
### HTTP request headers
|
418
|
+
|
419
|
+
- **Content-Type**: application/json
|
420
|
+
- **Accept**: application/json
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
# **conversations_pushed_messages_id_put**
|
425
|
+
> ConversationsMessage conversations_pushed_messages_id_put(id, body)
|
426
|
+
|
427
|
+
Update an automated message
|
428
|
+
|
429
|
+
### Example
|
430
|
+
```ruby
|
431
|
+
# load the gem
|
432
|
+
require 'sib-api-v3-sdk'
|
433
|
+
# setup authorization
|
434
|
+
SibApiV3Sdk.configure do |config|
|
435
|
+
# Configure API key authorization: api-key
|
436
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
437
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
438
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
439
|
+
|
440
|
+
# Configure API key authorization: partner-key
|
441
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
442
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
443
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
444
|
+
end
|
445
|
+
|
446
|
+
api_instance = SibApiV3Sdk::ConversationsApi.new
|
447
|
+
|
448
|
+
id = 'id_example' # String | ID of the message
|
449
|
+
|
450
|
+
body = SibApiV3Sdk::Body11.new # Body11 |
|
451
|
+
|
452
|
+
|
453
|
+
begin
|
454
|
+
#Update an automated message
|
455
|
+
result = api_instance.conversations_pushed_messages_id_put(id, body)
|
456
|
+
p result
|
457
|
+
rescue SibApiV3Sdk::ApiError => e
|
458
|
+
puts "Exception when calling ConversationsApi->conversations_pushed_messages_id_put: #{e}"
|
459
|
+
end
|
460
|
+
```
|
461
|
+
|
462
|
+
### Parameters
|
463
|
+
|
464
|
+
Name | Type | Description | Notes
|
465
|
+
------------- | ------------- | ------------- | -------------
|
466
|
+
**id** | **String**| ID of the message |
|
467
|
+
**body** | [**Body11**](Body11.md)| |
|
468
|
+
|
469
|
+
### Return type
|
470
|
+
|
471
|
+
[**ConversationsMessage**](ConversationsMessage.md)
|
472
|
+
|
473
|
+
### Authorization
|
474
|
+
|
475
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
476
|
+
|
477
|
+
### HTTP request headers
|
478
|
+
|
479
|
+
- **Content-Type**: application/json
|
480
|
+
- **Accept**: application/json
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
# **conversations_pushed_messages_post**
|
485
|
+
> ConversationsMessage conversations_pushed_messages_post(body)
|
486
|
+
|
487
|
+
Send an automated message to a visitor
|
488
|
+
|
489
|
+
Example of automated messages: order status, announce new features in your web app, etc.
|
490
|
+
|
491
|
+
### Example
|
492
|
+
```ruby
|
493
|
+
# load the gem
|
494
|
+
require 'sib-api-v3-sdk'
|
495
|
+
# setup authorization
|
496
|
+
SibApiV3Sdk.configure do |config|
|
497
|
+
# Configure API key authorization: api-key
|
498
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
499
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
500
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
501
|
+
|
502
|
+
# Configure API key authorization: partner-key
|
503
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
504
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
505
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
506
|
+
end
|
507
|
+
|
508
|
+
api_instance = SibApiV3Sdk::ConversationsApi.new
|
509
|
+
|
510
|
+
body = SibApiV3Sdk::Body10.new # Body10 |
|
511
|
+
|
512
|
+
|
513
|
+
begin
|
514
|
+
#Send an automated message to a visitor
|
515
|
+
result = api_instance.conversations_pushed_messages_post(body)
|
516
|
+
p result
|
517
|
+
rescue SibApiV3Sdk::ApiError => e
|
518
|
+
puts "Exception when calling ConversationsApi->conversations_pushed_messages_post: #{e}"
|
519
|
+
end
|
520
|
+
```
|
521
|
+
|
522
|
+
### Parameters
|
523
|
+
|
524
|
+
Name | Type | Description | Notes
|
525
|
+
------------- | ------------- | ------------- | -------------
|
526
|
+
**body** | [**Body10**](Body10.md)| |
|
527
|
+
|
528
|
+
### Return type
|
529
|
+
|
530
|
+
[**ConversationsMessage**](ConversationsMessage.md)
|
531
|
+
|
532
|
+
### Authorization
|
533
|
+
|
534
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
535
|
+
|
536
|
+
### HTTP request headers
|
537
|
+
|
538
|
+
- **Content-Type**: application/json
|
539
|
+
- **Accept**: application/json
|
540
|
+
|
541
|
+
|
542
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SibApiV3Sdk::ConversationsMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Message ID. It can be used for further manipulations with the message. | [optional]
|
7
|
+
**type** | **String** | `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. | [optional]
|
8
|
+
**text** | **String** | Message text or name of the attached file | [optional]
|
9
|
+
**visitor_id** | **String** | visitor’s ID | [optional]
|
10
|
+
**agent_id** | **String** | ID of the agent on whose behalf the message was sent (only in messages sent by an agent). | [optional]
|
11
|
+
**agent_name** | **String** | Agent’s name as displayed to the visitor. Only in the messages sent by an agent. | [optional]
|
12
|
+
**created_at** | **Integer** | Timestamp in milliseconds. | [optional]
|
13
|
+
**is_pushed** | **BOOLEAN** | `true` for pushed messages | [optional]
|
14
|
+
**received_from** | **String** | In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. | [optional]
|
15
|
+
**file** | [**ConversationsMessageFile**](ConversationsMessageFile.md) | | [optional]
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# SibApiV3Sdk::ConversationsMessageFile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**filename** | **String** | Name of the file | [optional]
|
7
|
+
**size** | **Integer** | Size in bytes | [optional]
|
8
|
+
**is_image** | **BOOLEAN** | Whether the file is an image | [optional]
|
9
|
+
**url** | **String** | URL of the file | [optional]
|
10
|
+
**image_info** | [**ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SibApiV3Sdk::ConversationsMessageFileImageInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**width** | **Integer** | Width of the image | [optional]
|
7
|
+
**height** | **Integer** | height of the image | [optional]
|
8
|
+
**preview_url** | **String** | URL of the preview | [optional]
|
9
|
+
|
10
|
+
|
data/docs/CreateContact.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
|
7
|
-
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional]
|
7
|
+
**attributes** | **Object** | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional]
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
|
10
10
|
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
|
data/docs/CreateSmsCampaign.md
CHANGED
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
8
8
|
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS |
|
9
9
|
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
|
10
10
|
**scheduled_at** | **String** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
11
|
+
**unicode_enabled** | **BOOLEAN** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
|
11
12
|
|
12
13
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SibApiV3Sdk::CreateSubAccount
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**company_name** | **String** | Set the name of the sub-account company |
|
7
|
+
**email** | **String** | Email address for the organization |
|
8
|
+
**language** | **String** | Set the language of the sub-account | [optional]
|
9
|
+
**timezone** | **String** | Set the timezone of the sub-account | [optional]
|
10
|
+
|
11
|
+
|
data/docs/CreateWebhook.md
CHANGED
@@ -5,7 +5,8 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | URL of the webhook |
|
7
7
|
**description** | **String** | Description of the webhook | [optional]
|
8
|
-
**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook
|
8
|
+
**events** | **Array<String>** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` |
|
9
9
|
**type** | **String** | Type of the webhook | [optional] [default to 'transactional']
|
10
|
+
**domain** | **String** | Inbound domain of webhook, required in case of event type `inbound` | [optional]
|
10
11
|
|
11
12
|
|
data/docs/Deal.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# SibApiV3Sdk::Deal
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Unique deal id | [optional]
|
7
|
+
**attributes** | **Object** | Deal attributes with values | [optional]
|
8
|
+
**linked_contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this deal | [optional]
|
9
|
+
**linked_companies_ids** | **Array<String>** | Companies ids for companies linked to this deal | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# SibApiV3Sdk::DealAttributesInner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**internal_name** | **String** | | [optional]
|
7
|
+
**label** | **String** | | [optional]
|
8
|
+
**attribute_type_name** | **String** | | [optional]
|
9
|
+
**attribute_options** | **Array<Object>** | | [optional]
|
10
|
+
**is_required** | **BOOLEAN** | | [optional]
|
11
|
+
|
12
|
+
|