sib-api-v3-sdk 7.5.0 → 8.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 +59 -4
- data/docs/Body.md +18 -0
- data/docs/Body1.md +18 -0
- data/docs/CRMApi.md +710 -0
- data/docs/Contact.md +15 -0
- data/docs/ContactsApi.md +61 -2
- data/docs/CreateSmsCampaign.md +1 -0
- data/docs/CreateSubAccount.md +10 -0
- data/docs/CreateWebhook.md +2 -1
- data/docs/FileData.md +17 -0
- data/docs/GetCampaignStats.md +1 -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/InboundParsingApi.md +139 -0
- data/docs/MasterAccountApi.md +367 -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/RequestContactExport.md +1 -2
- data/docs/SendSmtpEmail.md +3 -3
- 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 +24 -0
- data/docs/TaskReminder.md +10 -0
- data/docs/TransactionalEmailsApi.md +4 -63
- data/docs/UpdateBatchContacts.md +8 -0
- data/docs/UpdateBatchContactsContacts.md +16 -0
- data/docs/UpdateBatchContactsModel.md +9 -0
- data/docs/UpdateSmsCampaign.md +1 -0
- data/docs/UpdateWebhook.md +2 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +55 -2
- data/lib/sib-api-v3-sdk/api/crm_api.rb +670 -0
- data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +161 -0
- data/lib/sib-api-v3-sdk/api/master_account_api.rb +365 -0
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +4 -60
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +2 -2
- data/lib/sib-api-v3-sdk/models/body.rb +305 -0
- data/lib/sib-api-v3-sdk/models/body_1.rb +305 -0
- data/lib/sib-api-v3-sdk/models/{send_email.rb → contact.rb} +64 -78
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +16 -4
- data/lib/sib-api-v3-sdk/models/create_sub_account.rb +244 -0
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +17 -7
- data/lib/sib-api-v3-sdk/models/file_data.rb +278 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +16 -1
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +15 -4
- 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/{send_template_email.rb → get_inbound_email_events.rb} +10 -14
- 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/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/{send_email_attachment.rb → master_details_response_plan_info_features.rb} +45 -44
- 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/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/send_smtp_email.rb +3 -3
- 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 +367 -0
- data/lib/sib-api-v3-sdk/models/task_reminder.rb +257 -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_sms_campaign.rb +16 -4
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +15 -5
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/lib/sib-api-v3-sdk.rb +41 -3
- data/sib-api-v3-sdk.gemspec +2 -1
- data/spec/api/contacts_api_spec.rb +13 -1
- data/spec/api/crm_api_spec.rb +170 -0
- data/spec/api/inbound_parsing_api_spec.rb +64 -0
- data/spec/api/master_account_api_spec.rb +108 -0
- data/spec/api/transactional_emails_api_spec.rb +2 -13
- data/spec/models/body_1_spec.rb +101 -0
- data/spec/models/body_spec.rb +101 -0
- data/spec/models/contact_spec.rb +83 -0
- data/spec/models/create_sms_campaign_spec.rb +6 -0
- data/spec/models/create_sub_account_spec.rb +57 -0
- data/spec/models/create_webhook_spec.rb +8 -2
- data/spec/models/file_data_spec.rb +95 -0
- data/spec/models/get_campaign_stats_spec.rb +6 -0
- data/spec/models/get_contact_campaign_stats_spec.rb +6 -0
- 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/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_spec.rb +77 -0
- data/spec/models/request_contact_export_spec.rb +0 -6
- data/spec/models/send_transac_sms_spec.rb +6 -0
- data/spec/models/{send_email_attachment_spec.rb → sso_token_request_spec.rb} +8 -8
- 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_reminder_spec.rb +57 -0
- data/spec/models/task_spec.rb +137 -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/{send_template_email_spec.rb → update_batch_contacts_spec.rb} +7 -7
- data/spec/models/update_sms_campaign_spec.rb +6 -0
- data/spec/models/update_webhook_spec.rb +7 -1
- metadata +186 -14
- data/docs/SendEmail.md +0 -16
- data/docs/SendEmailAttachment.md +0 -9
- data/docs/SendTemplateEmail.md +0 -8
@@ -0,0 +1,273 @@
|
|
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 'date'
|
14
|
+
|
15
|
+
module SibApiV3Sdk
|
16
|
+
class UpdateBatchContactsContacts
|
17
|
+
# Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)
|
18
|
+
attr_accessor :email
|
19
|
+
|
20
|
+
# id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)
|
21
|
+
attr_accessor :id
|
22
|
+
|
23
|
+
# SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)
|
24
|
+
attr_accessor :sms
|
25
|
+
|
26
|
+
# 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\"}**
|
27
|
+
attr_accessor :attributes
|
28
|
+
|
29
|
+
# Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)
|
30
|
+
attr_accessor :email_blacklisted
|
31
|
+
|
32
|
+
# Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)
|
33
|
+
attr_accessor :sms_blacklisted
|
34
|
+
|
35
|
+
# Ids of the lists to add the contact to
|
36
|
+
attr_accessor :list_ids
|
37
|
+
|
38
|
+
# Ids of the lists to remove the contact from
|
39
|
+
attr_accessor :unlink_list_ids
|
40
|
+
|
41
|
+
# transactional email forbidden sender for contact. Use only for email Contact
|
42
|
+
attr_accessor :smtp_blacklist_sender
|
43
|
+
|
44
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
45
|
+
def self.attribute_map
|
46
|
+
{
|
47
|
+
:'email' => :'email',
|
48
|
+
:'id' => :'id',
|
49
|
+
:'sms' => :'sms',
|
50
|
+
:'attributes' => :'attributes',
|
51
|
+
:'email_blacklisted' => :'emailBlacklisted',
|
52
|
+
:'sms_blacklisted' => :'smsBlacklisted',
|
53
|
+
:'list_ids' => :'listIds',
|
54
|
+
:'unlink_list_ids' => :'unlinkListIds',
|
55
|
+
:'smtp_blacklist_sender' => :'smtpBlacklistSender'
|
56
|
+
}
|
57
|
+
end
|
58
|
+
|
59
|
+
# Attribute type mapping.
|
60
|
+
def self.swagger_types
|
61
|
+
{
|
62
|
+
:'email' => :'String',
|
63
|
+
:'id' => :'Integer',
|
64
|
+
:'sms' => :'String',
|
65
|
+
:'attributes' => :'Hash<String, Object>',
|
66
|
+
:'email_blacklisted' => :'BOOLEAN',
|
67
|
+
:'sms_blacklisted' => :'BOOLEAN',
|
68
|
+
:'list_ids' => :'Array<Integer>',
|
69
|
+
:'unlink_list_ids' => :'Array<Integer>',
|
70
|
+
:'smtp_blacklist_sender' => :'Array<String>'
|
71
|
+
}
|
72
|
+
end
|
73
|
+
|
74
|
+
# Initializes the object
|
75
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
76
|
+
def initialize(attributes = {})
|
77
|
+
return unless attributes.is_a?(Hash)
|
78
|
+
|
79
|
+
# convert string to symbol for hash key
|
80
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
81
|
+
|
82
|
+
if attributes.has_key?(:'email')
|
83
|
+
self.email = attributes[:'email']
|
84
|
+
end
|
85
|
+
|
86
|
+
if attributes.has_key?(:'id')
|
87
|
+
self.id = attributes[:'id']
|
88
|
+
end
|
89
|
+
|
90
|
+
if attributes.has_key?(:'sms')
|
91
|
+
self.sms = attributes[:'sms']
|
92
|
+
end
|
93
|
+
|
94
|
+
if attributes.has_key?(:'attributes')
|
95
|
+
if (value = attributes[:'attributes']).is_a?(Hash)
|
96
|
+
self.attributes = value
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
if attributes.has_key?(:'emailBlacklisted')
|
101
|
+
self.email_blacklisted = attributes[:'emailBlacklisted']
|
102
|
+
end
|
103
|
+
|
104
|
+
if attributes.has_key?(:'smsBlacklisted')
|
105
|
+
self.sms_blacklisted = attributes[:'smsBlacklisted']
|
106
|
+
end
|
107
|
+
|
108
|
+
if attributes.has_key?(:'listIds')
|
109
|
+
if (value = attributes[:'listIds']).is_a?(Array)
|
110
|
+
self.list_ids = value
|
111
|
+
end
|
112
|
+
end
|
113
|
+
|
114
|
+
if attributes.has_key?(:'unlinkListIds')
|
115
|
+
if (value = attributes[:'unlinkListIds']).is_a?(Array)
|
116
|
+
self.unlink_list_ids = value
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
120
|
+
if attributes.has_key?(:'smtpBlacklistSender')
|
121
|
+
if (value = attributes[:'smtpBlacklistSender']).is_a?(Array)
|
122
|
+
self.smtp_blacklist_sender = value
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
|
127
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
128
|
+
# @return Array for valid properties with the reasons
|
129
|
+
def list_invalid_properties
|
130
|
+
invalid_properties = Array.new
|
131
|
+
invalid_properties
|
132
|
+
end
|
133
|
+
|
134
|
+
# Check to see if the all the properties in the model are valid
|
135
|
+
# @return true if the model is valid
|
136
|
+
def valid?
|
137
|
+
true
|
138
|
+
end
|
139
|
+
|
140
|
+
# Checks equality by comparing each attribute.
|
141
|
+
# @param [Object] Object to be compared
|
142
|
+
def ==(o)
|
143
|
+
return true if self.equal?(o)
|
144
|
+
self.class == o.class &&
|
145
|
+
email == o.email &&
|
146
|
+
id == o.id &&
|
147
|
+
sms == o.sms &&
|
148
|
+
attributes == o.attributes &&
|
149
|
+
email_blacklisted == o.email_blacklisted &&
|
150
|
+
sms_blacklisted == o.sms_blacklisted &&
|
151
|
+
list_ids == o.list_ids &&
|
152
|
+
unlink_list_ids == o.unlink_list_ids &&
|
153
|
+
smtp_blacklist_sender == o.smtp_blacklist_sender
|
154
|
+
end
|
155
|
+
|
156
|
+
# @see the `==` method
|
157
|
+
# @param [Object] Object to be compared
|
158
|
+
def eql?(o)
|
159
|
+
self == o
|
160
|
+
end
|
161
|
+
|
162
|
+
# Calculates hash code according to all attributes.
|
163
|
+
# @return [Fixnum] Hash code
|
164
|
+
def hash
|
165
|
+
[email, id, sms, attributes, email_blacklisted, sms_blacklisted, list_ids, unlink_list_ids, smtp_blacklist_sender].hash
|
166
|
+
end
|
167
|
+
|
168
|
+
# Builds the object from hash
|
169
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
170
|
+
# @return [Object] Returns the model itself
|
171
|
+
def build_from_hash(attributes)
|
172
|
+
return nil unless attributes.is_a?(Hash)
|
173
|
+
self.class.swagger_types.each_pair do |key, type|
|
174
|
+
if type =~ /\AArray<(.*)>/i
|
175
|
+
# check to ensure the input is an array given that the attribute
|
176
|
+
# is documented as an array but the input is not
|
177
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
178
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
179
|
+
end
|
180
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
181
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
182
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
183
|
+
end
|
184
|
+
|
185
|
+
self
|
186
|
+
end
|
187
|
+
|
188
|
+
# Deserializes the data based on type
|
189
|
+
# @param string type Data type
|
190
|
+
# @param string value Value to be deserialized
|
191
|
+
# @return [Object] Deserialized data
|
192
|
+
def _deserialize(type, value)
|
193
|
+
case type.to_sym
|
194
|
+
when :DateTime
|
195
|
+
DateTime.parse(value)
|
196
|
+
when :Date
|
197
|
+
Date.parse(value)
|
198
|
+
when :String
|
199
|
+
value.to_s
|
200
|
+
when :Integer
|
201
|
+
value.to_i
|
202
|
+
when :Float
|
203
|
+
value.to_f
|
204
|
+
when :BOOLEAN
|
205
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
206
|
+
true
|
207
|
+
else
|
208
|
+
false
|
209
|
+
end
|
210
|
+
when :Object
|
211
|
+
# generic object (usually a Hash), return directly
|
212
|
+
value
|
213
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
214
|
+
inner_type = Regexp.last_match[:inner_type]
|
215
|
+
value.map { |v| _deserialize(inner_type, v) }
|
216
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
217
|
+
k_type = Regexp.last_match[:k_type]
|
218
|
+
v_type = Regexp.last_match[:v_type]
|
219
|
+
{}.tap do |hash|
|
220
|
+
value.each do |k, v|
|
221
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
222
|
+
end
|
223
|
+
end
|
224
|
+
else # model
|
225
|
+
temp_model = SibApiV3Sdk.const_get(type).new
|
226
|
+
temp_model.build_from_hash(value)
|
227
|
+
end
|
228
|
+
end
|
229
|
+
|
230
|
+
# Returns the string representation of the object
|
231
|
+
# @return [String] String presentation of the object
|
232
|
+
def to_s
|
233
|
+
to_hash.to_s
|
234
|
+
end
|
235
|
+
|
236
|
+
# to_body is an alias to to_hash (backward compatibility)
|
237
|
+
# @return [Hash] Returns the object in the form of hash
|
238
|
+
def to_body
|
239
|
+
to_hash
|
240
|
+
end
|
241
|
+
|
242
|
+
# Returns the object in the form of hash
|
243
|
+
# @return [Hash] Returns the object in the form of hash
|
244
|
+
def to_hash
|
245
|
+
hash = {}
|
246
|
+
self.class.attribute_map.each_pair do |attr, param|
|
247
|
+
value = self.send(attr)
|
248
|
+
next if value.nil?
|
249
|
+
hash[param] = _to_hash(value)
|
250
|
+
end
|
251
|
+
hash
|
252
|
+
end
|
253
|
+
|
254
|
+
# Outputs non-array value in the form of hash
|
255
|
+
# For object, use to_hash. Otherwise, just return the value
|
256
|
+
# @param [Object] value Any valid value
|
257
|
+
# @return [Hash] Returns the value in the form of hash
|
258
|
+
def _to_hash(value)
|
259
|
+
if value.is_a?(Array)
|
260
|
+
value.compact.map { |v| _to_hash(v) }
|
261
|
+
elsif value.is_a?(Hash)
|
262
|
+
{}.tap do |hash|
|
263
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
264
|
+
end
|
265
|
+
elsif value.respond_to? :to_hash
|
266
|
+
value.to_hash
|
267
|
+
else
|
268
|
+
value
|
269
|
+
end
|
270
|
+
end
|
271
|
+
|
272
|
+
end
|
273
|
+
end
|
@@ -0,0 +1,197 @@
|
|
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 'date'
|
14
|
+
|
15
|
+
module SibApiV3Sdk
|
16
|
+
class UpdateBatchContactsModel
|
17
|
+
attr_accessor :success_ids
|
18
|
+
|
19
|
+
attr_accessor :failure_ids
|
20
|
+
|
21
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
22
|
+
def self.attribute_map
|
23
|
+
{
|
24
|
+
:'success_ids' => :'successIds',
|
25
|
+
:'failure_ids' => :'failureIds'
|
26
|
+
}
|
27
|
+
end
|
28
|
+
|
29
|
+
# Attribute type mapping.
|
30
|
+
def self.swagger_types
|
31
|
+
{
|
32
|
+
:'success_ids' => :'Array<Integer>',
|
33
|
+
:'failure_ids' => :'Array<Integer>'
|
34
|
+
}
|
35
|
+
end
|
36
|
+
|
37
|
+
# Initializes the object
|
38
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
39
|
+
def initialize(attributes = {})
|
40
|
+
return unless attributes.is_a?(Hash)
|
41
|
+
|
42
|
+
# convert string to symbol for hash key
|
43
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
44
|
+
|
45
|
+
if attributes.has_key?(:'successIds')
|
46
|
+
if (value = attributes[:'successIds']).is_a?(Array)
|
47
|
+
self.success_ids = value
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
if attributes.has_key?(:'failureIds')
|
52
|
+
if (value = attributes[:'failureIds']).is_a?(Array)
|
53
|
+
self.failure_ids = value
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
59
|
+
# @return Array for valid properties with the reasons
|
60
|
+
def list_invalid_properties
|
61
|
+
invalid_properties = Array.new
|
62
|
+
invalid_properties
|
63
|
+
end
|
64
|
+
|
65
|
+
# Check to see if the all the properties in the model are valid
|
66
|
+
# @return true if the model is valid
|
67
|
+
def valid?
|
68
|
+
true
|
69
|
+
end
|
70
|
+
|
71
|
+
# Checks equality by comparing each attribute.
|
72
|
+
# @param [Object] Object to be compared
|
73
|
+
def ==(o)
|
74
|
+
return true if self.equal?(o)
|
75
|
+
self.class == o.class &&
|
76
|
+
success_ids == o.success_ids &&
|
77
|
+
failure_ids == o.failure_ids
|
78
|
+
end
|
79
|
+
|
80
|
+
# @see the `==` method
|
81
|
+
# @param [Object] Object to be compared
|
82
|
+
def eql?(o)
|
83
|
+
self == o
|
84
|
+
end
|
85
|
+
|
86
|
+
# Calculates hash code according to all attributes.
|
87
|
+
# @return [Fixnum] Hash code
|
88
|
+
def hash
|
89
|
+
[success_ids, failure_ids].hash
|
90
|
+
end
|
91
|
+
|
92
|
+
# Builds the object from hash
|
93
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
94
|
+
# @return [Object] Returns the model itself
|
95
|
+
def build_from_hash(attributes)
|
96
|
+
return nil unless attributes.is_a?(Hash)
|
97
|
+
self.class.swagger_types.each_pair do |key, type|
|
98
|
+
if type =~ /\AArray<(.*)>/i
|
99
|
+
# check to ensure the input is an array given that the attribute
|
100
|
+
# is documented as an array but the input is not
|
101
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
102
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
103
|
+
end
|
104
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
105
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
106
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
107
|
+
end
|
108
|
+
|
109
|
+
self
|
110
|
+
end
|
111
|
+
|
112
|
+
# Deserializes the data based on type
|
113
|
+
# @param string type Data type
|
114
|
+
# @param string value Value to be deserialized
|
115
|
+
# @return [Object] Deserialized data
|
116
|
+
def _deserialize(type, value)
|
117
|
+
case type.to_sym
|
118
|
+
when :DateTime
|
119
|
+
DateTime.parse(value)
|
120
|
+
when :Date
|
121
|
+
Date.parse(value)
|
122
|
+
when :String
|
123
|
+
value.to_s
|
124
|
+
when :Integer
|
125
|
+
value.to_i
|
126
|
+
when :Float
|
127
|
+
value.to_f
|
128
|
+
when :BOOLEAN
|
129
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
130
|
+
true
|
131
|
+
else
|
132
|
+
false
|
133
|
+
end
|
134
|
+
when :Object
|
135
|
+
# generic object (usually a Hash), return directly
|
136
|
+
value
|
137
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
138
|
+
inner_type = Regexp.last_match[:inner_type]
|
139
|
+
value.map { |v| _deserialize(inner_type, v) }
|
140
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
141
|
+
k_type = Regexp.last_match[:k_type]
|
142
|
+
v_type = Regexp.last_match[:v_type]
|
143
|
+
{}.tap do |hash|
|
144
|
+
value.each do |k, v|
|
145
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
146
|
+
end
|
147
|
+
end
|
148
|
+
else # model
|
149
|
+
temp_model = SibApiV3Sdk.const_get(type).new
|
150
|
+
temp_model.build_from_hash(value)
|
151
|
+
end
|
152
|
+
end
|
153
|
+
|
154
|
+
# Returns the string representation of the object
|
155
|
+
# @return [String] String presentation of the object
|
156
|
+
def to_s
|
157
|
+
to_hash.to_s
|
158
|
+
end
|
159
|
+
|
160
|
+
# to_body is an alias to to_hash (backward compatibility)
|
161
|
+
# @return [Hash] Returns the object in the form of hash
|
162
|
+
def to_body
|
163
|
+
to_hash
|
164
|
+
end
|
165
|
+
|
166
|
+
# Returns the object in the form of hash
|
167
|
+
# @return [Hash] Returns the object in the form of hash
|
168
|
+
def to_hash
|
169
|
+
hash = {}
|
170
|
+
self.class.attribute_map.each_pair do |attr, param|
|
171
|
+
value = self.send(attr)
|
172
|
+
next if value.nil?
|
173
|
+
hash[param] = _to_hash(value)
|
174
|
+
end
|
175
|
+
hash
|
176
|
+
end
|
177
|
+
|
178
|
+
# Outputs non-array value in the form of hash
|
179
|
+
# For object, use to_hash. Otherwise, just return the value
|
180
|
+
# @param [Object] value Any valid value
|
181
|
+
# @return [Hash] Returns the value in the form of hash
|
182
|
+
def _to_hash(value)
|
183
|
+
if value.is_a?(Array)
|
184
|
+
value.compact.map { |v| _to_hash(v) }
|
185
|
+
elsif value.is_a?(Hash)
|
186
|
+
{}.tap do |hash|
|
187
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
188
|
+
end
|
189
|
+
elsif value.respond_to? :to_hash
|
190
|
+
value.to_hash
|
191
|
+
else
|
192
|
+
value
|
193
|
+
end
|
194
|
+
end
|
195
|
+
|
196
|
+
end
|
197
|
+
end
|
@@ -28,6 +28,9 @@ module SibApiV3Sdk
|
|
28
28
|
# 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.
|
29
29
|
attr_accessor :scheduled_at
|
30
30
|
|
31
|
+
# Format of the message. It indicates whether the content should be treated as unicode or not.
|
32
|
+
attr_accessor :unicode_enabled
|
33
|
+
|
31
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
32
35
|
def self.attribute_map
|
33
36
|
{
|
@@ -35,7 +38,8 @@ module SibApiV3Sdk
|
|
35
38
|
:'sender' => :'sender',
|
36
39
|
:'content' => :'content',
|
37
40
|
:'recipients' => :'recipients',
|
38
|
-
:'scheduled_at' => :'scheduledAt'
|
41
|
+
:'scheduled_at' => :'scheduledAt',
|
42
|
+
:'unicode_enabled' => :'unicodeEnabled'
|
39
43
|
}
|
40
44
|
end
|
41
45
|
|
@@ -46,7 +50,8 @@ module SibApiV3Sdk
|
|
46
50
|
:'sender' => :'String',
|
47
51
|
:'content' => :'String',
|
48
52
|
:'recipients' => :'CreateSmsCampaignRecipients',
|
49
|
-
:'scheduled_at' => :'String'
|
53
|
+
:'scheduled_at' => :'String',
|
54
|
+
:'unicode_enabled' => :'BOOLEAN'
|
50
55
|
}
|
51
56
|
end
|
52
57
|
|
@@ -77,6 +82,12 @@ module SibApiV3Sdk
|
|
77
82
|
if attributes.has_key?(:'scheduledAt')
|
78
83
|
self.scheduled_at = attributes[:'scheduledAt']
|
79
84
|
end
|
85
|
+
|
86
|
+
if attributes.has_key?(:'unicodeEnabled')
|
87
|
+
self.unicode_enabled = attributes[:'unicodeEnabled']
|
88
|
+
else
|
89
|
+
self.unicode_enabled = false
|
90
|
+
end
|
80
91
|
end
|
81
92
|
|
82
93
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -116,7 +127,8 @@ module SibApiV3Sdk
|
|
116
127
|
sender == o.sender &&
|
117
128
|
content == o.content &&
|
118
129
|
recipients == o.recipients &&
|
119
|
-
scheduled_at == o.scheduled_at
|
130
|
+
scheduled_at == o.scheduled_at &&
|
131
|
+
unicode_enabled == o.unicode_enabled
|
120
132
|
end
|
121
133
|
|
122
134
|
# @see the `==` method
|
@@ -128,7 +140,7 @@ module SibApiV3Sdk
|
|
128
140
|
# Calculates hash code according to all attributes.
|
129
141
|
# @return [Fixnum] Hash code
|
130
142
|
def hash
|
131
|
-
[name, sender, content, recipients, scheduled_at].hash
|
143
|
+
[name, sender, content, recipients, scheduled_at, unicode_enabled].hash
|
132
144
|
end
|
133
145
|
|
134
146
|
# Builds the object from hash
|
@@ -20,9 +20,12 @@ module SibApiV3Sdk
|
|
20
20
|
# Description of the webhook
|
21
21
|
attr_accessor :description
|
22
22
|
|
23
|
-
# Events triggering the webhook. Possible values for Transactional type webhook
|
23
|
+
# - 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`
|
24
24
|
attr_accessor :events
|
25
25
|
|
26
|
+
# Inbound domain of webhook, used in case of event type `inbound`
|
27
|
+
attr_accessor :domain
|
28
|
+
|
26
29
|
class EnumAttributeValidator
|
27
30
|
attr_reader :datatype
|
28
31
|
attr_reader :allowable_values
|
@@ -50,7 +53,8 @@ module SibApiV3Sdk
|
|
50
53
|
{
|
51
54
|
:'url' => :'url',
|
52
55
|
:'description' => :'description',
|
53
|
-
:'events' => :'events'
|
56
|
+
:'events' => :'events',
|
57
|
+
:'domain' => :'domain'
|
54
58
|
}
|
55
59
|
end
|
56
60
|
|
@@ -59,7 +63,8 @@ module SibApiV3Sdk
|
|
59
63
|
{
|
60
64
|
:'url' => :'String',
|
61
65
|
:'description' => :'String',
|
62
|
-
:'events' => :'Array<String>'
|
66
|
+
:'events' => :'Array<String>',
|
67
|
+
:'domain' => :'String'
|
63
68
|
}
|
64
69
|
end
|
65
70
|
|
@@ -84,6 +89,10 @@ module SibApiV3Sdk
|
|
84
89
|
self.events = value
|
85
90
|
end
|
86
91
|
end
|
92
|
+
|
93
|
+
if attributes.has_key?(:'domain')
|
94
|
+
self.domain = attributes[:'domain']
|
95
|
+
end
|
87
96
|
end
|
88
97
|
|
89
98
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -106,7 +115,8 @@ module SibApiV3Sdk
|
|
106
115
|
self.class == o.class &&
|
107
116
|
url == o.url &&
|
108
117
|
description == o.description &&
|
109
|
-
events == o.events
|
118
|
+
events == o.events &&
|
119
|
+
domain == o.domain
|
110
120
|
end
|
111
121
|
|
112
122
|
# @see the `==` method
|
@@ -118,7 +128,7 @@ module SibApiV3Sdk
|
|
118
128
|
# Calculates hash code according to all attributes.
|
119
129
|
# @return [Fixnum] Hash code
|
120
130
|
def hash
|
121
|
-
[url, description, events].hash
|
131
|
+
[url, description, events, domain].hash
|
122
132
|
end
|
123
133
|
|
124
134
|
# Builds the object from hash
|