sib-api-v3-sdk 8.1.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/README.md +82 -14
- data/docs/Body.md +2 -11
- data/docs/Body1.md +2 -11
- data/docs/Body10.md +11 -0
- data/docs/Body11.md +8 -0
- 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 +8 -2
- 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/CreateSubAccount.md +3 -3
- data/docs/CreateSubAccountResponse.md +8 -0
- 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 +3 -6
- data/docs/FileDownloadableLink.md +8 -0
- data/docs/FileList.md +7 -0
- data/docs/FilesApi.md +318 -0
- data/docs/GetCampaignStats.md +2 -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 +60 -0
- data/docs/InlineResponse200.md +8 -0
- data/docs/InlineResponse201.md +8 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/MasterAccountApi.md +6 -6
- 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/ScheduleSmtpEmail.md +10 -0
- data/docs/SendSmtpEmail.md +3 -1
- data/docs/SubAccountDetailsResponsePlanInfoCredits.md +1 -1
- data/docs/SubAccountsResponseSubAccounts.md +4 -4
- data/docs/Task.md +0 -11
- data/docs/TaskList.md +8 -0
- data/docs/TaskReminder.md +1 -1
- data/docs/TaskTypes.md +0 -1
- data/docs/TasksApi.md +376 -0
- data/docs/TransactionalEmailsApi.md +199 -0
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +1 -1
- data/docs/UpdateSmtpTemplate.md +1 -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 +6 -0
- 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 +53 -1
- data/lib/sib-api-v3-sdk/api/master_account_api.rb +9 -9
- 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 +195 -0
- data/lib/sib-api-v3-sdk/models/body.rb +9 -114
- data/lib/sib-api-v3-sdk/models/body_1.rb +9 -119
- data/lib/sib-api-v3-sdk/models/body_10.rb +225 -0
- data/lib/sib-api-v3-sdk/models/body_11.rb +190 -0
- 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/company.rb +220 -0
- 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_sub_account.rb +3 -3
- data/lib/sib-api-v3-sdk/models/create_sub_account_response.rb +190 -0
- 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 +22 -54
- 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 +21 -1
- data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_batch_id.rb +196 -0
- data/lib/sib-api-v3-sdk/models/{contact.rb → get_scheduled_email_by_batch_id_batches.rb} +62 -74
- 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/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/schedule_smtp_email.rb +206 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +24 -4
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits.rb +2 -2
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits_emails.rb +1 -1
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features.rb +1 -1
- data/lib/sib-api-v3-sdk/models/sub_accounts_response_sub_accounts.rb +4 -4
- data/lib/sib-api-v3-sdk/models/task.rb +4 -119
- data/lib/sib-api-v3-sdk/models/task_list.rb +188 -0
- data/lib/sib-api-v3-sdk/models/task_reminder.rb +1 -1
- data/lib/sib-api-v3-sdk/models/task_types.rb +1 -11
- 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_smtp_template.rb +1 -1
- 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 +44 -2
- data/spec/api/companies_api_spec.rb +119 -0
- data/spec/api/contacts_api_spec.rb +2 -0
- 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 +12 -0
- data/spec/api/master_account_api_spec.rb +4 -4
- data/spec/api/notes_api_spec.rb +97 -0
- data/spec/api/{crm_api_spec.rb → tasks_api_spec.rb} +25 -92
- data/spec/api/transactional_emails_api_spec.rb +44 -0
- data/spec/models/body_10_spec.rb +59 -0
- data/spec/models/body_11_spec.rb +41 -0
- data/spec/models/body_12_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +1 -55
- 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/{contact_spec.rb → body_7_spec.rb} +26 -14
- data/spec/models/body_8_spec.rb +71 -0
- data/spec/models/body_9_spec.rb +41 -0
- data/spec/models/body_spec.rb +1 -55
- 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_sub_account_response_spec.rb +41 -0
- 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 +3 -21
- 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 +12 -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/note_id_spec.rb +41 -0
- data/spec/models/note_list_spec.rb +35 -0
- data/spec/models/pipeline_spec.rb +41 -0
- data/spec/models/pipeline_stage_spec.rb +47 -0
- data/spec/models/schedule_smtp_email_spec.rb +53 -0
- data/spec/models/send_smtp_email_spec.rb +12 -0
- data/spec/models/task_list_spec.rb +41 -0
- data/spec/models/task_spec.rb +0 -66
- data/spec/models/task_types_spec.rb +0 -6
- data/spec/models/upload_image_model_spec.rb +41 -0
- metadata +179 -11
- data/docs/CRMApi.md +0 -762
- data/docs/Contact.md +0 -15
- data/lib/sib-api-v3-sdk/api/crm_api.rb +0 -716
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8c8451f2fbb21e58e803db4b6f8e84f132ea735ac9b0122dd75b6376f7ac86d8
|
4
|
+
data.tar.gz: e4dc35b3fe6547f8f13a8653bd224d9d261036c7422645a71a8dfd7505ac6ddc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f11ffb30b16cf90bed1dedb5aaafb360755b832ac4635946a7e55804b82e1023dd7fdbd08f52022c97be9580dd9473ae50edbfb0359bd87f8deb3de75bff83c9
|
7
|
+
data.tar.gz: f831e0c1e5fe048775b1f7d2913fc6270e600d76bc34e10ad6a255009638bb327b8d5368afbef325ec7751d58c2b13801eaf7cdc155d01f6017daf57a911b972
|
data/README.md
CHANGED
@@ -89,19 +89,13 @@ Class | Method | HTTP request | Description
|
|
89
89
|
*SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
90
90
|
*SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
|
91
91
|
*SibApiV3Sdk::AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
92
|
-
*SibApiV3Sdk::
|
93
|
-
*SibApiV3Sdk::
|
94
|
-
*SibApiV3Sdk::
|
95
|
-
*SibApiV3Sdk::
|
96
|
-
*SibApiV3Sdk::
|
97
|
-
*SibApiV3Sdk::
|
98
|
-
*SibApiV3Sdk::
|
99
|
-
*SibApiV3Sdk::CRMApi* | [**crm_notes_post**](docs/CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a note
|
100
|
-
*SibApiV3Sdk::CRMApi* | [**crm_tasks_id_delete**](docs/CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task
|
101
|
-
*SibApiV3Sdk::CRMApi* | [**crm_tasks_id_get**](docs/CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task
|
102
|
-
*SibApiV3Sdk::CRMApi* | [**crm_tasks_id_patch**](docs/CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task
|
103
|
-
*SibApiV3Sdk::CRMApi* | [**crm_tasks_post**](docs/CRMApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a task
|
104
|
-
*SibApiV3Sdk::CRMApi* | [**crm_tasktypes_get**](docs/CRMApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types
|
92
|
+
*SibApiV3Sdk::CompaniesApi* | [**companies_attributes_get**](docs/CompaniesApi.md#companies_attributes_get) | **GET** /companies/attributes | Get company attributes
|
93
|
+
*SibApiV3Sdk::CompaniesApi* | [**companies_get**](docs/CompaniesApi.md#companies_get) | **GET** /companies | Get all companies
|
94
|
+
*SibApiV3Sdk::CompaniesApi* | [**companies_id_delete**](docs/CompaniesApi.md#companies_id_delete) | **DELETE** /companies/{id} | Delete a company
|
95
|
+
*SibApiV3Sdk::CompaniesApi* | [**companies_id_get**](docs/CompaniesApi.md#companies_id_get) | **GET** /companies/{id} | Get a company
|
96
|
+
*SibApiV3Sdk::CompaniesApi* | [**companies_id_patch**](docs/CompaniesApi.md#companies_id_patch) | **PATCH** /companies/{id} | Update a company
|
97
|
+
*SibApiV3Sdk::CompaniesApi* | [**companies_link_unlink_id_patch**](docs/CompaniesApi.md#companies_link_unlink_id_patch) | **PATCH** /companies/link-unlink/{id} | Link and Unlink company with contacts and deals
|
98
|
+
*SibApiV3Sdk::CompaniesApi* | [**companies_post**](docs/CompaniesApi.md#companies_post) | **POST** /companies | Create a company
|
105
99
|
*SibApiV3Sdk::ContactsApi* | [**add_contact_to_list**](docs/ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
106
100
|
*SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
107
101
|
*SibApiV3Sdk::ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
|
@@ -130,6 +124,23 @@ Class | Method | HTTP request | Description
|
|
130
124
|
*SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
|
131
125
|
*SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
132
126
|
*SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
|
127
|
+
*SibApiV3Sdk::ConversationsApi* | [**conversations_agent_online_ping_post**](docs/ConversationsApi.md#conversations_agent_online_ping_post) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes
|
128
|
+
*SibApiV3Sdk::ConversationsApi* | [**conversations_messages_id_delete**](docs/ConversationsApi.md#conversations_messages_id_delete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent
|
129
|
+
*SibApiV3Sdk::ConversationsApi* | [**conversations_messages_id_get**](docs/ConversationsApi.md#conversations_messages_id_get) | **GET** /conversations/messages/{id} | Get a message
|
130
|
+
*SibApiV3Sdk::ConversationsApi* | [**conversations_messages_id_put**](docs/ConversationsApi.md#conversations_messages_id_put) | **PUT** /conversations/messages/{id} | Update a message sent by an agent
|
131
|
+
*SibApiV3Sdk::ConversationsApi* | [**conversations_messages_post**](docs/ConversationsApi.md#conversations_messages_post) | **POST** /conversations/messages | Send a message as an agent
|
132
|
+
*SibApiV3Sdk::ConversationsApi* | [**conversations_pushed_messages_id_delete**](docs/ConversationsApi.md#conversations_pushed_messages_id_delete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message
|
133
|
+
*SibApiV3Sdk::ConversationsApi* | [**conversations_pushed_messages_id_get**](docs/ConversationsApi.md#conversations_pushed_messages_id_get) | **GET** /conversations/pushedMessages/{id} | Get an automated message
|
134
|
+
*SibApiV3Sdk::ConversationsApi* | [**conversations_pushed_messages_id_put**](docs/ConversationsApi.md#conversations_pushed_messages_id_put) | **PUT** /conversations/pushedMessages/{id} | Update an automated message
|
135
|
+
*SibApiV3Sdk::ConversationsApi* | [**conversations_pushed_messages_post**](docs/ConversationsApi.md#conversations_pushed_messages_post) | **POST** /conversations/pushedMessages | Send an automated message to a visitor
|
136
|
+
*SibApiV3Sdk::DealsApi* | [**crm_attributes_deals_get**](docs/DealsApi.md#crm_attributes_deals_get) | **GET** /crm/attributes/deals | Get deal attributes
|
137
|
+
*SibApiV3Sdk::DealsApi* | [**crm_deals_get**](docs/DealsApi.md#crm_deals_get) | **GET** /crm/deals | Get all deals
|
138
|
+
*SibApiV3Sdk::DealsApi* | [**crm_deals_id_delete**](docs/DealsApi.md#crm_deals_id_delete) | **DELETE** /crm/deals/{id} | Delete a deal
|
139
|
+
*SibApiV3Sdk::DealsApi* | [**crm_deals_id_get**](docs/DealsApi.md#crm_deals_id_get) | **GET** /crm/deals/{id} | Get a deal
|
140
|
+
*SibApiV3Sdk::DealsApi* | [**crm_deals_id_patch**](docs/DealsApi.md#crm_deals_id_patch) | **PATCH** /crm/deals/{id} | Update a deal
|
141
|
+
*SibApiV3Sdk::DealsApi* | [**crm_deals_link_unlink_id_patch**](docs/DealsApi.md#crm_deals_link_unlink_id_patch) | **PATCH** /crm/deals/link-unlink/{id} | Link and Unlink a deal with contacts and companies
|
142
|
+
*SibApiV3Sdk::DealsApi* | [**crm_deals_post**](docs/DealsApi.md#crm_deals_post) | **POST** /crm/deals | Create a deal
|
143
|
+
*SibApiV3Sdk::DealsApi* | [**crm_pipeline_details_get**](docs/DealsApi.md#crm_pipeline_details_get) | **GET** /crm/pipeline/details | Get pipeline stages
|
133
144
|
*SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
134
145
|
*SibApiV3Sdk::EmailCampaignsApi* | [**delete_email_campaign**](docs/EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
|
135
146
|
*SibApiV3Sdk::EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign
|
@@ -143,12 +154,18 @@ Class | Method | HTTP request | Description
|
|
143
154
|
*SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
144
155
|
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
145
156
|
*SibApiV3Sdk::EmailCampaignsApi* | [**upload_image_to_gallery**](docs/EmailCampaignsApi.md#upload_image_to_gallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
157
|
+
*SibApiV3Sdk::FilesApi* | [**crm_files_get**](docs/FilesApi.md#crm_files_get) | **GET** /crm/files | Get all files
|
158
|
+
*SibApiV3Sdk::FilesApi* | [**crm_files_id_data_get**](docs/FilesApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file details
|
159
|
+
*SibApiV3Sdk::FilesApi* | [**crm_files_id_delete**](docs/FilesApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete a file
|
160
|
+
*SibApiV3Sdk::FilesApi* | [**crm_files_id_get**](docs/FilesApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download a file
|
161
|
+
*SibApiV3Sdk::FilesApi* | [**crm_files_post**](docs/FilesApi.md#crm_files_post) | **POST** /crm/files | Upload a file
|
146
162
|
*SibApiV3Sdk::FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
|
147
163
|
*SibApiV3Sdk::FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
|
148
164
|
*SibApiV3Sdk::FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
|
149
165
|
*SibApiV3Sdk::FoldersApi* | [**get_folder_lists**](docs/FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
|
150
166
|
*SibApiV3Sdk::FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders
|
151
167
|
*SibApiV3Sdk::FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
|
168
|
+
*SibApiV3Sdk::InboundParsingApi* | [**get_inbound_email_attachment**](docs/InboundParsingApi.md#get_inbound_email_attachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token.
|
152
169
|
*SibApiV3Sdk::InboundParsingApi* | [**get_inbound_email_events**](docs/InboundParsingApi.md#get_inbound_email_events) | **GET** /inbound/events | Get the list of all the events for the received emails.
|
153
170
|
*SibApiV3Sdk::InboundParsingApi* | [**get_inbound_email_events_by_uuid**](docs/InboundParsingApi.md#get_inbound_email_events_by_uuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
|
154
171
|
*SibApiV3Sdk::ListsApi* | [**add_contact_to_list**](docs/ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
|
@@ -167,6 +184,11 @@ Class | Method | HTTP request | Description
|
|
167
184
|
*SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_id_plan_put**](docs/MasterAccountApi.md#corporate_sub_account_id_plan_put) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
|
168
185
|
*SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_post**](docs/MasterAccountApi.md#corporate_sub_account_post) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
|
169
186
|
*SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_sso_token_post**](docs/MasterAccountApi.md#corporate_sub_account_sso_token_post) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Sendinblue
|
187
|
+
*SibApiV3Sdk::NotesApi* | [**crm_notes_get**](docs/NotesApi.md#crm_notes_get) | **GET** /crm/notes | Get all notes
|
188
|
+
*SibApiV3Sdk::NotesApi* | [**crm_notes_id_delete**](docs/NotesApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete a note
|
189
|
+
*SibApiV3Sdk::NotesApi* | [**crm_notes_id_get**](docs/NotesApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get a note
|
190
|
+
*SibApiV3Sdk::NotesApi* | [**crm_notes_id_patch**](docs/NotesApi.md#crm_notes_id_patch) | **PATCH** /crm/notes/{id} | Update a note
|
191
|
+
*SibApiV3Sdk::NotesApi* | [**crm_notes_post**](docs/NotesApi.md#crm_notes_post) | **POST** /crm/notes | Create a note
|
170
192
|
*SibApiV3Sdk::ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
|
171
193
|
*SibApiV3Sdk::ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
|
172
194
|
*SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
|
@@ -201,14 +223,23 @@ Class | Method | HTTP request | Description
|
|
201
223
|
*SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
|
202
224
|
*SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
|
203
225
|
*SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
|
226
|
+
*SibApiV3Sdk::TasksApi* | [**crm_tasks_get**](docs/TasksApi.md#crm_tasks_get) | **GET** /crm/tasks | Get all tasks
|
227
|
+
*SibApiV3Sdk::TasksApi* | [**crm_tasks_id_delete**](docs/TasksApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task
|
228
|
+
*SibApiV3Sdk::TasksApi* | [**crm_tasks_id_get**](docs/TasksApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task
|
229
|
+
*SibApiV3Sdk::TasksApi* | [**crm_tasks_id_patch**](docs/TasksApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task
|
230
|
+
*SibApiV3Sdk::TasksApi* | [**crm_tasks_post**](docs/TasksApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a task
|
231
|
+
*SibApiV3Sdk::TasksApi* | [**crm_tasktypes_get**](docs/TasksApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types
|
204
232
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**block_new_domain**](docs/TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
|
205
233
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**create_smtp_template**](docs/TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
|
206
234
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_blocked_domain**](docs/TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
|
207
235
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_hardbounces**](docs/TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
236
|
+
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_scheduled_email_by_id**](docs/TransactionalEmailsApi.md#delete_scheduled_email_by_id) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
|
208
237
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_smtp_template**](docs/TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
209
238
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_aggregated_smtp_report**](docs/TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
210
239
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_blocked_domains**](docs/TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
|
211
240
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_email_event_report**](docs/TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
241
|
+
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_scheduled_email_by_batch_id**](docs/TransactionalEmailsApi.md#get_scheduled_email_by_batch_id) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
|
242
|
+
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_scheduled_email_by_message_id**](docs/TransactionalEmailsApi.md#get_scheduled_email_by_message_id) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
|
212
243
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_report**](docs/TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
213
244
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_template**](docs/TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
|
214
245
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_templates**](docs/TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
|
@@ -245,7 +276,24 @@ Class | Method | HTTP request | Description
|
|
245
276
|
- [SibApiV3Sdk::BlockDomain](docs/BlockDomain.md)
|
246
277
|
- [SibApiV3Sdk::Body](docs/Body.md)
|
247
278
|
- [SibApiV3Sdk::Body1](docs/Body1.md)
|
248
|
-
- [SibApiV3Sdk::
|
279
|
+
- [SibApiV3Sdk::Body10](docs/Body10.md)
|
280
|
+
- [SibApiV3Sdk::Body11](docs/Body11.md)
|
281
|
+
- [SibApiV3Sdk::Body12](docs/Body12.md)
|
282
|
+
- [SibApiV3Sdk::Body2](docs/Body2.md)
|
283
|
+
- [SibApiV3Sdk::Body3](docs/Body3.md)
|
284
|
+
- [SibApiV3Sdk::Body4](docs/Body4.md)
|
285
|
+
- [SibApiV3Sdk::Body5](docs/Body5.md)
|
286
|
+
- [SibApiV3Sdk::Body6](docs/Body6.md)
|
287
|
+
- [SibApiV3Sdk::Body7](docs/Body7.md)
|
288
|
+
- [SibApiV3Sdk::Body8](docs/Body8.md)
|
289
|
+
- [SibApiV3Sdk::Body9](docs/Body9.md)
|
290
|
+
- [SibApiV3Sdk::CompaniesList](docs/CompaniesList.md)
|
291
|
+
- [SibApiV3Sdk::Company](docs/Company.md)
|
292
|
+
- [SibApiV3Sdk::CompanyAttributes](docs/CompanyAttributes.md)
|
293
|
+
- [SibApiV3Sdk::CompanyAttributesInner](docs/CompanyAttributesInner.md)
|
294
|
+
- [SibApiV3Sdk::ConversationsMessage](docs/ConversationsMessage.md)
|
295
|
+
- [SibApiV3Sdk::ConversationsMessageFile](docs/ConversationsMessageFile.md)
|
296
|
+
- [SibApiV3Sdk::ConversationsMessageFileImageInfo](docs/ConversationsMessageFileImageInfo.md)
|
249
297
|
- [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
|
250
298
|
- [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
|
251
299
|
- [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
|
@@ -266,14 +314,21 @@ Class | Method | HTTP request | Description
|
|
266
314
|
- [SibApiV3Sdk::CreateSmtpTemplate](docs/CreateSmtpTemplate.md)
|
267
315
|
- [SibApiV3Sdk::CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md)
|
268
316
|
- [SibApiV3Sdk::CreateSubAccount](docs/CreateSubAccount.md)
|
317
|
+
- [SibApiV3Sdk::CreateSubAccountResponse](docs/CreateSubAccountResponse.md)
|
269
318
|
- [SibApiV3Sdk::CreateUpdateContactModel](docs/CreateUpdateContactModel.md)
|
270
319
|
- [SibApiV3Sdk::CreateUpdateFolder](docs/CreateUpdateFolder.md)
|
271
320
|
- [SibApiV3Sdk::CreateWebhook](docs/CreateWebhook.md)
|
272
321
|
- [SibApiV3Sdk::CreatedProcessId](docs/CreatedProcessId.md)
|
322
|
+
- [SibApiV3Sdk::Deal](docs/Deal.md)
|
323
|
+
- [SibApiV3Sdk::DealAttributes](docs/DealAttributes.md)
|
324
|
+
- [SibApiV3Sdk::DealAttributesInner](docs/DealAttributesInner.md)
|
325
|
+
- [SibApiV3Sdk::DealsList](docs/DealsList.md)
|
273
326
|
- [SibApiV3Sdk::DeleteHardbounces](docs/DeleteHardbounces.md)
|
274
327
|
- [SibApiV3Sdk::EmailExportRecipients](docs/EmailExportRecipients.md)
|
275
328
|
- [SibApiV3Sdk::ErrorModel](docs/ErrorModel.md)
|
276
329
|
- [SibApiV3Sdk::FileData](docs/FileData.md)
|
330
|
+
- [SibApiV3Sdk::FileDownloadableLink](docs/FileDownloadableLink.md)
|
331
|
+
- [SibApiV3Sdk::FileList](docs/FileList.md)
|
277
332
|
- [SibApiV3Sdk::GetAccount](docs/GetAccount.md)
|
278
333
|
- [SibApiV3Sdk::GetAccountMarketingAutomation](docs/GetAccountMarketingAutomation.md)
|
279
334
|
- [SibApiV3Sdk::GetAccountPlan](docs/GetAccountPlan.md)
|
@@ -346,6 +401,9 @@ Class | Method | HTTP request | Description
|
|
346
401
|
- [SibApiV3Sdk::GetProcesses](docs/GetProcesses.md)
|
347
402
|
- [SibApiV3Sdk::GetReports](docs/GetReports.md)
|
348
403
|
- [SibApiV3Sdk::GetReportsReports](docs/GetReportsReports.md)
|
404
|
+
- [SibApiV3Sdk::GetScheduledEmailByBatchId](docs/GetScheduledEmailByBatchId.md)
|
405
|
+
- [SibApiV3Sdk::GetScheduledEmailByBatchIdBatches](docs/GetScheduledEmailByBatchIdBatches.md)
|
406
|
+
- [SibApiV3Sdk::GetScheduledEmailByMessageId](docs/GetScheduledEmailByMessageId.md)
|
349
407
|
- [SibApiV3Sdk::GetSendersList](docs/GetSendersList.md)
|
350
408
|
- [SibApiV3Sdk::GetSendersListIps](docs/GetSendersListIps.md)
|
351
409
|
- [SibApiV3Sdk::GetSendersListSenders](docs/GetSendersListSenders.md)
|
@@ -376,6 +434,9 @@ Class | Method | HTTP request | Description
|
|
376
434
|
- [SibApiV3Sdk::GetTransacSmsReportReports](docs/GetTransacSmsReportReports.md)
|
377
435
|
- [SibApiV3Sdk::GetWebhook](docs/GetWebhook.md)
|
378
436
|
- [SibApiV3Sdk::GetWebhooks](docs/GetWebhooks.md)
|
437
|
+
- [SibApiV3Sdk::InlineResponse200](docs/InlineResponse200.md)
|
438
|
+
- [SibApiV3Sdk::InlineResponse201](docs/InlineResponse201.md)
|
439
|
+
- [SibApiV3Sdk::InlineResponse2011](docs/InlineResponse2011.md)
|
379
440
|
- [SibApiV3Sdk::ManageIp](docs/ManageIp.md)
|
380
441
|
- [SibApiV3Sdk::MasterDetailsResponse](docs/MasterDetailsResponse.md)
|
381
442
|
- [SibApiV3Sdk::MasterDetailsResponseBillingInfo](docs/MasterDetailsResponseBillingInfo.md)
|
@@ -385,6 +446,10 @@ Class | Method | HTTP request | Description
|
|
385
446
|
- [SibApiV3Sdk::MasterDetailsResponsePlanInfoFeatures](docs/MasterDetailsResponsePlanInfoFeatures.md)
|
386
447
|
- [SibApiV3Sdk::Note](docs/Note.md)
|
387
448
|
- [SibApiV3Sdk::NoteData](docs/NoteData.md)
|
449
|
+
- [SibApiV3Sdk::NoteId](docs/NoteId.md)
|
450
|
+
- [SibApiV3Sdk::NoteList](docs/NoteList.md)
|
451
|
+
- [SibApiV3Sdk::Pipeline](docs/Pipeline.md)
|
452
|
+
- [SibApiV3Sdk::PipelineStage](docs/PipelineStage.md)
|
388
453
|
- [SibApiV3Sdk::PostContactInfo](docs/PostContactInfo.md)
|
389
454
|
- [SibApiV3Sdk::PostContactInfoContacts](docs/PostContactInfoContacts.md)
|
390
455
|
- [SibApiV3Sdk::PostSendFailed](docs/PostSendFailed.md)
|
@@ -399,6 +464,7 @@ Class | Method | HTTP request | Description
|
|
399
464
|
- [SibApiV3Sdk::RequestContactImport](docs/RequestContactImport.md)
|
400
465
|
- [SibApiV3Sdk::RequestContactImportNewList](docs/RequestContactImportNewList.md)
|
401
466
|
- [SibApiV3Sdk::RequestSmsRecipientExport](docs/RequestSmsRecipientExport.md)
|
467
|
+
- [SibApiV3Sdk::ScheduleSmtpEmail](docs/ScheduleSmtpEmail.md)
|
402
468
|
- [SibApiV3Sdk::SendReport](docs/SendReport.md)
|
403
469
|
- [SibApiV3Sdk::SendReportEmail](docs/SendReportEmail.md)
|
404
470
|
- [SibApiV3Sdk::SendSms](docs/SendSms.md)
|
@@ -430,6 +496,7 @@ Class | Method | HTTP request | Description
|
|
430
496
|
- [SibApiV3Sdk::SubAccountsResponse](docs/SubAccountsResponse.md)
|
431
497
|
- [SibApiV3Sdk::SubAccountsResponseSubAccounts](docs/SubAccountsResponseSubAccounts.md)
|
432
498
|
- [SibApiV3Sdk::Task](docs/Task.md)
|
499
|
+
- [SibApiV3Sdk::TaskList](docs/TaskList.md)
|
433
500
|
- [SibApiV3Sdk::TaskReminder](docs/TaskReminder.md)
|
434
501
|
- [SibApiV3Sdk::TaskTypes](docs/TaskTypes.md)
|
435
502
|
- [SibApiV3Sdk::UpdateAttribute](docs/UpdateAttribute.md)
|
@@ -451,6 +518,7 @@ Class | Method | HTTP request | Description
|
|
451
518
|
- [SibApiV3Sdk::UpdateSmtpTemplate](docs/UpdateSmtpTemplate.md)
|
452
519
|
- [SibApiV3Sdk::UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md)
|
453
520
|
- [SibApiV3Sdk::UpdateWebhook](docs/UpdateWebhook.md)
|
521
|
+
- [SibApiV3Sdk::UploadImageModel](docs/UploadImageModel.md)
|
454
522
|
- [SibApiV3Sdk::UploadImageToGallery](docs/UploadImageToGallery.md)
|
455
523
|
|
456
524
|
|
data/docs/Body.md
CHANGED
@@ -3,16 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | Name of
|
7
|
-
**
|
8
|
-
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. |
|
9
|
-
**date** | **DateTime** | Task date/time |
|
10
|
-
**notes** | **String** | Notes added to a task | [optional]
|
11
|
-
**done** | **BOOLEAN** | Task marked as done | [optional]
|
12
|
-
**assign_to_id** | **String** | User id to whom task is assigned | [optional]
|
13
|
-
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
|
14
|
-
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
|
15
|
-
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
|
16
|
-
**reminder** | [**TaskReminder**](TaskReminder.md) | | [optional]
|
6
|
+
**name** | **String** | Name of company |
|
7
|
+
**attributes** | **Object** | Attributes for company creation | [optional]
|
17
8
|
|
18
9
|
|
data/docs/Body1.md
CHANGED
@@ -3,16 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | Name of
|
7
|
-
**
|
8
|
-
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. |
|
9
|
-
**date** | **DateTime** | Task date/time |
|
10
|
-
**notes** | **String** | Notes added to a task | [optional]
|
11
|
-
**done** | **BOOLEAN** | Task marked as done | [optional]
|
12
|
-
**assign_to_id** | **String** | User id to whom task is assigned | [optional]
|
13
|
-
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
|
14
|
-
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
|
15
|
-
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
|
16
|
-
**reminder** | [**TaskReminder**](TaskReminder.md) | | [optional]
|
6
|
+
**name** | **String** | Name of company | [optional]
|
7
|
+
**attributes** | **Object** | Attributes for company update | [optional]
|
17
8
|
|
18
9
|
|
data/docs/Body10.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# SibApiV3Sdk::Body10
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**visitor_id** | **String** | visitor’s ID received from a webhook or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
|
7
|
+
**text** | **String** | message text |
|
8
|
+
**agent_id** | **String** | agent ID. It can be found on agent’s page or received from a webhook. Optional if `groupId` is set. | [optional]
|
9
|
+
**group_id** | **String** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional]
|
10
|
+
|
11
|
+
|
data/docs/Body11.md
ADDED
data/docs/Body12.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# SibApiV3Sdk::Body12
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**agent_id** | **String** | agent ID. It can be found on agent’s page or received from a webhook. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
|
7
|
+
**received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
|
8
|
+
**agent_email** | **String** | agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Sendinblue organization, a dummy agent will be created automatically. | [optional]
|
9
|
+
**agent_name** | **String** | agent name. | [optional]
|
10
|
+
|
11
|
+
|
data/docs/Body2.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# SibApiV3Sdk::Body2
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with company | [optional]
|
7
|
+
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from company | [optional]
|
8
|
+
**link_deals_ids** | **Array<String>** | Deals ids for deals to be linked with company | [optional]
|
9
|
+
**unlink_deals_ids** | **Array<String>** | Deals ids for deals to be unlinked from company | [optional]
|
10
|
+
|
11
|
+
|
data/docs/Body3.md
ADDED
data/docs/Body4.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::Body4
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Name of deal | [optional]
|
7
|
+
**attributes** | **Object** | Attributes for deal update | [optional]
|
8
|
+
|
9
|
+
|
data/docs/Body5.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# SibApiV3Sdk::Body5
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with deal | [optional]
|
7
|
+
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from deal | [optional]
|
8
|
+
**link_company_ids** | **Array<String>** | Company ids to be linked with deal | [optional]
|
9
|
+
**unlink_company_ids** | **Array<String>** | Company ids to be unlinked from deal | [optional]
|
10
|
+
|
11
|
+
|
data/docs/Body6.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# SibApiV3Sdk::Body6
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Name of task |
|
7
|
+
**duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
|
8
|
+
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. |
|
9
|
+
**date** | **DateTime** | Task due date and time |
|
10
|
+
**notes** | **String** | Notes added to a task | [optional]
|
11
|
+
**done** | **BOOLEAN** | Task marked as done | [optional]
|
12
|
+
**assign_to_id** | **String** | User id to whom task is assigned | [optional]
|
13
|
+
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
|
14
|
+
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
|
15
|
+
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
|
16
|
+
**reminder** | [**TaskReminder**](TaskReminder.md) | | [optional]
|
17
|
+
|
18
|
+
|
data/docs/Body7.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# SibApiV3Sdk::Body7
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Name of task | [optional]
|
7
|
+
**duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
|
8
|
+
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. | [optional]
|
9
|
+
**date** | **DateTime** | Task date/time | [optional]
|
10
|
+
**notes** | **String** | Notes added to a task | [optional]
|
11
|
+
**done** | **BOOLEAN** | Task marked as done | [optional]
|
12
|
+
**assign_to_id** | **String** | User id to whom task is assigned | [optional]
|
13
|
+
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
|
14
|
+
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
|
15
|
+
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
|
16
|
+
|
17
|
+
|
data/docs/Body8.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# SibApiV3Sdk::Body8
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**visitor_id** | **String** | visitor’s ID received from a webhook or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
|
7
|
+
**text** | **String** | message text |
|
8
|
+
**agent_id** | **String** | agent ID. It can be found on agent’s page or received from a webhook. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
|
9
|
+
**received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
|
10
|
+
**agent_email** | **String** | agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. | [optional]
|
11
|
+
**agent_name** | **String** | agent name | [optional]
|
12
|
+
|
13
|
+
|