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,190 @@
|
|
|
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
|
+
class SsoTokenRequestCorporate
|
|
17
|
+
# User email of sub-account organization
|
|
18
|
+
attr_accessor :email
|
|
19
|
+
|
|
20
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
21
|
+
def self.attribute_map
|
|
22
|
+
{
|
|
23
|
+
:'email' => :'email'
|
|
24
|
+
}
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Attribute type mapping.
|
|
28
|
+
def self.swagger_types
|
|
29
|
+
{
|
|
30
|
+
:'email' => :'String'
|
|
31
|
+
}
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Initializes the object
|
|
35
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
36
|
+
def initialize(attributes = {})
|
|
37
|
+
return unless attributes.is_a?(Hash)
|
|
38
|
+
|
|
39
|
+
# convert string to symbol for hash key
|
|
40
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
41
|
+
|
|
42
|
+
if attributes.has_key?(:'email')
|
|
43
|
+
self.email = attributes[:'email']
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
48
|
+
# @return Array for valid properties with the reasons
|
|
49
|
+
def list_invalid_properties
|
|
50
|
+
invalid_properties = Array.new
|
|
51
|
+
if @email.nil?
|
|
52
|
+
invalid_properties.push('invalid value for "email", email cannot be nil.')
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
invalid_properties
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
# Check to see if the all the properties in the model are valid
|
|
59
|
+
# @return true if the model is valid
|
|
60
|
+
def valid?
|
|
61
|
+
return false if @email.nil?
|
|
62
|
+
true
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# Checks equality by comparing each attribute.
|
|
66
|
+
# @param [Object] Object to be compared
|
|
67
|
+
def ==(o)
|
|
68
|
+
return true if self.equal?(o)
|
|
69
|
+
self.class == o.class &&
|
|
70
|
+
email == o.email
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# @see the `==` method
|
|
74
|
+
# @param [Object] Object to be compared
|
|
75
|
+
def eql?(o)
|
|
76
|
+
self == o
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Calculates hash code according to all attributes.
|
|
80
|
+
# @return [Fixnum] Hash code
|
|
81
|
+
def hash
|
|
82
|
+
[email].hash
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Builds the object from hash
|
|
86
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
87
|
+
# @return [Object] Returns the model itself
|
|
88
|
+
def build_from_hash(attributes)
|
|
89
|
+
return nil unless attributes.is_a?(Hash)
|
|
90
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
91
|
+
if type =~ /\AArray<(.*)>/i
|
|
92
|
+
# check to ensure the input is an array given that the attribute
|
|
93
|
+
# is documented as an array but the input is not
|
|
94
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
95
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
96
|
+
end
|
|
97
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
98
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
99
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
self
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Deserializes the data based on type
|
|
106
|
+
# @param string type Data type
|
|
107
|
+
# @param string value Value to be deserialized
|
|
108
|
+
# @return [Object] Deserialized data
|
|
109
|
+
def _deserialize(type, value)
|
|
110
|
+
case type.to_sym
|
|
111
|
+
when :DateTime
|
|
112
|
+
DateTime.parse(value)
|
|
113
|
+
when :Date
|
|
114
|
+
Date.parse(value)
|
|
115
|
+
when :String
|
|
116
|
+
value.to_s
|
|
117
|
+
when :Integer
|
|
118
|
+
value.to_i
|
|
119
|
+
when :Float
|
|
120
|
+
value.to_f
|
|
121
|
+
when :BOOLEAN
|
|
122
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
123
|
+
true
|
|
124
|
+
else
|
|
125
|
+
false
|
|
126
|
+
end
|
|
127
|
+
when :Object
|
|
128
|
+
# generic object (usually a Hash), return directly
|
|
129
|
+
value
|
|
130
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
131
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
132
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
133
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
134
|
+
k_type = Regexp.last_match[:k_type]
|
|
135
|
+
v_type = Regexp.last_match[:v_type]
|
|
136
|
+
{}.tap do |hash|
|
|
137
|
+
value.each do |k, v|
|
|
138
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
else # model
|
|
142
|
+
temp_model = Brevo.const_get(type).new
|
|
143
|
+
temp_model.build_from_hash(value)
|
|
144
|
+
end
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# Returns the string representation of the object
|
|
148
|
+
# @return [String] String presentation of the object
|
|
149
|
+
def to_s
|
|
150
|
+
to_hash.to_s
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
154
|
+
# @return [Hash] Returns the object in the form of hash
|
|
155
|
+
def to_body
|
|
156
|
+
to_hash
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
# Returns the object in the form of hash
|
|
160
|
+
# @return [Hash] Returns the object in the form of hash
|
|
161
|
+
def to_hash
|
|
162
|
+
hash = {}
|
|
163
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
164
|
+
value = self.send(attr)
|
|
165
|
+
next if value.nil?
|
|
166
|
+
hash[param] = _to_hash(value)
|
|
167
|
+
end
|
|
168
|
+
hash
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Outputs non-array value in the form of hash
|
|
172
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
173
|
+
# @param [Object] value Any valid value
|
|
174
|
+
# @return [Hash] Returns the value in the form of hash
|
|
175
|
+
def _to_hash(value)
|
|
176
|
+
if value.is_a?(Array)
|
|
177
|
+
value.compact.map { |v| _to_hash(v) }
|
|
178
|
+
elsif value.is_a?(Hash)
|
|
179
|
+
{}.tap do |hash|
|
|
180
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
181
|
+
end
|
|
182
|
+
elsif value.respond_to? :to_hash
|
|
183
|
+
value.to_hash
|
|
184
|
+
else
|
|
185
|
+
value
|
|
186
|
+
end
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
end
|
|
190
|
+
end
|
|
@@ -15,7 +15,7 @@ require 'date'
|
|
|
15
15
|
module Brevo
|
|
16
16
|
# List of enable/disable applications on the sub-account
|
|
17
17
|
class SubAccountAppsToggleRequest
|
|
18
|
-
# Set this field to enable or disable Inbox on the sub-account
|
|
18
|
+
# Set this field to enable or disable Inbox on the sub-account / Not applicable on ENTv2
|
|
19
19
|
attr_accessor :inbox
|
|
20
20
|
|
|
21
21
|
# Set this field to enable or disable Whatsapp campaigns on the sub-account
|
|
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.4.19
|
|
|
13
13
|
require 'date'
|
|
14
14
|
|
|
15
15
|
module Brevo
|
|
16
|
-
# Landing page details
|
|
16
|
+
# Landing page details / Not available on ENTv2
|
|
17
17
|
class SubAccountDetailsResponsePlanInfoFeaturesLandingPage
|
|
18
18
|
# Quantity of landing pages provided
|
|
19
19
|
attr_accessor :quantity
|
|
@@ -18,10 +18,10 @@ module Brevo
|
|
|
18
18
|
# Number of multi-users
|
|
19
19
|
attr_accessor :users
|
|
20
20
|
|
|
21
|
-
# Number of landing pages
|
|
21
|
+
# Number of landing pages / Not required on ENTv2
|
|
22
22
|
attr_accessor :landing_page
|
|
23
23
|
|
|
24
|
-
# Number of inboxes
|
|
24
|
+
# Number of inboxes / Not required on ENTv2
|
|
25
25
|
attr_accessor :inbox
|
|
26
26
|
|
|
27
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
|
|
15
15
|
module Brevo
|
|
16
16
|
class UpdateContact
|
|
17
|
-
# 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\"}
|
|
17
|
+
# Pass the set of attributes to be updated. These attributes must be present in your account. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored.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\"}
|
|
18
18
|
attr_accessor :attributes
|
|
19
19
|
|
|
20
20
|
# Pass your own Id to update ext_id of a contact.
|
|
@@ -17,17 +17,32 @@ module Brevo
|
|
|
17
17
|
# A default coupon to be used in case there are no coupons left
|
|
18
18
|
attr_accessor :default_coupon
|
|
19
19
|
|
|
20
|
+
# Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.
|
|
21
|
+
attr_accessor :expiration_date
|
|
22
|
+
|
|
23
|
+
# Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.
|
|
24
|
+
attr_accessor :remaining_days_alert
|
|
25
|
+
|
|
26
|
+
# Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.
|
|
27
|
+
attr_accessor :remaining_coupons_alert
|
|
28
|
+
|
|
20
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
21
30
|
def self.attribute_map
|
|
22
31
|
{
|
|
23
|
-
:'default_coupon' => :'defaultCoupon'
|
|
32
|
+
:'default_coupon' => :'defaultCoupon',
|
|
33
|
+
:'expiration_date' => :'expirationDate',
|
|
34
|
+
:'remaining_days_alert' => :'remainingDaysAlert',
|
|
35
|
+
:'remaining_coupons_alert' => :'remainingCouponsAlert'
|
|
24
36
|
}
|
|
25
37
|
end
|
|
26
38
|
|
|
27
39
|
# Attribute type mapping.
|
|
28
40
|
def self.swagger_types
|
|
29
41
|
{
|
|
30
|
-
:'default_coupon' => :'String'
|
|
42
|
+
:'default_coupon' => :'String',
|
|
43
|
+
:'expiration_date' => :'DateTime',
|
|
44
|
+
:'remaining_days_alert' => :'Integer',
|
|
45
|
+
:'remaining_coupons_alert' => :'Integer'
|
|
31
46
|
}
|
|
32
47
|
end
|
|
33
48
|
|
|
@@ -42,23 +57,30 @@ module Brevo
|
|
|
42
57
|
if attributes.has_key?(:'defaultCoupon')
|
|
43
58
|
self.default_coupon = attributes[:'defaultCoupon']
|
|
44
59
|
end
|
|
60
|
+
|
|
61
|
+
if attributes.has_key?(:'expirationDate')
|
|
62
|
+
self.expiration_date = attributes[:'expirationDate']
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
if attributes.has_key?(:'remainingDaysAlert')
|
|
66
|
+
self.remaining_days_alert = attributes[:'remainingDaysAlert']
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
if attributes.has_key?(:'remainingCouponsAlert')
|
|
70
|
+
self.remaining_coupons_alert = attributes[:'remainingCouponsAlert']
|
|
71
|
+
end
|
|
45
72
|
end
|
|
46
73
|
|
|
47
74
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
48
75
|
# @return Array for valid properties with the reasons
|
|
49
76
|
def list_invalid_properties
|
|
50
77
|
invalid_properties = Array.new
|
|
51
|
-
if @default_coupon.nil?
|
|
52
|
-
invalid_properties.push('invalid value for "default_coupon", default_coupon cannot be nil.')
|
|
53
|
-
end
|
|
54
|
-
|
|
55
78
|
invalid_properties
|
|
56
79
|
end
|
|
57
80
|
|
|
58
81
|
# Check to see if the all the properties in the model are valid
|
|
59
82
|
# @return true if the model is valid
|
|
60
83
|
def valid?
|
|
61
|
-
return false if @default_coupon.nil?
|
|
62
84
|
true
|
|
63
85
|
end
|
|
64
86
|
|
|
@@ -67,7 +89,10 @@ module Brevo
|
|
|
67
89
|
def ==(o)
|
|
68
90
|
return true if self.equal?(o)
|
|
69
91
|
self.class == o.class &&
|
|
70
|
-
default_coupon == o.default_coupon
|
|
92
|
+
default_coupon == o.default_coupon &&
|
|
93
|
+
expiration_date == o.expiration_date &&
|
|
94
|
+
remaining_days_alert == o.remaining_days_alert &&
|
|
95
|
+
remaining_coupons_alert == o.remaining_coupons_alert
|
|
71
96
|
end
|
|
72
97
|
|
|
73
98
|
# @see the `==` method
|
|
@@ -79,7 +104,7 @@ module Brevo
|
|
|
79
104
|
# Calculates hash code according to all attributes.
|
|
80
105
|
# @return [Fixnum] Hash code
|
|
81
106
|
def hash
|
|
82
|
-
[default_coupon].hash
|
|
107
|
+
[default_coupon, expiration_date, remaining_days_alert, remaining_coupons_alert].hash
|
|
83
108
|
end
|
|
84
109
|
|
|
85
110
|
# Builds the object from hash
|
|
@@ -26,6 +26,14 @@ module Brevo
|
|
|
26
26
|
# Inbound domain of webhook, used in case of event type `inbound`
|
|
27
27
|
attr_accessor :domain
|
|
28
28
|
|
|
29
|
+
# To send batched webhooks
|
|
30
|
+
attr_accessor :batched
|
|
31
|
+
|
|
32
|
+
attr_accessor :auth
|
|
33
|
+
|
|
34
|
+
# Custom headers to be send with webhooks
|
|
35
|
+
attr_accessor :headers
|
|
36
|
+
|
|
29
37
|
class EnumAttributeValidator
|
|
30
38
|
attr_reader :datatype
|
|
31
39
|
attr_reader :allowable_values
|
|
@@ -54,7 +62,10 @@ module Brevo
|
|
|
54
62
|
:'url' => :'url',
|
|
55
63
|
:'description' => :'description',
|
|
56
64
|
:'events' => :'events',
|
|
57
|
-
:'domain' => :'domain'
|
|
65
|
+
:'domain' => :'domain',
|
|
66
|
+
:'batched' => :'batched',
|
|
67
|
+
:'auth' => :'auth',
|
|
68
|
+
:'headers' => :'headers'
|
|
58
69
|
}
|
|
59
70
|
end
|
|
60
71
|
|
|
@@ -64,7 +75,10 @@ module Brevo
|
|
|
64
75
|
:'url' => :'String',
|
|
65
76
|
:'description' => :'String',
|
|
66
77
|
:'events' => :'Array<String>',
|
|
67
|
-
:'domain' => :'String'
|
|
78
|
+
:'domain' => :'String',
|
|
79
|
+
:'batched' => :'BOOLEAN',
|
|
80
|
+
:'auth' => :'GetWebhookAuth',
|
|
81
|
+
:'headers' => :'Array<GetWebhookHeaders>'
|
|
68
82
|
}
|
|
69
83
|
end
|
|
70
84
|
|
|
@@ -93,6 +107,20 @@ module Brevo
|
|
|
93
107
|
if attributes.has_key?(:'domain')
|
|
94
108
|
self.domain = attributes[:'domain']
|
|
95
109
|
end
|
|
110
|
+
|
|
111
|
+
if attributes.has_key?(:'batched')
|
|
112
|
+
self.batched = attributes[:'batched']
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
if attributes.has_key?(:'auth')
|
|
116
|
+
self.auth = attributes[:'auth']
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
if attributes.has_key?(:'headers')
|
|
120
|
+
if (value = attributes[:'headers']).is_a?(Array)
|
|
121
|
+
self.headers = value
|
|
122
|
+
end
|
|
123
|
+
end
|
|
96
124
|
end
|
|
97
125
|
|
|
98
126
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -116,7 +144,10 @@ module Brevo
|
|
|
116
144
|
url == o.url &&
|
|
117
145
|
description == o.description &&
|
|
118
146
|
events == o.events &&
|
|
119
|
-
domain == o.domain
|
|
147
|
+
domain == o.domain &&
|
|
148
|
+
batched == o.batched &&
|
|
149
|
+
auth == o.auth &&
|
|
150
|
+
headers == o.headers
|
|
120
151
|
end
|
|
121
152
|
|
|
122
153
|
# @see the `==` method
|
|
@@ -128,7 +159,7 @@ module Brevo
|
|
|
128
159
|
# Calculates hash code according to all attributes.
|
|
129
160
|
# @return [Fixnum] Hash code
|
|
130
161
|
def hash
|
|
131
|
-
[url, description, events, domain].hash
|
|
162
|
+
[url, description, events, domain, batched, auth, headers].hash
|
|
132
163
|
end
|
|
133
164
|
|
|
134
165
|
# Builds the object from hash
|
data/lib/brevo/version.rb
CHANGED
data/lib/brevo.rb
CHANGED
|
@@ -33,6 +33,9 @@ require 'brevo/models/body_1'
|
|
|
33
33
|
require 'brevo/models/body_10'
|
|
34
34
|
require 'brevo/models/body_11'
|
|
35
35
|
require 'brevo/models/body_12'
|
|
36
|
+
require 'brevo/models/body_13'
|
|
37
|
+
require 'brevo/models/body_14'
|
|
38
|
+
require 'brevo/models/body_15'
|
|
36
39
|
require 'brevo/models/body_2'
|
|
37
40
|
require 'brevo/models/body_3'
|
|
38
41
|
require 'brevo/models/body_4'
|
|
@@ -50,6 +53,12 @@ require 'brevo/models/component_items'
|
|
|
50
53
|
require 'brevo/models/conversations_message'
|
|
51
54
|
require 'brevo/models/conversations_message_file'
|
|
52
55
|
require 'brevo/models/conversations_message_file_image_info'
|
|
56
|
+
require 'brevo/models/conversion_source_metrics'
|
|
57
|
+
require 'brevo/models/conversion_source_product'
|
|
58
|
+
require 'brevo/models/corporate_group_details_response'
|
|
59
|
+
require 'brevo/models/corporate_group_details_response_group'
|
|
60
|
+
require 'brevo/models/corporate_group_details_response_subaccounts'
|
|
61
|
+
require 'brevo/models/corporate_group_details_response_users'
|
|
53
62
|
require 'brevo/models/create_api_key_request'
|
|
54
63
|
require 'brevo/models/create_api_key_response'
|
|
55
64
|
require 'brevo/models/create_attribute'
|
|
@@ -105,6 +114,8 @@ require 'brevo/models/deals_list'
|
|
|
105
114
|
require 'brevo/models/delete_hardbounces'
|
|
106
115
|
require 'brevo/models/email_export_recipients'
|
|
107
116
|
require 'brevo/models/error_model'
|
|
117
|
+
require 'brevo/models/event'
|
|
118
|
+
require 'brevo/models/event_identifiers'
|
|
108
119
|
require 'brevo/models/export_webhooks_history'
|
|
109
120
|
require 'brevo/models/file_data'
|
|
110
121
|
require 'brevo/models/file_downloadable_link'
|
|
@@ -146,6 +157,13 @@ require 'brevo/models/get_contact_campaign_stats_transac_attributes'
|
|
|
146
157
|
require 'brevo/models/get_contact_campaign_stats_unsubscriptions'
|
|
147
158
|
require 'brevo/models/get_contact_details'
|
|
148
159
|
require 'brevo/models/get_contacts'
|
|
160
|
+
require 'brevo/models/get_corporate_invited_users_list'
|
|
161
|
+
require 'brevo/models/get_corporate_invited_users_list_feature_access'
|
|
162
|
+
require 'brevo/models/get_corporate_invited_users_list_groups'
|
|
163
|
+
require 'brevo/models/get_corporate_invited_users_list_users'
|
|
164
|
+
require 'brevo/models/get_corporate_user_permission'
|
|
165
|
+
require 'brevo/models/get_corporate_user_permission_feature_access'
|
|
166
|
+
require 'brevo/models/get_corporate_user_permission_groups'
|
|
149
167
|
require 'brevo/models/get_coupon_collection'
|
|
150
168
|
require 'brevo/models/get_device_browser_stats'
|
|
151
169
|
require 'brevo/models/get_domain_configuration_model'
|
|
@@ -192,6 +210,7 @@ require 'brevo/models/get_ips'
|
|
|
192
210
|
require 'brevo/models/get_ips_from_sender'
|
|
193
211
|
require 'brevo/models/get_list'
|
|
194
212
|
require 'brevo/models/get_lists'
|
|
213
|
+
require 'brevo/models/get_orders'
|
|
195
214
|
require 'brevo/models/get_process'
|
|
196
215
|
require 'brevo/models/get_processes'
|
|
197
216
|
require 'brevo/models/get_product_details'
|
|
@@ -236,6 +255,8 @@ require 'brevo/models/get_user_permission_privileges'
|
|
|
236
255
|
require 'brevo/models/get_wa_templates'
|
|
237
256
|
require 'brevo/models/get_wa_templates_templates'
|
|
238
257
|
require 'brevo/models/get_webhook'
|
|
258
|
+
require 'brevo/models/get_webhook_auth'
|
|
259
|
+
require 'brevo/models/get_webhook_headers'
|
|
239
260
|
require 'brevo/models/get_webhooks'
|
|
240
261
|
require 'brevo/models/get_whats_app_config'
|
|
241
262
|
require 'brevo/models/get_whatsapp_campaign_overview'
|
|
@@ -245,11 +266,18 @@ require 'brevo/models/get_whatsapp_event_report'
|
|
|
245
266
|
require 'brevo/models/get_whatsapp_event_report_events'
|
|
246
267
|
require 'brevo/models/inline_response_200'
|
|
247
268
|
require 'brevo/models/inline_response_200_1'
|
|
269
|
+
require 'brevo/models/inline_response_200_2'
|
|
270
|
+
require 'brevo/models/inline_response_200_3'
|
|
248
271
|
require 'brevo/models/inline_response_201'
|
|
249
272
|
require 'brevo/models/inline_response_201_1'
|
|
250
273
|
require 'brevo/models/inline_response_201_2'
|
|
251
274
|
require 'brevo/models/inline_response_201_3'
|
|
252
275
|
require 'brevo/models/inline_response_201_4'
|
|
276
|
+
require 'brevo/models/inline_response_201_5'
|
|
277
|
+
require 'brevo/models/invite_admin_user'
|
|
278
|
+
require 'brevo/models/invite_admin_user_privileges'
|
|
279
|
+
require 'brevo/models/inviteuser'
|
|
280
|
+
require 'brevo/models/inviteuser_privileges'
|
|
253
281
|
require 'brevo/models/manage_ip'
|
|
254
282
|
require 'brevo/models/master_details_response'
|
|
255
283
|
require 'brevo/models/master_details_response_billing_info'
|
|
@@ -273,6 +301,8 @@ require 'brevo/models/post_contact_info'
|
|
|
273
301
|
require 'brevo/models/post_contact_info_contacts'
|
|
274
302
|
require 'brevo/models/post_send_failed'
|
|
275
303
|
require 'brevo/models/post_send_sms_test_failed'
|
|
304
|
+
require 'brevo/models/put_revoke_user_permission'
|
|
305
|
+
require 'brevo/models/putresendcancelinvitation'
|
|
276
306
|
require 'brevo/models/remaining_credit_model'
|
|
277
307
|
require 'brevo/models/remaining_credit_model_child'
|
|
278
308
|
require 'brevo/models/remaining_credit_model_reseller'
|
|
@@ -303,6 +333,7 @@ require 'brevo/models/send_test_sms'
|
|
|
303
333
|
require 'brevo/models/send_transac_sms'
|
|
304
334
|
require 'brevo/models/send_whatsapp_message'
|
|
305
335
|
require 'brevo/models/sso_token_request'
|
|
336
|
+
require 'brevo/models/sso_token_request_corporate'
|
|
306
337
|
require 'brevo/models/sub_account_apps_toggle_request'
|
|
307
338
|
require 'brevo/models/sub_account_details_response'
|
|
308
339
|
require 'brevo/models/sub_account_details_response_plan_info'
|
|
@@ -359,6 +390,7 @@ require 'brevo/api/deals_api'
|
|
|
359
390
|
require 'brevo/api/domains_api'
|
|
360
391
|
require 'brevo/api/ecommerce_api'
|
|
361
392
|
require 'brevo/api/email_campaigns_api'
|
|
393
|
+
require 'brevo/api/events_api'
|
|
362
394
|
require 'brevo/api/external_feeds_api'
|
|
363
395
|
require 'brevo/api/files_api'
|
|
364
396
|
require 'brevo/api/inbound_parsing_api'
|
|
@@ -109,7 +109,7 @@ describe 'CompaniesApi' do
|
|
|
109
109
|
# Create a company
|
|
110
110
|
# @param body Company create data.
|
|
111
111
|
# @param [Hash] opts the optional parameters
|
|
112
|
-
# @return [
|
|
112
|
+
# @return [InlineResponse2002]
|
|
113
113
|
describe 'companies_post test' do
|
|
114
114
|
it 'should work' do
|
|
115
115
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -191,6 +191,8 @@ describe 'ContactsApi' do
|
|
|
191
191
|
# @option opts [String] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
192
192
|
# @option opts [String] :created_since Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
193
193
|
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
194
|
+
# @option opts [Integer] :segment_id Id of the segment. **Either listIds or segmentId can be passed.**
|
|
195
|
+
# @option opts [Array<Integer>] :list_ids Ids of the list. **Either listIds or segmentId can be passed.**
|
|
194
196
|
# @return [GetContacts]
|
|
195
197
|
describe 'get_contacts test' do
|
|
196
198
|
it 'should work' do
|
|
@@ -255,6 +257,8 @@ describe 'ContactsApi' do
|
|
|
255
257
|
# Get a list's details
|
|
256
258
|
# @param list_id Id of the list
|
|
257
259
|
# @param [Hash] opts the optional parameters
|
|
260
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id.Prefer to pass your timezone in date-time format for accurate result
|
|
261
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id.Prefer to pass your timezone in date-time format for accurate result
|
|
258
262
|
# @return [GetExtendedList]
|
|
259
263
|
describe 'get_list test' do
|
|
260
264
|
it 'should work' do
|
|
@@ -290,7 +294,7 @@ describe 'ContactsApi' do
|
|
|
290
294
|
|
|
291
295
|
# unit tests for import_contacts
|
|
292
296
|
# Import contacts
|
|
293
|
-
# It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
|
297
|
+
# It returns the background process ID which on completion calls the notify URL that you have set in the input. **Note**: - Any contact attribute that doesn't exist in your account will be ignored at import end.
|
|
294
298
|
# @param request_contact_import Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``
|
|
295
299
|
# @param [Hash] opts the optional parameters
|
|
296
300
|
# @return [CreatedProcessId]
|
|
@@ -72,7 +72,7 @@ describe 'ConversationsApi' do
|
|
|
72
72
|
# Only agents’ messages can be edited.
|
|
73
73
|
# @param id ID of the message
|
|
74
74
|
# @param [Hash] opts the optional parameters
|
|
75
|
-
# @option opts [
|
|
75
|
+
# @option opts [Body12] :body
|
|
76
76
|
# @return [ConversationsMessage]
|
|
77
77
|
describe 'conversations_messages_id_put test' do
|
|
78
78
|
it 'should work' do
|
|
@@ -36,7 +36,7 @@ describe 'CouponsApi' do
|
|
|
36
36
|
# Create а coupon collection
|
|
37
37
|
# @param create_coupon_collection Values to create a coupon collection
|
|
38
38
|
# @param [Hash] opts the optional parameters
|
|
39
|
-
# @return [
|
|
39
|
+
# @return [InlineResponse2013]
|
|
40
40
|
describe 'create_coupon_collection test' do
|
|
41
41
|
it 'should work' do
|
|
42
42
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -71,6 +71,7 @@ describe 'CouponsApi' do
|
|
|
71
71
|
# @option opts [Integer] :limit Number of documents returned per page
|
|
72
72
|
# @option opts [Integer] :offset Index of the first document on the page
|
|
73
73
|
# @option opts [String] :sort Sort the results by creation time in ascending/descending order
|
|
74
|
+
# @option opts [Object] :sort_by The field used to sort coupon collections
|
|
74
75
|
# @return [GetCouponCollection]
|
|
75
76
|
describe 'get_coupon_collections test' do
|
|
76
77
|
it 'should work' do
|
|
@@ -81,9 +82,9 @@ describe 'CouponsApi' do
|
|
|
81
82
|
# unit tests for update_coupon_collection
|
|
82
83
|
# Update a coupon collection by id
|
|
83
84
|
# @param id Id of the collection to update
|
|
84
|
-
# @param update_coupon_collection Values to update the coupon collection
|
|
85
85
|
# @param [Hash] opts the optional parameters
|
|
86
|
-
# @
|
|
86
|
+
# @option opts [UpdateCouponCollection] :update_coupon_collection Values to update the coupon collection
|
|
87
|
+
# @return [InlineResponse2003]
|
|
87
88
|
describe 'update_coupon_collection test' do
|
|
88
89
|
it 'should work' do
|
|
89
90
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
data/spec/api/deals_api_spec.rb
CHANGED
|
@@ -45,7 +45,7 @@ describe 'DealsApi' do
|
|
|
45
45
|
# unit tests for crm_deals_get
|
|
46
46
|
# Get all deals
|
|
47
47
|
# @param [Hash] opts the optional parameters
|
|
48
|
-
# @option opts [String] :filters_attributes_deal_name Filter by attributes. If you have filter for owner on your
|
|
48
|
+
# @option opts [String] :filters_attributes_deal_name Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering.
|
|
49
49
|
# @option opts [String] :filters_linked_companies_ids Filter by linked companies ids
|
|
50
50
|
# @option opts [String] :filters_linked_contacts_ids Filter by linked companies ids
|
|
51
51
|
# @option opts [Integer] :offset Index of the first document of the page
|
|
@@ -109,7 +109,7 @@ describe 'DealsApi' do
|
|
|
109
109
|
# Create a deal
|
|
110
110
|
# @param body Deal create data.
|
|
111
111
|
# @param [Hash] opts the optional parameters
|
|
112
|
-
# @return [
|
|
112
|
+
# @return [InlineResponse2011]
|
|
113
113
|
describe 'crm_deals_post test' do
|
|
114
114
|
it 'should work' do
|
|
115
115
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|