brevo 2.0.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +56 -4
- data/docs/Body.md +2 -3
- data/docs/Body1.md +2 -3
- data/docs/Body10.md +10 -4
- data/docs/Body11.md +6 -1
- data/docs/Body12.md +1 -4
- data/docs/Body13.md +11 -0
- data/docs/Body14.md +8 -0
- data/docs/Body15.md +11 -0
- data/docs/Body2.md +1 -4
- data/docs/Body3.md +3 -2
- data/docs/Body4.md +3 -2
- data/docs/Body5.md +4 -4
- data/docs/Body6.md +2 -11
- data/docs/Body7.md +2 -10
- data/docs/Body8.md +4 -6
- data/docs/Body9.md +11 -1
- data/docs/CompaniesApi.md +8 -8
- data/docs/ContactsApi.md +14 -4
- data/docs/ConversationsApi.md +10 -10
- data/docs/ConversionSourceMetrics.md +12 -0
- data/docs/ConversionSourceProduct.md +15 -0
- data/docs/CorporateGroupDetailsResponse.md +10 -0
- data/docs/CorporateGroupDetailsResponseGroup.md +10 -0
- data/docs/CorporateGroupDetailsResponseSubaccounts.md +10 -0
- data/docs/CorporateGroupDetailsResponseUsers.md +10 -0
- data/docs/CouponsApi.md +12 -9
- data/docs/CreateContact.md +1 -1
- data/docs/CreateCouponCollection.md +5 -2
- data/docs/CreateDomainModel.md +1 -0
- data/docs/CreateDomainModelDnsRecords.md +1 -0
- data/docs/CreateWebhook.md +3 -0
- data/docs/CreateWhatsAppTemplate.md +1 -0
- data/docs/DealsApi.md +10 -10
- data/docs/EcommerceApi.md +261 -2
- data/docs/EmailCampaignsApi.md +1 -3
- data/docs/Event.md +12 -0
- data/docs/EventIdentifiers.md +12 -0
- data/docs/EventsApi.md +67 -0
- data/docs/ExportWebhooksHistory.md +2 -1
- data/docs/ExternalFeedsApi.md +2 -2
- data/docs/GetContactDetails.md +1 -1
- data/docs/GetCorporateInvitedUsersList.md +8 -0
- data/docs/GetCorporateInvitedUsersListFeatureAccess.md +11 -0
- data/docs/GetCorporateInvitedUsersListGroups.md +9 -0
- data/docs/GetCorporateInvitedUsersListUsers.md +12 -0
- data/docs/GetCorporateUserPermission.md +11 -0
- data/docs/GetCorporateUserPermissionFeatureAccess.md +11 -0
- data/docs/GetCorporateUserPermissionGroups.md +9 -0
- data/docs/GetCouponCollection.md +9 -6
- data/docs/GetExtendedContactDetails.md +1 -1
- data/docs/GetOrders.md +9 -0
- data/docs/GetWebhook.md +3 -0
- data/docs/GetWebhookAuth.md +9 -0
- data/docs/GetWebhookHeaders.md +9 -0
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +2 -3
- data/docs/InlineResponse2002.md +8 -0
- data/docs/InlineResponse2003.md +10 -0
- data/docs/InlineResponse201.md +1 -1
- data/docs/InlineResponse2011.md +1 -1
- data/docs/InlineResponse2012.md +1 -1
- data/docs/InlineResponse2013.md +1 -1
- data/docs/InlineResponse2014.md +1 -1
- data/docs/InlineResponse2015.md +8 -0
- data/docs/InviteAdminUser.md +11 -0
- data/docs/InviteAdminUserPrivileges.md +9 -0
- data/docs/Inviteuser.md +10 -0
- data/docs/InviteuserPrivileges.md +9 -0
- data/docs/MasterAccountApi.md +828 -117
- data/docs/MasterDetailsResponsePlanInfoFeatures.md +2 -0
- data/docs/OrderBatch.md +1 -0
- data/docs/PutRevokeUserPermission.md +8 -0
- data/docs/Putresendcancelinvitation.md +8 -0
- data/docs/RequestContactImport.md +1 -0
- data/docs/SendSmtpEmail.md +18 -19
- data/docs/SendSmtpEmailMessageVersions.md +2 -0
- data/docs/SendWhatsappMessage.md +1 -0
- data/docs/SsoTokenRequestCorporate.md +8 -0
- data/docs/SubAccountAppsToggleRequest.md +1 -1
- data/docs/SubAccountUpdatePlanRequestFeatures.md +2 -2
- data/docs/TasksApi.md +8 -8
- data/docs/TransactionalEmailsApi.md +7 -7
- data/docs/TransactionalWhatsAppApi.md +2 -2
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateCouponCollection.md +4 -1
- data/docs/UpdateWebhook.md +3 -0
- data/docs/UserApi.md +239 -0
- data/docs/WebhooksApi.md +4 -4
- data/docs/WhatsAppCampaignsApi.md +3 -1
- data/lib/brevo/api/companies_api.rb +3 -3
- data/lib/brevo/api/contacts_api.rb +14 -2
- data/lib/brevo/api/conversations_api.rb +2 -2
- data/lib/brevo/api/coupons_api.rb +15 -16
- data/lib/brevo/api/deals_api.rb +5 -5
- data/lib/brevo/api/ecommerce_api.rb +250 -0
- data/lib/brevo/api/email_campaigns_api.rb +0 -3
- data/lib/brevo/api/events_api.rb +86 -0
- data/lib/brevo/api/external_feeds_api.rb +3 -3
- data/lib/brevo/api/master_account_api.rb +652 -4
- data/lib/brevo/api/tasks_api.rb +5 -5
- data/lib/brevo/api/transactional_emails_api.rb +11 -11
- data/lib/brevo/api/transactional_whats_app_api.rb +3 -3
- data/lib/brevo/api/user_api.rb +222 -0
- data/lib/brevo/api/webhooks_api.rb +4 -4
- data/lib/brevo/api/whats_app_campaigns_api.rb +6 -0
- data/lib/brevo/models/body.rb +20 -28
- data/lib/brevo/models/body_1.rb +22 -25
- data/lib/brevo/models/body_10.rb +95 -39
- data/lib/brevo/models/body_11.rb +60 -5
- data/lib/brevo/models/body_12.rb +13 -38
- data/lib/brevo/models/body_13.rb +225 -0
- data/lib/brevo/models/body_14.rb +190 -0
- data/lib/brevo/models/body_15.rb +215 -0
- data/lib/brevo/models/body_2.rb +14 -45
- data/lib/brevo/models/body_3.rb +16 -6
- data/lib/brevo/models/body_4.rb +16 -6
- data/lib/brevo/models/body_5.rb +19 -19
- data/lib/brevo/models/body_6.rb +9 -129
- data/lib/brevo/models/body_7.rb +9 -95
- data/lib/brevo/models/body_8.rb +37 -59
- data/lib/brevo/models/body_9.rb +141 -11
- data/lib/brevo/models/conversion_source_metrics.rb +279 -0
- data/lib/brevo/models/conversion_source_product.rb +252 -0
- data/lib/brevo/models/corporate_group_details_response.rb +206 -0
- data/lib/brevo/models/corporate_group_details_response_group.rb +205 -0
- data/lib/brevo/models/corporate_group_details_response_subaccounts.rb +205 -0
- data/lib/brevo/models/corporate_group_details_response_users.rb +205 -0
- data/lib/brevo/models/create_contact.rb +1 -1
- data/lib/brevo/models/create_coupon_collection.rb +37 -7
- data/lib/brevo/models/create_domain_model.rb +11 -1
- data/lib/brevo/models/create_domain_model_dns_records.rb +13 -4
- data/lib/brevo/models/create_webhook.rb +35 -4
- data/lib/brevo/models/create_whats_app_template.rb +28 -6
- data/lib/brevo/models/event.rb +234 -0
- data/lib/brevo/models/event_identifiers.rb +236 -0
- data/lib/brevo/models/export_webhooks_history.rb +31 -4
- data/lib/brevo/models/get_contact_details.rb +0 -5
- data/lib/brevo/models/get_corporate_invited_users_list.rb +187 -0
- data/lib/brevo/models/get_corporate_invited_users_list_feature_access.rb +224 -0
- data/lib/brevo/models/get_corporate_invited_users_list_groups.rb +196 -0
- data/lib/brevo/models/get_corporate_invited_users_list_users.rb +248 -0
- data/lib/brevo/models/get_corporate_user_permission.rb +236 -0
- data/lib/brevo/models/get_corporate_user_permission_feature_access.rb +224 -0
- data/lib/brevo/models/get_corporate_user_permission_groups.rb +196 -0
- data/lib/brevo/models/get_coupon_collection.rb +40 -10
- data/lib/brevo/models/get_extended_contact_details.rb +0 -5
- data/lib/brevo/models/get_orders.rb +196 -0
- data/lib/brevo/models/get_webhook.rb +35 -4
- data/lib/brevo/models/get_webhook_auth.rb +196 -0
- data/lib/brevo/models/get_webhook_headers.rb +195 -0
- data/lib/brevo/models/inline_response_200.rb +7 -14
- data/lib/brevo/models/inline_response_200_1.rb +9 -34
- data/lib/brevo/models/inline_response_200_2.rb +191 -0
- data/lib/brevo/models/inline_response_200_3.rb +215 -0
- data/lib/brevo/models/inline_response_201.rb +0 -7
- data/lib/brevo/models/inline_response_201_1.rb +2 -2
- data/lib/brevo/models/inline_response_201_2.rb +2 -1
- data/lib/brevo/models/inline_response_201_3.rb +11 -11
- data/lib/brevo/models/inline_response_201_4.rb +11 -11
- data/lib/brevo/models/inline_response_201_5.rb +190 -0
- data/lib/brevo/models/invite_admin_user.rb +233 -0
- data/lib/brevo/models/invite_admin_user_privileges.rb +232 -0
- data/lib/brevo/models/inviteuser.rb +221 -0
- data/lib/brevo/models/inviteuser_privileges.rb +232 -0
- data/lib/brevo/models/master_details_response_plan_info_features.rb +21 -1
- data/lib/brevo/models/order_batch.rb +16 -4
- data/lib/brevo/models/put_revoke_user_permission.rb +191 -0
- data/lib/brevo/models/putresendcancelinvitation.rb +191 -0
- data/lib/brevo/models/request_contact_import.rb +13 -1
- data/lib/brevo/models/send_smtp_email_message_versions.rb +24 -4
- data/lib/brevo/models/send_whatsapp_message.rb +11 -1
- data/lib/brevo/models/sso_token_request_corporate.rb +190 -0
- data/lib/brevo/models/sub_account_apps_toggle_request.rb +1 -1
- data/lib/brevo/models/sub_account_details_response_plan_info_features_inbox.rb +1 -1
- data/lib/brevo/models/sub_account_details_response_plan_info_features_landing_page.rb +1 -1
- data/lib/brevo/models/sub_account_update_plan_request_features.rb +2 -2
- data/lib/brevo/models/update_contact.rb +1 -1
- data/lib/brevo/models/update_coupon_collection.rb +34 -9
- data/lib/brevo/models/update_webhook.rb +35 -4
- data/lib/brevo/version.rb +1 -1
- data/lib/brevo.rb +32 -0
- data/spec/api/companies_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +5 -1
- data/spec/api/conversations_api_spec.rb +1 -1
- data/spec/api/coupons_api_spec.rb +4 -3
- data/spec/api/deals_api_spec.rb +2 -2
- data/spec/api/ecommerce_api_spec.rb +57 -0
- data/spec/api/email_campaigns_api_spec.rb +0 -1
- data/spec/api/events_api_spec.rb +47 -0
- data/spec/api/external_feeds_api_spec.rb +1 -1
- data/spec/api/master_account_api_spec.rb +145 -1
- data/spec/api/tasks_api_spec.rb +2 -2
- data/spec/api/transactional_emails_api_spec.rb +3 -3
- data/spec/api/transactional_whats_app_api_spec.rb +1 -1
- data/spec/api/user_api_spec.rb +47 -0
- data/spec/api/webhooks_api_spec.rb +2 -2
- data/spec/api/whats_app_campaigns_api_spec.rb +1 -0
- data/spec/models/body_10_spec.rb +40 -4
- data/spec/models/body_11_spec.rb +30 -0
- data/spec/models/body_12_spec.rb +1 -19
- data/spec/models/body_13_spec.rb +59 -0
- data/spec/models/body_14_spec.rb +41 -0
- data/spec/models/body_15_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +2 -8
- data/spec/models/body_2_spec.rb +1 -19
- data/spec/models/body_3_spec.rb +6 -0
- data/spec/models/body_4_spec.rb +6 -0
- data/spec/models/body_5_spec.rb +2 -2
- data/spec/models/body_6_spec.rb +1 -55
- data/spec/models/body_7_spec.rb +1 -49
- data/spec/models/body_8_spec.rb +4 -16
- data/spec/models/body_9_spec.rb +61 -1
- data/spec/models/body_spec.rb +2 -8
- data/spec/models/conversion_source_metrics_spec.rb +69 -0
- data/spec/models/conversion_source_product_spec.rb +83 -0
- data/spec/models/corporate_group_details_response_group_spec.rb +53 -0
- data/spec/models/corporate_group_details_response_spec.rb +53 -0
- data/spec/models/corporate_group_details_response_subaccounts_spec.rb +53 -0
- data/spec/models/corporate_group_details_response_users_spec.rb +53 -0
- data/spec/models/create_coupon_collection_spec.rb +18 -0
- data/spec/models/create_domain_model_dns_records_spec.rb +6 -0
- data/spec/models/create_domain_model_spec.rb +6 -0
- data/spec/models/create_webhook_spec.rb +18 -0
- data/spec/models/create_whats_app_template_spec.rb +11 -1
- data/spec/models/event_identifiers_spec.rb +65 -0
- data/spec/models/event_spec.rb +65 -0
- data/spec/models/export_webhooks_history_spec.rb +11 -1
- data/spec/models/get_corporate_invited_users_list_feature_access_spec.rb +59 -0
- data/spec/models/get_corporate_invited_users_list_groups_spec.rb +47 -0
- data/spec/models/get_corporate_invited_users_list_spec.rb +41 -0
- data/spec/models/get_corporate_invited_users_list_users_spec.rb +65 -0
- data/spec/models/get_corporate_user_permission_feature_access_spec.rb +59 -0
- data/spec/models/get_corporate_user_permission_groups_spec.rb +47 -0
- data/spec/models/get_corporate_user_permission_spec.rb +59 -0
- data/spec/models/get_coupon_collection_spec.rb +18 -0
- data/spec/models/get_orders_spec.rb +47 -0
- data/spec/models/get_webhook_auth_spec.rb +47 -0
- data/spec/models/get_webhook_headers_spec.rb +47 -0
- data/spec/models/get_webhook_spec.rb +18 -0
- data/spec/models/inline_response_200_1_spec.rb +1 -7
- data/spec/models/inline_response_200_2_spec.rb +41 -0
- data/spec/models/inline_response_200_3_spec.rb +53 -0
- data/spec/models/inline_response_200_spec.rb +1 -1
- data/spec/models/inline_response_201_3_spec.rb +1 -1
- data/spec/models/inline_response_201_4_spec.rb +1 -1
- data/spec/models/inline_response_201_5_spec.rb +41 -0
- data/spec/models/invite_admin_user_privileges_spec.rb +55 -0
- data/spec/models/invite_admin_user_spec.rb +59 -0
- data/spec/models/inviteuser_privileges_spec.rb +55 -0
- data/spec/models/inviteuser_spec.rb +53 -0
- data/spec/models/master_details_response_plan_info_features_spec.rb +12 -0
- data/spec/models/order_batch_spec.rb +6 -0
- data/spec/models/put_revoke_user_permission_spec.rb +41 -0
- data/spec/models/putresendcancelinvitation_spec.rb +41 -0
- data/spec/models/request_contact_import_spec.rb +6 -0
- data/spec/models/send_smtp_email_message_versions_spec.rb +12 -0
- data/spec/models/send_whatsapp_message_spec.rb +6 -0
- data/spec/models/sso_token_request_corporate_spec.rb +41 -0
- data/spec/models/update_coupon_collection_spec.rb +18 -0
- data/spec/models/update_webhook_spec.rb +18 -0
- metadata +152 -24
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Brevo API
|
|
3
|
+
|
|
4
|
+
#Brevo 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/brevo **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@brevo.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 Brevo
|
|
16
|
+
# Revoke user permission
|
|
17
|
+
class PutRevokeUserPermission
|
|
18
|
+
# Email address of the user.
|
|
19
|
+
attr_accessor :email
|
|
20
|
+
|
|
21
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
22
|
+
def self.attribute_map
|
|
23
|
+
{
|
|
24
|
+
:'email' => :'email'
|
|
25
|
+
}
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# Attribute type mapping.
|
|
29
|
+
def self.swagger_types
|
|
30
|
+
{
|
|
31
|
+
:'email' => :'String'
|
|
32
|
+
}
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Initializes the object
|
|
36
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
37
|
+
def initialize(attributes = {})
|
|
38
|
+
return unless attributes.is_a?(Hash)
|
|
39
|
+
|
|
40
|
+
# convert string to symbol for hash key
|
|
41
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
42
|
+
|
|
43
|
+
if attributes.has_key?(:'email')
|
|
44
|
+
self.email = attributes[:'email']
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
49
|
+
# @return Array for valid properties with the reasons
|
|
50
|
+
def list_invalid_properties
|
|
51
|
+
invalid_properties = Array.new
|
|
52
|
+
if @email.nil?
|
|
53
|
+
invalid_properties.push('invalid value for "email", email cannot be nil.')
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
invalid_properties
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# Check to see if the all the properties in the model are valid
|
|
60
|
+
# @return true if the model is valid
|
|
61
|
+
def valid?
|
|
62
|
+
return false if @email.nil?
|
|
63
|
+
true
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# Checks equality by comparing each attribute.
|
|
67
|
+
# @param [Object] Object to be compared
|
|
68
|
+
def ==(o)
|
|
69
|
+
return true if self.equal?(o)
|
|
70
|
+
self.class == o.class &&
|
|
71
|
+
email == o.email
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# @see the `==` method
|
|
75
|
+
# @param [Object] Object to be compared
|
|
76
|
+
def eql?(o)
|
|
77
|
+
self == o
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Calculates hash code according to all attributes.
|
|
81
|
+
# @return [Fixnum] Hash code
|
|
82
|
+
def hash
|
|
83
|
+
[email].hash
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Builds the object from hash
|
|
87
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
88
|
+
# @return [Object] Returns the model itself
|
|
89
|
+
def build_from_hash(attributes)
|
|
90
|
+
return nil unless attributes.is_a?(Hash)
|
|
91
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
92
|
+
if type =~ /\AArray<(.*)>/i
|
|
93
|
+
# check to ensure the input is an array given that the attribute
|
|
94
|
+
# is documented as an array but the input is not
|
|
95
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
96
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
97
|
+
end
|
|
98
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
99
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
100
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
self
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# Deserializes the data based on type
|
|
107
|
+
# @param string type Data type
|
|
108
|
+
# @param string value Value to be deserialized
|
|
109
|
+
# @return [Object] Deserialized data
|
|
110
|
+
def _deserialize(type, value)
|
|
111
|
+
case type.to_sym
|
|
112
|
+
when :DateTime
|
|
113
|
+
DateTime.parse(value)
|
|
114
|
+
when :Date
|
|
115
|
+
Date.parse(value)
|
|
116
|
+
when :String
|
|
117
|
+
value.to_s
|
|
118
|
+
when :Integer
|
|
119
|
+
value.to_i
|
|
120
|
+
when :Float
|
|
121
|
+
value.to_f
|
|
122
|
+
when :BOOLEAN
|
|
123
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
124
|
+
true
|
|
125
|
+
else
|
|
126
|
+
false
|
|
127
|
+
end
|
|
128
|
+
when :Object
|
|
129
|
+
# generic object (usually a Hash), return directly
|
|
130
|
+
value
|
|
131
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
132
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
133
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
134
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
135
|
+
k_type = Regexp.last_match[:k_type]
|
|
136
|
+
v_type = Regexp.last_match[:v_type]
|
|
137
|
+
{}.tap do |hash|
|
|
138
|
+
value.each do |k, v|
|
|
139
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
else # model
|
|
143
|
+
temp_model = Brevo.const_get(type).new
|
|
144
|
+
temp_model.build_from_hash(value)
|
|
145
|
+
end
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# Returns the string representation of the object
|
|
149
|
+
# @return [String] String presentation of the object
|
|
150
|
+
def to_s
|
|
151
|
+
to_hash.to_s
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
155
|
+
# @return [Hash] Returns the object in the form of hash
|
|
156
|
+
def to_body
|
|
157
|
+
to_hash
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# Returns the object in the form of hash
|
|
161
|
+
# @return [Hash] Returns the object in the form of hash
|
|
162
|
+
def to_hash
|
|
163
|
+
hash = {}
|
|
164
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
165
|
+
value = self.send(attr)
|
|
166
|
+
next if value.nil?
|
|
167
|
+
hash[param] = _to_hash(value)
|
|
168
|
+
end
|
|
169
|
+
hash
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
# Outputs non-array value in the form of hash
|
|
173
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
174
|
+
# @param [Object] value Any valid value
|
|
175
|
+
# @return [Hash] Returns the value in the form of hash
|
|
176
|
+
def _to_hash(value)
|
|
177
|
+
if value.is_a?(Array)
|
|
178
|
+
value.compact.map { |v| _to_hash(v) }
|
|
179
|
+
elsif value.is_a?(Hash)
|
|
180
|
+
{}.tap do |hash|
|
|
181
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
182
|
+
end
|
|
183
|
+
elsif value.respond_to? :to_hash
|
|
184
|
+
value.to_hash
|
|
185
|
+
else
|
|
186
|
+
value
|
|
187
|
+
end
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
end
|
|
191
|
+
end
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Brevo API
|
|
3
|
+
|
|
4
|
+
#Brevo 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/brevo **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@brevo.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 Brevo
|
|
16
|
+
# Revoke user permission
|
|
17
|
+
class Putresendcancelinvitation
|
|
18
|
+
# Email address of the user.
|
|
19
|
+
attr_accessor :email
|
|
20
|
+
|
|
21
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
22
|
+
def self.attribute_map
|
|
23
|
+
{
|
|
24
|
+
:'email' => :'email'
|
|
25
|
+
}
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# Attribute type mapping.
|
|
29
|
+
def self.swagger_types
|
|
30
|
+
{
|
|
31
|
+
:'email' => :'String'
|
|
32
|
+
}
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Initializes the object
|
|
36
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
37
|
+
def initialize(attributes = {})
|
|
38
|
+
return unless attributes.is_a?(Hash)
|
|
39
|
+
|
|
40
|
+
# convert string to symbol for hash key
|
|
41
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
42
|
+
|
|
43
|
+
if attributes.has_key?(:'email')
|
|
44
|
+
self.email = attributes[:'email']
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
49
|
+
# @return Array for valid properties with the reasons
|
|
50
|
+
def list_invalid_properties
|
|
51
|
+
invalid_properties = Array.new
|
|
52
|
+
if @email.nil?
|
|
53
|
+
invalid_properties.push('invalid value for "email", email cannot be nil.')
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
invalid_properties
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# Check to see if the all the properties in the model are valid
|
|
60
|
+
# @return true if the model is valid
|
|
61
|
+
def valid?
|
|
62
|
+
return false if @email.nil?
|
|
63
|
+
true
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# Checks equality by comparing each attribute.
|
|
67
|
+
# @param [Object] Object to be compared
|
|
68
|
+
def ==(o)
|
|
69
|
+
return true if self.equal?(o)
|
|
70
|
+
self.class == o.class &&
|
|
71
|
+
email == o.email
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# @see the `==` method
|
|
75
|
+
# @param [Object] Object to be compared
|
|
76
|
+
def eql?(o)
|
|
77
|
+
self == o
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Calculates hash code according to all attributes.
|
|
81
|
+
# @return [Fixnum] Hash code
|
|
82
|
+
def hash
|
|
83
|
+
[email].hash
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Builds the object from hash
|
|
87
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
88
|
+
# @return [Object] Returns the model itself
|
|
89
|
+
def build_from_hash(attributes)
|
|
90
|
+
return nil unless attributes.is_a?(Hash)
|
|
91
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
92
|
+
if type =~ /\AArray<(.*)>/i
|
|
93
|
+
# check to ensure the input is an array given that the attribute
|
|
94
|
+
# is documented as an array but the input is not
|
|
95
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
96
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
97
|
+
end
|
|
98
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
99
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
100
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
self
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# Deserializes the data based on type
|
|
107
|
+
# @param string type Data type
|
|
108
|
+
# @param string value Value to be deserialized
|
|
109
|
+
# @return [Object] Deserialized data
|
|
110
|
+
def _deserialize(type, value)
|
|
111
|
+
case type.to_sym
|
|
112
|
+
when :DateTime
|
|
113
|
+
DateTime.parse(value)
|
|
114
|
+
when :Date
|
|
115
|
+
Date.parse(value)
|
|
116
|
+
when :String
|
|
117
|
+
value.to_s
|
|
118
|
+
when :Integer
|
|
119
|
+
value.to_i
|
|
120
|
+
when :Float
|
|
121
|
+
value.to_f
|
|
122
|
+
when :BOOLEAN
|
|
123
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
124
|
+
true
|
|
125
|
+
else
|
|
126
|
+
false
|
|
127
|
+
end
|
|
128
|
+
when :Object
|
|
129
|
+
# generic object (usually a Hash), return directly
|
|
130
|
+
value
|
|
131
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
132
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
133
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
134
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
135
|
+
k_type = Regexp.last_match[:k_type]
|
|
136
|
+
v_type = Regexp.last_match[:v_type]
|
|
137
|
+
{}.tap do |hash|
|
|
138
|
+
value.each do |k, v|
|
|
139
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
else # model
|
|
143
|
+
temp_model = Brevo.const_get(type).new
|
|
144
|
+
temp_model.build_from_hash(value)
|
|
145
|
+
end
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# Returns the string representation of the object
|
|
149
|
+
# @return [String] String presentation of the object
|
|
150
|
+
def to_s
|
|
151
|
+
to_hash.to_s
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
155
|
+
# @return [Hash] Returns the object in the form of hash
|
|
156
|
+
def to_body
|
|
157
|
+
to_hash
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# Returns the object in the form of hash
|
|
161
|
+
# @return [Hash] Returns the object in the form of hash
|
|
162
|
+
def to_hash
|
|
163
|
+
hash = {}
|
|
164
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
165
|
+
value = self.send(attr)
|
|
166
|
+
next if value.nil?
|
|
167
|
+
hash[param] = _to_hash(value)
|
|
168
|
+
end
|
|
169
|
+
hash
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
# Outputs non-array value in the form of hash
|
|
173
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
174
|
+
# @param [Object] value Any valid value
|
|
175
|
+
# @return [Hash] Returns the value in the form of hash
|
|
176
|
+
def _to_hash(value)
|
|
177
|
+
if value.is_a?(Array)
|
|
178
|
+
value.compact.map { |v| _to_hash(v) }
|
|
179
|
+
elsif value.is_a?(Hash)
|
|
180
|
+
{}.tap do |hash|
|
|
181
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
182
|
+
end
|
|
183
|
+
elsif value.respond_to? :to_hash
|
|
184
|
+
value.to_hash
|
|
185
|
+
else
|
|
186
|
+
value
|
|
187
|
+
end
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
end
|
|
191
|
+
end
|
|
@@ -34,6 +34,9 @@ module Brevo
|
|
|
34
34
|
# To blacklist all the contacts for email
|
|
35
35
|
attr_accessor :email_blacklist
|
|
36
36
|
|
|
37
|
+
# To disable email notification
|
|
38
|
+
attr_accessor :disable_notification
|
|
39
|
+
|
|
37
40
|
# To blacklist all the contacts for sms
|
|
38
41
|
attr_accessor :sms_blacklist
|
|
39
42
|
|
|
@@ -53,6 +56,7 @@ module Brevo
|
|
|
53
56
|
:'notify_url' => :'notifyUrl',
|
|
54
57
|
:'new_list' => :'newList',
|
|
55
58
|
:'email_blacklist' => :'emailBlacklist',
|
|
59
|
+
:'disable_notification' => :'disableNotification',
|
|
56
60
|
:'sms_blacklist' => :'smsBlacklist',
|
|
57
61
|
:'update_existing_contacts' => :'updateExistingContacts',
|
|
58
62
|
:'empty_contacts_attributes' => :'emptyContactsAttributes'
|
|
@@ -69,6 +73,7 @@ module Brevo
|
|
|
69
73
|
:'notify_url' => :'String',
|
|
70
74
|
:'new_list' => :'RequestContactImportNewList',
|
|
71
75
|
:'email_blacklist' => :'BOOLEAN',
|
|
76
|
+
:'disable_notification' => :'BOOLEAN',
|
|
72
77
|
:'sms_blacklist' => :'BOOLEAN',
|
|
73
78
|
:'update_existing_contacts' => :'BOOLEAN',
|
|
74
79
|
:'empty_contacts_attributes' => :'BOOLEAN'
|
|
@@ -117,6 +122,12 @@ module Brevo
|
|
|
117
122
|
self.email_blacklist = false
|
|
118
123
|
end
|
|
119
124
|
|
|
125
|
+
if attributes.has_key?(:'disableNotification')
|
|
126
|
+
self.disable_notification = attributes[:'disableNotification']
|
|
127
|
+
else
|
|
128
|
+
self.disable_notification = false
|
|
129
|
+
end
|
|
130
|
+
|
|
120
131
|
if attributes.has_key?(:'smsBlacklist')
|
|
121
132
|
self.sms_blacklist = attributes[:'smsBlacklist']
|
|
122
133
|
else
|
|
@@ -161,6 +172,7 @@ module Brevo
|
|
|
161
172
|
notify_url == o.notify_url &&
|
|
162
173
|
new_list == o.new_list &&
|
|
163
174
|
email_blacklist == o.email_blacklist &&
|
|
175
|
+
disable_notification == o.disable_notification &&
|
|
164
176
|
sms_blacklist == o.sms_blacklist &&
|
|
165
177
|
update_existing_contacts == o.update_existing_contacts &&
|
|
166
178
|
empty_contacts_attributes == o.empty_contacts_attributes
|
|
@@ -175,7 +187,7 @@ module Brevo
|
|
|
175
187
|
# Calculates hash code according to all attributes.
|
|
176
188
|
# @return [Fixnum] Hash code
|
|
177
189
|
def hash
|
|
178
|
-
[file_url, file_body, json_body, list_ids, notify_url, new_list, email_blacklist, sms_blacklist, update_existing_contacts, empty_contacts_attributes].hash
|
|
190
|
+
[file_url, file_body, json_body, list_ids, notify_url, new_list, email_blacklist, disable_notification, sms_blacklist, update_existing_contacts, empty_contacts_attributes].hash
|
|
179
191
|
end
|
|
180
192
|
|
|
181
193
|
# Builds the object from hash
|
|
@@ -31,6 +31,12 @@ module Brevo
|
|
|
31
31
|
# Custom subject specific to message version
|
|
32
32
|
attr_accessor :subject
|
|
33
33
|
|
|
34
|
+
# HTML body of the message. **Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed**
|
|
35
|
+
attr_accessor :html_content
|
|
36
|
+
|
|
37
|
+
# Plain Text body of the message. **Ignored if 'templateId' is passed**
|
|
38
|
+
attr_accessor :text_content
|
|
39
|
+
|
|
34
40
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
35
41
|
def self.attribute_map
|
|
36
42
|
{
|
|
@@ -39,7 +45,9 @@ module Brevo
|
|
|
39
45
|
:'bcc' => :'bcc',
|
|
40
46
|
:'cc' => :'cc',
|
|
41
47
|
:'reply_to' => :'replyTo',
|
|
42
|
-
:'subject' => :'subject'
|
|
48
|
+
:'subject' => :'subject',
|
|
49
|
+
:'html_content' => :'htmlContent',
|
|
50
|
+
:'text_content' => :'textContent'
|
|
43
51
|
}
|
|
44
52
|
end
|
|
45
53
|
|
|
@@ -51,7 +59,9 @@ module Brevo
|
|
|
51
59
|
:'bcc' => :'Array<SendSmtpEmailBcc>',
|
|
52
60
|
:'cc' => :'Array<SendSmtpEmailCc>',
|
|
53
61
|
:'reply_to' => :'SendSmtpEmailReplyTo1',
|
|
54
|
-
:'subject' => :'String'
|
|
62
|
+
:'subject' => :'String',
|
|
63
|
+
:'html_content' => :'String',
|
|
64
|
+
:'text_content' => :'String'
|
|
55
65
|
}
|
|
56
66
|
end
|
|
57
67
|
|
|
@@ -94,6 +104,14 @@ module Brevo
|
|
|
94
104
|
if attributes.has_key?(:'subject')
|
|
95
105
|
self.subject = attributes[:'subject']
|
|
96
106
|
end
|
|
107
|
+
|
|
108
|
+
if attributes.has_key?(:'htmlContent')
|
|
109
|
+
self.html_content = attributes[:'htmlContent']
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
if attributes.has_key?(:'textContent')
|
|
113
|
+
self.text_content = attributes[:'textContent']
|
|
114
|
+
end
|
|
97
115
|
end
|
|
98
116
|
|
|
99
117
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -124,7 +142,9 @@ module Brevo
|
|
|
124
142
|
bcc == o.bcc &&
|
|
125
143
|
cc == o.cc &&
|
|
126
144
|
reply_to == o.reply_to &&
|
|
127
|
-
subject == o.subject
|
|
145
|
+
subject == o.subject &&
|
|
146
|
+
html_content == o.html_content &&
|
|
147
|
+
text_content == o.text_content
|
|
128
148
|
end
|
|
129
149
|
|
|
130
150
|
# @see the `==` method
|
|
@@ -136,7 +156,7 @@ module Brevo
|
|
|
136
156
|
# Calculates hash code according to all attributes.
|
|
137
157
|
# @return [Fixnum] Hash code
|
|
138
158
|
def hash
|
|
139
|
-
[to, params, bcc, cc, reply_to, subject].hash
|
|
159
|
+
[to, params, bcc, cc, reply_to, subject, html_content, text_content].hash
|
|
140
160
|
end
|
|
141
161
|
|
|
142
162
|
# Builds the object from hash
|
|
@@ -23,6 +23,9 @@ module Brevo
|
|
|
23
23
|
# WhatsApp Number with country code. Example, 85264318721
|
|
24
24
|
attr_accessor :sender_number
|
|
25
25
|
|
|
26
|
+
# Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}.
|
|
27
|
+
attr_accessor :params
|
|
28
|
+
|
|
26
29
|
# List of phone numbers of the contacts
|
|
27
30
|
attr_accessor :contact_numbers
|
|
28
31
|
|
|
@@ -32,6 +35,7 @@ module Brevo
|
|
|
32
35
|
:'template_id' => :'templateId',
|
|
33
36
|
:'text' => :'text',
|
|
34
37
|
:'sender_number' => :'senderNumber',
|
|
38
|
+
:'params' => :'params',
|
|
35
39
|
:'contact_numbers' => :'contactNumbers'
|
|
36
40
|
}
|
|
37
41
|
end
|
|
@@ -42,6 +46,7 @@ module Brevo
|
|
|
42
46
|
:'template_id' => :'Integer',
|
|
43
47
|
:'text' => :'String',
|
|
44
48
|
:'sender_number' => :'String',
|
|
49
|
+
:'params' => :'Object',
|
|
45
50
|
:'contact_numbers' => :'Array<String>'
|
|
46
51
|
}
|
|
47
52
|
end
|
|
@@ -66,6 +71,10 @@ module Brevo
|
|
|
66
71
|
self.sender_number = attributes[:'senderNumber']
|
|
67
72
|
end
|
|
68
73
|
|
|
74
|
+
if attributes.has_key?(:'params')
|
|
75
|
+
self.params = attributes[:'params']
|
|
76
|
+
end
|
|
77
|
+
|
|
69
78
|
if attributes.has_key?(:'contactNumbers')
|
|
70
79
|
if (value = attributes[:'contactNumbers']).is_a?(Array)
|
|
71
80
|
self.contact_numbers = value
|
|
@@ -104,6 +113,7 @@ module Brevo
|
|
|
104
113
|
template_id == o.template_id &&
|
|
105
114
|
text == o.text &&
|
|
106
115
|
sender_number == o.sender_number &&
|
|
116
|
+
params == o.params &&
|
|
107
117
|
contact_numbers == o.contact_numbers
|
|
108
118
|
end
|
|
109
119
|
|
|
@@ -116,7 +126,7 @@ module Brevo
|
|
|
116
126
|
# Calculates hash code according to all attributes.
|
|
117
127
|
# @return [Fixnum] Hash code
|
|
118
128
|
def hash
|
|
119
|
-
[template_id, text, sender_number, contact_numbers].hash
|
|
129
|
+
[template_id, text, sender_number, params, contact_numbers].hash
|
|
120
130
|
end
|
|
121
131
|
|
|
122
132
|
# Builds the object from hash
|