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,16 @@
|
|
1
|
+
# SibApiV3Sdk::UpdateBatchContactsContacts
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional]
|
7
|
+
**id** | **Integer** | id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional]
|
8
|
+
**sms** | **String** | SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional]
|
9
|
+
**attributes** | **Hash<String, Object>** | Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}** | [optional]
|
10
|
+
**email_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional]
|
11
|
+
**sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional]
|
12
|
+
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
|
13
|
+
**unlink_list_ids** | **Array<Integer>** | Ids of the lists to remove the contact from | [optional]
|
14
|
+
**smtp_blacklist_sender** | **Array<String>** | transactional email forbidden sender for contact. Use only for email Contact | [optional]
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::UpdateBatchContactsModel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**success_ids** | **Array<Integer>** | | [optional]
|
7
|
+
**failure_ids** | **Array<Integer>** | | [optional]
|
8
|
+
|
9
|
+
|
data/docs/UpdateContact.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in
|
6
|
+
**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
|
7
7
|
**email_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional]
|
8
8
|
**sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional]
|
9
9
|
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
|
data/docs/UpdateEmailCampaign.md
CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**tag** | **String** | Tag of the campaign | [optional]
|
7
7
|
**sender** | [**UpdateEmailCampaignSender**](UpdateEmailCampaignSender.md) | | [optional]
|
8
8
|
**name** | **String** | Name of the campaign | [optional]
|
9
|
-
**html_content** | **String** | Body of the message (HTML version). REQUIRED if htmlUrl is empty | [optional]
|
9
|
+
**html_content** | **String** | Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty | [optional]
|
10
10
|
**html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional]
|
11
11
|
**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. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
12
12
|
**subject** | **String** | Subject of the campaign | [optional]
|
data/docs/UpdateSmsCampaign.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 | [optional]
|
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
|
|
data/docs/UpdateSmtpTemplate.md
CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**tag** | **String** | Tag of the template | [optional]
|
7
7
|
**sender** | [**UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) | | [optional]
|
8
8
|
**template_name** | **String** | Name of the template | [optional]
|
9
|
-
**html_content** | **String** | Required if htmlUrl is empty. Body of the message (HTML must have more than 10 characters) | [optional]
|
9
|
+
**html_content** | **String** | Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) | [optional]
|
10
10
|
**html_url** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional]
|
11
11
|
**subject** | **String** | Subject of the email | [optional]
|
12
12
|
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
|
data/docs/UpdateWebhook.md
CHANGED
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | URL of the webhook | [optional]
|
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` | [optional]
|
9
|
+
**domain** | **String** | Inbound domain of webhook, used in case of event type `inbound` | [optional]
|
9
10
|
|
10
11
|
|
@@ -0,0 +1,409 @@
|
|
1
|
+
=begin
|
2
|
+
#SendinBlue API
|
3
|
+
|
4
|
+
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
|
+
|
6
|
+
OpenAPI spec version: 3.0.0
|
7
|
+
Contact: contact@sendinblue.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.19
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module SibApiV3Sdk
|
16
|
+
class CompaniesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Get company attributes
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @return [CompanyAttributes]
|
25
|
+
def companies_attributes_get(opts = {})
|
26
|
+
data, _status_code, _headers = companies_attributes_get_with_http_info(opts)
|
27
|
+
data
|
28
|
+
end
|
29
|
+
|
30
|
+
# Get company attributes
|
31
|
+
# @param [Hash] opts the optional parameters
|
32
|
+
# @return [Array<(CompanyAttributes, Fixnum, Hash)>] CompanyAttributes data, response status code and response headers
|
33
|
+
def companies_attributes_get_with_http_info(opts = {})
|
34
|
+
if @api_client.config.debugging
|
35
|
+
@api_client.config.logger.debug 'Calling API: CompaniesApi.companies_attributes_get ...'
|
36
|
+
end
|
37
|
+
# resource path
|
38
|
+
local_var_path = '/companies/attributes'
|
39
|
+
|
40
|
+
# query parameters
|
41
|
+
query_params = {}
|
42
|
+
|
43
|
+
# header parameters
|
44
|
+
header_params = {}
|
45
|
+
# HTTP header 'Accept' (if needed)
|
46
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
47
|
+
# HTTP header 'Content-Type'
|
48
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
49
|
+
|
50
|
+
# form parameters
|
51
|
+
form_params = {}
|
52
|
+
|
53
|
+
# http body (model)
|
54
|
+
post_body = nil
|
55
|
+
auth_names = ['api-key', 'partner-key']
|
56
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
57
|
+
:header_params => header_params,
|
58
|
+
:query_params => query_params,
|
59
|
+
:form_params => form_params,
|
60
|
+
:body => post_body,
|
61
|
+
:auth_names => auth_names,
|
62
|
+
:return_type => 'CompanyAttributes')
|
63
|
+
if @api_client.config.debugging
|
64
|
+
@api_client.config.logger.debug "API called: CompaniesApi#companies_attributes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
65
|
+
end
|
66
|
+
return data, status_code, headers
|
67
|
+
end
|
68
|
+
# Get all companies
|
69
|
+
# @param [Hash] opts the optional parameters
|
70
|
+
# @option opts [String] :filters Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"}
|
71
|
+
# @option opts [Integer] :linked_contacts_ids Filter by linked contacts ids
|
72
|
+
# @option opts [String] :linked_deals_ids Filter by linked deals ids
|
73
|
+
# @option opts [Integer] :page Index of the first document of the page
|
74
|
+
# @option opts [Integer] :limit Number of documents per page (default to 50)
|
75
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
76
|
+
# @option opts [String] :sort_by The field used to sort field names.
|
77
|
+
# @return [CompaniesList]
|
78
|
+
def companies_get(opts = {})
|
79
|
+
data, _status_code, _headers = companies_get_with_http_info(opts)
|
80
|
+
data
|
81
|
+
end
|
82
|
+
|
83
|
+
# Get all companies
|
84
|
+
# @param [Hash] opts the optional parameters
|
85
|
+
# @option opts [String] :filters Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"}
|
86
|
+
# @option opts [Integer] :linked_contacts_ids Filter by linked contacts ids
|
87
|
+
# @option opts [String] :linked_deals_ids Filter by linked deals ids
|
88
|
+
# @option opts [Integer] :page Index of the first document of the page
|
89
|
+
# @option opts [Integer] :limit Number of documents per page
|
90
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
91
|
+
# @option opts [String] :sort_by The field used to sort field names.
|
92
|
+
# @return [Array<(CompaniesList, Fixnum, Hash)>] CompaniesList data, response status code and response headers
|
93
|
+
def companies_get_with_http_info(opts = {})
|
94
|
+
if @api_client.config.debugging
|
95
|
+
@api_client.config.logger.debug 'Calling API: CompaniesApi.companies_get ...'
|
96
|
+
end
|
97
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
98
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
99
|
+
end
|
100
|
+
# resource path
|
101
|
+
local_var_path = '/companies'
|
102
|
+
|
103
|
+
# query parameters
|
104
|
+
query_params = {}
|
105
|
+
query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?
|
106
|
+
query_params[:'linkedContactsIds'] = opts[:'linked_contacts_ids'] if !opts[:'linked_contacts_ids'].nil?
|
107
|
+
query_params[:'linkedDealsIds'] = opts[:'linked_deals_ids'] if !opts[:'linked_deals_ids'].nil?
|
108
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
109
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
110
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
111
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
|
112
|
+
|
113
|
+
# header parameters
|
114
|
+
header_params = {}
|
115
|
+
# HTTP header 'Accept' (if needed)
|
116
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
117
|
+
# HTTP header 'Content-Type'
|
118
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
119
|
+
|
120
|
+
# form parameters
|
121
|
+
form_params = {}
|
122
|
+
|
123
|
+
# http body (model)
|
124
|
+
post_body = nil
|
125
|
+
auth_names = ['api-key', 'partner-key']
|
126
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
127
|
+
:header_params => header_params,
|
128
|
+
:query_params => query_params,
|
129
|
+
:form_params => form_params,
|
130
|
+
:body => post_body,
|
131
|
+
:auth_names => auth_names,
|
132
|
+
:return_type => 'CompaniesList')
|
133
|
+
if @api_client.config.debugging
|
134
|
+
@api_client.config.logger.debug "API called: CompaniesApi#companies_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
135
|
+
end
|
136
|
+
return data, status_code, headers
|
137
|
+
end
|
138
|
+
# Delete a company
|
139
|
+
# @param id
|
140
|
+
# @param [Hash] opts the optional parameters
|
141
|
+
# @return [nil]
|
142
|
+
def companies_id_delete(id, opts = {})
|
143
|
+
companies_id_delete_with_http_info(id, opts)
|
144
|
+
nil
|
145
|
+
end
|
146
|
+
|
147
|
+
# Delete a company
|
148
|
+
# @param id
|
149
|
+
# @param [Hash] opts the optional parameters
|
150
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
151
|
+
def companies_id_delete_with_http_info(id, opts = {})
|
152
|
+
if @api_client.config.debugging
|
153
|
+
@api_client.config.logger.debug 'Calling API: CompaniesApi.companies_id_delete ...'
|
154
|
+
end
|
155
|
+
# verify the required parameter 'id' is set
|
156
|
+
if @api_client.config.client_side_validation && id.nil?
|
157
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.companies_id_delete"
|
158
|
+
end
|
159
|
+
# resource path
|
160
|
+
local_var_path = '/companies/{id}'.sub('{' + 'id' + '}', id.to_s)
|
161
|
+
|
162
|
+
# query parameters
|
163
|
+
query_params = {}
|
164
|
+
|
165
|
+
# header parameters
|
166
|
+
header_params = {}
|
167
|
+
# HTTP header 'Accept' (if needed)
|
168
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
169
|
+
# HTTP header 'Content-Type'
|
170
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
171
|
+
|
172
|
+
# form parameters
|
173
|
+
form_params = {}
|
174
|
+
|
175
|
+
# http body (model)
|
176
|
+
post_body = nil
|
177
|
+
auth_names = ['api-key', 'partner-key']
|
178
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
179
|
+
:header_params => header_params,
|
180
|
+
:query_params => query_params,
|
181
|
+
:form_params => form_params,
|
182
|
+
:body => post_body,
|
183
|
+
:auth_names => auth_names)
|
184
|
+
if @api_client.config.debugging
|
185
|
+
@api_client.config.logger.debug "API called: CompaniesApi#companies_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
186
|
+
end
|
187
|
+
return data, status_code, headers
|
188
|
+
end
|
189
|
+
# Get a company
|
190
|
+
# @param id
|
191
|
+
# @param [Hash] opts the optional parameters
|
192
|
+
# @return [Company]
|
193
|
+
def companies_id_get(id, opts = {})
|
194
|
+
data, _status_code, _headers = companies_id_get_with_http_info(id, opts)
|
195
|
+
data
|
196
|
+
end
|
197
|
+
|
198
|
+
# Get a company
|
199
|
+
# @param id
|
200
|
+
# @param [Hash] opts the optional parameters
|
201
|
+
# @return [Array<(Company, Fixnum, Hash)>] Company data, response status code and response headers
|
202
|
+
def companies_id_get_with_http_info(id, opts = {})
|
203
|
+
if @api_client.config.debugging
|
204
|
+
@api_client.config.logger.debug 'Calling API: CompaniesApi.companies_id_get ...'
|
205
|
+
end
|
206
|
+
# verify the required parameter 'id' is set
|
207
|
+
if @api_client.config.client_side_validation && id.nil?
|
208
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.companies_id_get"
|
209
|
+
end
|
210
|
+
# resource path
|
211
|
+
local_var_path = '/companies/{id}'.sub('{' + 'id' + '}', id.to_s)
|
212
|
+
|
213
|
+
# query parameters
|
214
|
+
query_params = {}
|
215
|
+
|
216
|
+
# header parameters
|
217
|
+
header_params = {}
|
218
|
+
# HTTP header 'Accept' (if needed)
|
219
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
220
|
+
# HTTP header 'Content-Type'
|
221
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
222
|
+
|
223
|
+
# form parameters
|
224
|
+
form_params = {}
|
225
|
+
|
226
|
+
# http body (model)
|
227
|
+
post_body = nil
|
228
|
+
auth_names = ['api-key', 'partner-key']
|
229
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
230
|
+
:header_params => header_params,
|
231
|
+
:query_params => query_params,
|
232
|
+
:form_params => form_params,
|
233
|
+
:body => post_body,
|
234
|
+
:auth_names => auth_names,
|
235
|
+
:return_type => 'Company')
|
236
|
+
if @api_client.config.debugging
|
237
|
+
@api_client.config.logger.debug "API called: CompaniesApi#companies_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
238
|
+
end
|
239
|
+
return data, status_code, headers
|
240
|
+
end
|
241
|
+
# Update a company
|
242
|
+
# @param id
|
243
|
+
# @param body Updated company details.
|
244
|
+
# @param [Hash] opts the optional parameters
|
245
|
+
# @return [Company]
|
246
|
+
def companies_id_patch(id, body, opts = {})
|
247
|
+
data, _status_code, _headers = companies_id_patch_with_http_info(id, body, opts)
|
248
|
+
data
|
249
|
+
end
|
250
|
+
|
251
|
+
# Update a company
|
252
|
+
# @param id
|
253
|
+
# @param body Updated company details.
|
254
|
+
# @param [Hash] opts the optional parameters
|
255
|
+
# @return [Array<(Company, Fixnum, Hash)>] Company data, response status code and response headers
|
256
|
+
def companies_id_patch_with_http_info(id, body, opts = {})
|
257
|
+
if @api_client.config.debugging
|
258
|
+
@api_client.config.logger.debug 'Calling API: CompaniesApi.companies_id_patch ...'
|
259
|
+
end
|
260
|
+
# verify the required parameter 'id' is set
|
261
|
+
if @api_client.config.client_side_validation && id.nil?
|
262
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.companies_id_patch"
|
263
|
+
end
|
264
|
+
# verify the required parameter 'body' is set
|
265
|
+
if @api_client.config.client_side_validation && body.nil?
|
266
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CompaniesApi.companies_id_patch"
|
267
|
+
end
|
268
|
+
# resource path
|
269
|
+
local_var_path = '/companies/{id}'.sub('{' + 'id' + '}', id.to_s)
|
270
|
+
|
271
|
+
# query parameters
|
272
|
+
query_params = {}
|
273
|
+
|
274
|
+
# header parameters
|
275
|
+
header_params = {}
|
276
|
+
# HTTP header 'Accept' (if needed)
|
277
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
278
|
+
# HTTP header 'Content-Type'
|
279
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
280
|
+
|
281
|
+
# form parameters
|
282
|
+
form_params = {}
|
283
|
+
|
284
|
+
# http body (model)
|
285
|
+
post_body = @api_client.object_to_http_body(body)
|
286
|
+
auth_names = ['api-key', 'partner-key']
|
287
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
288
|
+
:header_params => header_params,
|
289
|
+
:query_params => query_params,
|
290
|
+
:form_params => form_params,
|
291
|
+
:body => post_body,
|
292
|
+
:auth_names => auth_names,
|
293
|
+
:return_type => 'Company')
|
294
|
+
if @api_client.config.debugging
|
295
|
+
@api_client.config.logger.debug "API called: CompaniesApi#companies_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
296
|
+
end
|
297
|
+
return data, status_code, headers
|
298
|
+
end
|
299
|
+
# Link and Unlink company with contacts and deals
|
300
|
+
# @param id
|
301
|
+
# @param body Linked / Unlinked contacts and deals ids.
|
302
|
+
# @param [Hash] opts the optional parameters
|
303
|
+
# @return [nil]
|
304
|
+
def companies_link_unlink_id_patch(id, body, opts = {})
|
305
|
+
companies_link_unlink_id_patch_with_http_info(id, body, opts)
|
306
|
+
nil
|
307
|
+
end
|
308
|
+
|
309
|
+
# Link and Unlink company with contacts and deals
|
310
|
+
# @param id
|
311
|
+
# @param body Linked / Unlinked contacts and deals ids.
|
312
|
+
# @param [Hash] opts the optional parameters
|
313
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
314
|
+
def companies_link_unlink_id_patch_with_http_info(id, body, opts = {})
|
315
|
+
if @api_client.config.debugging
|
316
|
+
@api_client.config.logger.debug 'Calling API: CompaniesApi.companies_link_unlink_id_patch ...'
|
317
|
+
end
|
318
|
+
# verify the required parameter 'id' is set
|
319
|
+
if @api_client.config.client_side_validation && id.nil?
|
320
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.companies_link_unlink_id_patch"
|
321
|
+
end
|
322
|
+
# verify the required parameter 'body' is set
|
323
|
+
if @api_client.config.client_side_validation && body.nil?
|
324
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CompaniesApi.companies_link_unlink_id_patch"
|
325
|
+
end
|
326
|
+
# resource path
|
327
|
+
local_var_path = '/companies/link-unlink/{id}'.sub('{' + 'id' + '}', id.to_s)
|
328
|
+
|
329
|
+
# query parameters
|
330
|
+
query_params = {}
|
331
|
+
|
332
|
+
# header parameters
|
333
|
+
header_params = {}
|
334
|
+
# HTTP header 'Accept' (if needed)
|
335
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
336
|
+
# HTTP header 'Content-Type'
|
337
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
338
|
+
|
339
|
+
# form parameters
|
340
|
+
form_params = {}
|
341
|
+
|
342
|
+
# http body (model)
|
343
|
+
post_body = @api_client.object_to_http_body(body)
|
344
|
+
auth_names = ['api-key', 'partner-key']
|
345
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
346
|
+
:header_params => header_params,
|
347
|
+
:query_params => query_params,
|
348
|
+
:form_params => form_params,
|
349
|
+
:body => post_body,
|
350
|
+
:auth_names => auth_names)
|
351
|
+
if @api_client.config.debugging
|
352
|
+
@api_client.config.logger.debug "API called: CompaniesApi#companies_link_unlink_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
353
|
+
end
|
354
|
+
return data, status_code, headers
|
355
|
+
end
|
356
|
+
# Create a company
|
357
|
+
# @param body Company create data.
|
358
|
+
# @param [Hash] opts the optional parameters
|
359
|
+
# @return [InlineResponse200]
|
360
|
+
def companies_post(body, opts = {})
|
361
|
+
data, _status_code, _headers = companies_post_with_http_info(body, opts)
|
362
|
+
data
|
363
|
+
end
|
364
|
+
|
365
|
+
# Create a company
|
366
|
+
# @param body Company create data.
|
367
|
+
# @param [Hash] opts the optional parameters
|
368
|
+
# @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
|
369
|
+
def companies_post_with_http_info(body, opts = {})
|
370
|
+
if @api_client.config.debugging
|
371
|
+
@api_client.config.logger.debug 'Calling API: CompaniesApi.companies_post ...'
|
372
|
+
end
|
373
|
+
# verify the required parameter 'body' is set
|
374
|
+
if @api_client.config.client_side_validation && body.nil?
|
375
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CompaniesApi.companies_post"
|
376
|
+
end
|
377
|
+
# resource path
|
378
|
+
local_var_path = '/companies'
|
379
|
+
|
380
|
+
# query parameters
|
381
|
+
query_params = {}
|
382
|
+
|
383
|
+
# header parameters
|
384
|
+
header_params = {}
|
385
|
+
# HTTP header 'Accept' (if needed)
|
386
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
387
|
+
# HTTP header 'Content-Type'
|
388
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
389
|
+
|
390
|
+
# form parameters
|
391
|
+
form_params = {}
|
392
|
+
|
393
|
+
# http body (model)
|
394
|
+
post_body = @api_client.object_to_http_body(body)
|
395
|
+
auth_names = ['api-key', 'partner-key']
|
396
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
397
|
+
:header_params => header_params,
|
398
|
+
:query_params => query_params,
|
399
|
+
:form_params => form_params,
|
400
|
+
:body => post_body,
|
401
|
+
:auth_names => auth_names,
|
402
|
+
:return_type => 'InlineResponse200')
|
403
|
+
if @api_client.config.debugging
|
404
|
+
@api_client.config.logger.debug "API called: CompaniesApi#companies_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
405
|
+
end
|
406
|
+
return data, status_code, headers
|
407
|
+
end
|
408
|
+
end
|
409
|
+
end
|
@@ -622,8 +622,11 @@ module SibApiV3Sdk
|
|
622
622
|
return data, status_code, headers
|
623
623
|
end
|
624
624
|
# Get a contact's details
|
625
|
+
# Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
|
625
626
|
# @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
|
626
627
|
# @param [Hash] opts the optional parameters
|
628
|
+
# @option opts [Object] :start_date **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
629
|
+
# @option opts [Object] :end_date **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate.
|
627
630
|
# @return [GetExtendedContactDetails]
|
628
631
|
def get_contact_info(identifier, opts = {})
|
629
632
|
data, _status_code, _headers = get_contact_info_with_http_info(identifier, opts)
|
@@ -631,8 +634,11 @@ module SibApiV3Sdk
|
|
631
634
|
end
|
632
635
|
|
633
636
|
# Get a contact's details
|
637
|
+
# Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
|
634
638
|
# @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
|
635
639
|
# @param [Hash] opts the optional parameters
|
640
|
+
# @option opts [Object] :start_date **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
641
|
+
# @option opts [Object] :end_date **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate.
|
636
642
|
# @return [Array<(GetExtendedContactDetails, Fixnum, Hash)>] GetExtendedContactDetails data, response status code and response headers
|
637
643
|
def get_contact_info_with_http_info(identifier, opts = {})
|
638
644
|
if @api_client.config.debugging
|
@@ -647,6 +653,8 @@ module SibApiV3Sdk
|
|
647
653
|
|
648
654
|
# query parameters
|
649
655
|
query_params = {}
|
656
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
657
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
650
658
|
|
651
659
|
# header parameters
|
652
660
|
header_params = {}
|
@@ -677,7 +685,7 @@ module SibApiV3Sdk
|
|
677
685
|
# @param identifier Email (urlencoded) OR ID of the contact
|
678
686
|
# @param [Hash] opts the optional parameters
|
679
687
|
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
680
|
-
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
|
688
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
|
681
689
|
# @return [GetContactCampaignStats]
|
682
690
|
def get_contact_stats(identifier, opts = {})
|
683
691
|
data, _status_code, _headers = get_contact_stats_with_http_info(identifier, opts)
|
@@ -688,7 +696,7 @@ module SibApiV3Sdk
|
|
688
696
|
# @param identifier Email (urlencoded) OR ID of the contact
|
689
697
|
# @param [Hash] opts the optional parameters
|
690
698
|
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
|
691
|
-
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
|
699
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
|
692
700
|
# @return [Array<(GetContactCampaignStats, Fixnum, Hash)>] GetContactCampaignStats data, response status code and response headers
|
693
701
|
def get_contact_stats_with_http_info(identifier, opts = {})
|
694
702
|
if @api_client.config.debugging
|
@@ -1404,6 +1412,57 @@ module SibApiV3Sdk
|
|
1404
1412
|
end
|
1405
1413
|
return data, status_code, headers
|
1406
1414
|
end
|
1415
|
+
# Update multiple contacts
|
1416
|
+
# @param update_batch_contacts Values to update multiple contacts
|
1417
|
+
# @param [Hash] opts the optional parameters
|
1418
|
+
# @return [nil]
|
1419
|
+
def update_batch_contacts(update_batch_contacts, opts = {})
|
1420
|
+
update_batch_contacts_with_http_info(update_batch_contacts, opts)
|
1421
|
+
nil
|
1422
|
+
end
|
1423
|
+
|
1424
|
+
# Update multiple contacts
|
1425
|
+
# @param update_batch_contacts Values to update multiple contacts
|
1426
|
+
# @param [Hash] opts the optional parameters
|
1427
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1428
|
+
def update_batch_contacts_with_http_info(update_batch_contacts, opts = {})
|
1429
|
+
if @api_client.config.debugging
|
1430
|
+
@api_client.config.logger.debug 'Calling API: ContactsApi.update_batch_contacts ...'
|
1431
|
+
end
|
1432
|
+
# verify the required parameter 'update_batch_contacts' is set
|
1433
|
+
if @api_client.config.client_side_validation && update_batch_contacts.nil?
|
1434
|
+
fail ArgumentError, "Missing the required parameter 'update_batch_contacts' when calling ContactsApi.update_batch_contacts"
|
1435
|
+
end
|
1436
|
+
# resource path
|
1437
|
+
local_var_path = '/contacts/batch'
|
1438
|
+
|
1439
|
+
# query parameters
|
1440
|
+
query_params = {}
|
1441
|
+
|
1442
|
+
# header parameters
|
1443
|
+
header_params = {}
|
1444
|
+
# HTTP header 'Accept' (if needed)
|
1445
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1446
|
+
# HTTP header 'Content-Type'
|
1447
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1448
|
+
|
1449
|
+
# form parameters
|
1450
|
+
form_params = {}
|
1451
|
+
|
1452
|
+
# http body (model)
|
1453
|
+
post_body = @api_client.object_to_http_body(update_batch_contacts)
|
1454
|
+
auth_names = ['api-key', 'partner-key']
|
1455
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1456
|
+
:header_params => header_params,
|
1457
|
+
:query_params => query_params,
|
1458
|
+
:form_params => form_params,
|
1459
|
+
:body => post_body,
|
1460
|
+
:auth_names => auth_names)
|
1461
|
+
if @api_client.config.debugging
|
1462
|
+
@api_client.config.logger.debug "API called: ContactsApi#update_batch_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1463
|
+
end
|
1464
|
+
return data, status_code, headers
|
1465
|
+
end
|
1407
1466
|
# Update a contact
|
1408
1467
|
# @param identifier Email (urlencoded) OR ID of the contact
|
1409
1468
|
# @param update_contact Values to update a contact
|