brevo 2.0.0 → 3.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 +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
@@ -388,7 +388,8 @@ opts = {
|
|
388
388
|
end_date: 'end_date_example', # String | **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**
|
389
389
|
limit: 50, # Integer | Number of documents per page
|
390
390
|
offset: 0, # Integer | Index of the first document in the page
|
391
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed
|
391
|
+
sort: 'desc', # String | Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed
|
392
|
+
source: 'source_example' # String | source of the template
|
392
393
|
}
|
393
394
|
|
394
395
|
begin
|
@@ -409,6 +410,7 @@ Name | Type | Description | Notes
|
|
409
410
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
410
411
|
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
411
412
|
**sort** | **String**| Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
413
|
+
**source** | **String**| source of the template | [optional]
|
412
414
|
|
413
415
|
### Return type
|
414
416
|
|
@@ -366,7 +366,7 @@ module Brevo
|
|
366
366
|
# Create a company
|
367
367
|
# @param body Company create data.
|
368
368
|
# @param [Hash] opts the optional parameters
|
369
|
-
# @return [
|
369
|
+
# @return [InlineResponse2002]
|
370
370
|
def companies_post(body, opts = {})
|
371
371
|
data, _status_code, _headers = companies_post_with_http_info(body, opts)
|
372
372
|
data
|
@@ -375,7 +375,7 @@ module Brevo
|
|
375
375
|
# Create a company
|
376
376
|
# @param body Company create data.
|
377
377
|
# @param [Hash] opts the optional parameters
|
378
|
-
# @return [Array<(
|
378
|
+
# @return [Array<(InlineResponse2002, Fixnum, Hash)>] InlineResponse2002 data, response status code and response headers
|
379
379
|
def companies_post_with_http_info(body, opts = {})
|
380
380
|
if @api_client.config.debugging
|
381
381
|
@api_client.config.logger.debug 'Calling API: CompaniesApi.companies_post ...'
|
@@ -409,7 +409,7 @@ module Brevo
|
|
409
409
|
:form_params => form_params,
|
410
410
|
:body => post_body,
|
411
411
|
:auth_names => auth_names,
|
412
|
-
:return_type => '
|
412
|
+
:return_type => 'InlineResponse2002')
|
413
413
|
if @api_client.config.debugging
|
414
414
|
@api_client.config.logger.debug "API called: CompaniesApi#companies_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
415
415
|
end
|
@@ -746,6 +746,8 @@ module Brevo
|
|
746
746
|
# @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.
|
747
747
|
# @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.
|
748
748
|
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
749
|
+
# @option opts [Integer] :segment_id Id of the segment. **Either listIds or segmentId can be passed.**
|
750
|
+
# @option opts [Array<Integer>] :list_ids Ids of the list. **Either listIds or segmentId can be passed.**
|
749
751
|
# @return [GetContacts]
|
750
752
|
def get_contacts(opts = {})
|
751
753
|
data, _status_code, _headers = get_contacts_with_http_info(opts)
|
@@ -759,6 +761,8 @@ module Brevo
|
|
759
761
|
# @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.
|
760
762
|
# @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.
|
761
763
|
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
764
|
+
# @option opts [Integer] :segment_id Id of the segment. **Either listIds or segmentId can be passed.**
|
765
|
+
# @option opts [Array<Integer>] :list_ids Ids of the list. **Either listIds or segmentId can be passed.**
|
762
766
|
# @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
|
763
767
|
def get_contacts_with_http_info(opts = {})
|
764
768
|
if @api_client.config.debugging
|
@@ -785,6 +789,8 @@ module Brevo
|
|
785
789
|
query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
|
786
790
|
query_params[:'createdSince'] = opts[:'created_since'] if !opts[:'created_since'].nil?
|
787
791
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
792
|
+
query_params[:'segmentId'] = opts[:'segment_id'] if !opts[:'segment_id'].nil?
|
793
|
+
query_params[:'listIds'] = @api_client.build_collection_param(opts[:'list_ids'], :csv) if !opts[:'list_ids'].nil?
|
788
794
|
|
789
795
|
# header parameters
|
790
796
|
header_params = {}
|
@@ -1087,6 +1093,8 @@ module Brevo
|
|
1087
1093
|
# Get a list's details
|
1088
1094
|
# @param list_id Id of the list
|
1089
1095
|
# @param [Hash] opts the optional parameters
|
1096
|
+
# @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
|
1097
|
+
# @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
|
1090
1098
|
# @return [GetExtendedList]
|
1091
1099
|
def get_list(list_id, opts = {})
|
1092
1100
|
data, _status_code, _headers = get_list_with_http_info(list_id, opts)
|
@@ -1096,6 +1104,8 @@ module Brevo
|
|
1096
1104
|
# Get a list's details
|
1097
1105
|
# @param list_id Id of the list
|
1098
1106
|
# @param [Hash] opts the optional parameters
|
1107
|
+
# @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
|
1108
|
+
# @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
|
1099
1109
|
# @return [Array<(GetExtendedList, Fixnum, Hash)>] GetExtendedList data, response status code and response headers
|
1100
1110
|
def get_list_with_http_info(list_id, opts = {})
|
1101
1111
|
if @api_client.config.debugging
|
@@ -1110,6 +1120,8 @@ module Brevo
|
|
1110
1120
|
|
1111
1121
|
# query parameters
|
1112
1122
|
query_params = {}
|
1123
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
1124
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
1113
1125
|
|
1114
1126
|
# header parameters
|
1115
1127
|
header_params = {}
|
@@ -1277,7 +1289,7 @@ module Brevo
|
|
1277
1289
|
return data, status_code, headers
|
1278
1290
|
end
|
1279
1291
|
# Import contacts
|
1280
|
-
# It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
1292
|
+
# 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.
|
1281
1293
|
# @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``
|
1282
1294
|
# @param [Hash] opts the optional parameters
|
1283
1295
|
# @return [CreatedProcessId]
|
@@ -1287,7 +1299,7 @@ module Brevo
|
|
1287
1299
|
end
|
1288
1300
|
|
1289
1301
|
# Import contacts
|
1290
|
-
# It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
1302
|
+
# 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.
|
1291
1303
|
# @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``
|
1292
1304
|
# @param [Hash] opts the optional parameters
|
1293
1305
|
# @return [Array<(CreatedProcessId, Fixnum, Hash)>] CreatedProcessId data, response status code and response headers
|
@@ -191,7 +191,7 @@ module Brevo
|
|
191
191
|
# Only agents’ messages can be edited.
|
192
192
|
# @param id ID of the message
|
193
193
|
# @param [Hash] opts the optional parameters
|
194
|
-
# @option opts [
|
194
|
+
# @option opts [Body12] :body
|
195
195
|
# @return [ConversationsMessage]
|
196
196
|
def conversations_messages_id_put(id, opts = {})
|
197
197
|
data, _status_code, _headers = conversations_messages_id_put_with_http_info(id, opts)
|
@@ -202,7 +202,7 @@ module Brevo
|
|
202
202
|
# Only agents’ messages can be edited.
|
203
203
|
# @param id ID of the message
|
204
204
|
# @param [Hash] opts the optional parameters
|
205
|
-
# @option opts [
|
205
|
+
# @option opts [Body12] :body
|
206
206
|
# @return [Array<(ConversationsMessage, Fixnum, Hash)>] ConversationsMessage data, response status code and response headers
|
207
207
|
def conversations_messages_id_put_with_http_info(id, opts = {})
|
208
208
|
if @api_client.config.debugging
|
@@ -32,7 +32,7 @@ module Brevo
|
|
32
32
|
# Create а coupon collection
|
33
33
|
# @param create_coupon_collection Values to create a coupon collection
|
34
34
|
# @param [Hash] opts the optional parameters
|
35
|
-
# @return [
|
35
|
+
# @return [InlineResponse2013]
|
36
36
|
def create_coupon_collection(create_coupon_collection, opts = {})
|
37
37
|
data, _status_code, _headers = create_coupon_collection_with_http_info(create_coupon_collection, opts)
|
38
38
|
data
|
@@ -41,7 +41,7 @@ module Brevo
|
|
41
41
|
# Create а coupon collection
|
42
42
|
# @param create_coupon_collection Values to create a coupon collection
|
43
43
|
# @param [Hash] opts the optional parameters
|
44
|
-
# @return [Array<(
|
44
|
+
# @return [Array<(InlineResponse2013, Fixnum, Hash)>] InlineResponse2013 data, response status code and response headers
|
45
45
|
def create_coupon_collection_with_http_info(create_coupon_collection, opts = {})
|
46
46
|
if @api_client.config.debugging
|
47
47
|
@api_client.config.logger.debug 'Calling API: CouponsApi.create_coupon_collection ...'
|
@@ -75,7 +75,7 @@ module Brevo
|
|
75
75
|
:form_params => form_params,
|
76
76
|
:body => post_body,
|
77
77
|
:auth_names => auth_names,
|
78
|
-
:return_type => '
|
78
|
+
:return_type => 'InlineResponse2013')
|
79
79
|
if @api_client.config.debugging
|
80
80
|
@api_client.config.logger.debug "API called: CouponsApi#create_coupon_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
81
|
end
|
@@ -189,6 +189,7 @@ module Brevo
|
|
189
189
|
# @option opts [Integer] :limit Number of documents returned per page (default to 50)
|
190
190
|
# @option opts [Integer] :offset Index of the first document on the page (default to 0)
|
191
191
|
# @option opts [String] :sort Sort the results by creation time in ascending/descending order (default to desc)
|
192
|
+
# @option opts [Object] :sort_by The field used to sort coupon collections
|
192
193
|
# @return [GetCouponCollection]
|
193
194
|
def get_coupon_collections(opts = {})
|
194
195
|
data, _status_code, _headers = get_coupon_collections_with_http_info(opts)
|
@@ -200,6 +201,7 @@ module Brevo
|
|
200
201
|
# @option opts [Integer] :limit Number of documents returned per page
|
201
202
|
# @option opts [Integer] :offset Index of the first document on the page
|
202
203
|
# @option opts [String] :sort Sort the results by creation time in ascending/descending order
|
204
|
+
# @option opts [Object] :sort_by The field used to sort coupon collections
|
203
205
|
# @return [Array<(GetCouponCollection, Fixnum, Hash)>] GetCouponCollection data, response status code and response headers
|
204
206
|
def get_coupon_collections_with_http_info(opts = {})
|
205
207
|
if @api_client.config.debugging
|
@@ -228,6 +230,7 @@ module Brevo
|
|
228
230
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
229
231
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
230
232
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
233
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
|
231
234
|
|
232
235
|
# header parameters
|
233
236
|
header_params = {}
|
@@ -256,20 +259,20 @@ module Brevo
|
|
256
259
|
end
|
257
260
|
# Update a coupon collection by id
|
258
261
|
# @param id Id of the collection to update
|
259
|
-
# @param update_coupon_collection Values to update the coupon collection
|
260
262
|
# @param [Hash] opts the optional parameters
|
261
|
-
# @
|
262
|
-
|
263
|
-
|
263
|
+
# @option opts [UpdateCouponCollection] :update_coupon_collection Values to update the coupon collection
|
264
|
+
# @return [InlineResponse2003]
|
265
|
+
def update_coupon_collection(id, opts = {})
|
266
|
+
data, _status_code, _headers = update_coupon_collection_with_http_info(id, opts)
|
264
267
|
data
|
265
268
|
end
|
266
269
|
|
267
270
|
# Update a coupon collection by id
|
268
271
|
# @param id Id of the collection to update
|
269
|
-
# @param update_coupon_collection Values to update the coupon collection
|
270
272
|
# @param [Hash] opts the optional parameters
|
271
|
-
# @
|
272
|
-
|
273
|
+
# @option opts [UpdateCouponCollection] :update_coupon_collection Values to update the coupon collection
|
274
|
+
# @return [Array<(InlineResponse2003, Fixnum, Hash)>] InlineResponse2003 data, response status code and response headers
|
275
|
+
def update_coupon_collection_with_http_info(id, opts = {})
|
273
276
|
if @api_client.config.debugging
|
274
277
|
@api_client.config.logger.debug 'Calling API: CouponsApi.update_coupon_collection ...'
|
275
278
|
end
|
@@ -277,10 +280,6 @@ module Brevo
|
|
277
280
|
if @api_client.config.client_side_validation && id.nil?
|
278
281
|
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.update_coupon_collection"
|
279
282
|
end
|
280
|
-
# verify the required parameter 'update_coupon_collection' is set
|
281
|
-
if @api_client.config.client_side_validation && update_coupon_collection.nil?
|
282
|
-
fail ArgumentError, "Missing the required parameter 'update_coupon_collection' when calling CouponsApi.update_coupon_collection"
|
283
|
-
end
|
284
283
|
# resource path
|
285
284
|
local_var_path = '/couponCollections/{id}'.sub('{' + 'id' + '}', id.to_s)
|
286
285
|
|
@@ -298,7 +297,7 @@ module Brevo
|
|
298
297
|
form_params = {}
|
299
298
|
|
300
299
|
# http body (model)
|
301
|
-
post_body = @api_client.object_to_http_body(update_coupon_collection)
|
300
|
+
post_body = @api_client.object_to_http_body(opts[:'update_coupon_collection'])
|
302
301
|
auth_names = ['api-key', 'partner-key']
|
303
302
|
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
304
303
|
:header_params => header_params,
|
@@ -306,7 +305,7 @@ module Brevo
|
|
306
305
|
:form_params => form_params,
|
307
306
|
:body => post_body,
|
308
307
|
:auth_names => auth_names,
|
309
|
-
:return_type => '
|
308
|
+
:return_type => 'InlineResponse2003')
|
310
309
|
if @api_client.config.debugging
|
311
310
|
@api_client.config.logger.debug "API called: CouponsApi#update_coupon_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
312
311
|
end
|
data/lib/brevo/api/deals_api.rb
CHANGED
@@ -77,7 +77,7 @@ module Brevo
|
|
77
77
|
end
|
78
78
|
# Get all deals
|
79
79
|
# @param [Hash] opts the optional parameters
|
80
|
-
# @option opts [String] :filters_attributes_deal_name Filter by attributes. If you have filter for owner on your
|
80
|
+
# @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.
|
81
81
|
# @option opts [String] :filters_linked_companies_ids Filter by linked companies ids
|
82
82
|
# @option opts [String] :filters_linked_contacts_ids Filter by linked companies ids
|
83
83
|
# @option opts [Integer] :offset Index of the first document of the page
|
@@ -92,7 +92,7 @@ module Brevo
|
|
92
92
|
|
93
93
|
# Get all deals
|
94
94
|
# @param [Hash] opts the optional parameters
|
95
|
-
# @option opts [String] :filters_attributes_deal_name Filter by attributes. If you have filter for owner on your
|
95
|
+
# @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.
|
96
96
|
# @option opts [String] :filters_linked_companies_ids Filter by linked companies ids
|
97
97
|
# @option opts [String] :filters_linked_contacts_ids Filter by linked companies ids
|
98
98
|
# @option opts [Integer] :offset Index of the first document of the page
|
@@ -365,7 +365,7 @@ module Brevo
|
|
365
365
|
# Create a deal
|
366
366
|
# @param body Deal create data.
|
367
367
|
# @param [Hash] opts the optional parameters
|
368
|
-
# @return [
|
368
|
+
# @return [InlineResponse2011]
|
369
369
|
def crm_deals_post(body, opts = {})
|
370
370
|
data, _status_code, _headers = crm_deals_post_with_http_info(body, opts)
|
371
371
|
data
|
@@ -374,7 +374,7 @@ module Brevo
|
|
374
374
|
# Create a deal
|
375
375
|
# @param body Deal create data.
|
376
376
|
# @param [Hash] opts the optional parameters
|
377
|
-
# @return [Array<(
|
377
|
+
# @return [Array<(InlineResponse2011, Fixnum, Hash)>] InlineResponse2011 data, response status code and response headers
|
378
378
|
def crm_deals_post_with_http_info(body, opts = {})
|
379
379
|
if @api_client.config.debugging
|
380
380
|
@api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_post ...'
|
@@ -408,7 +408,7 @@ module Brevo
|
|
408
408
|
:form_params => form_params,
|
409
409
|
:body => post_body,
|
410
410
|
:auth_names => auth_names,
|
411
|
-
:return_type => '
|
411
|
+
:return_type => 'InlineResponse2011')
|
412
412
|
if @api_client.config.debugging
|
413
413
|
@api_client.config.logger.debug "API called: DealsApi#crm_deals_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
414
414
|
end
|
@@ -390,6 +390,174 @@ module Brevo
|
|
390
390
|
end
|
391
391
|
return data, status_code, headers
|
392
392
|
end
|
393
|
+
# Get detailed attribution metrics for a single Brevo campaign
|
394
|
+
# @param conversion_source The Brevo campaign type for which data will be retrieved
|
395
|
+
# @param conversion_source_id The Brevo campaign id for which data will be retrieved
|
396
|
+
# @param [Hash] opts the optional parameters
|
397
|
+
# @return [nil]
|
398
|
+
def ecommerce_attribution_metrics_conversion_source_conversion_source_id_get(conversion_source, conversion_source_id, opts = {})
|
399
|
+
ecommerce_attribution_metrics_conversion_source_conversion_source_id_get_with_http_info(conversion_source, conversion_source_id, opts)
|
400
|
+
nil
|
401
|
+
end
|
402
|
+
|
403
|
+
# Get detailed attribution metrics for a single Brevo campaign
|
404
|
+
# @param conversion_source The Brevo campaign type for which data will be retrieved
|
405
|
+
# @param conversion_source_id The Brevo campaign id for which data will be retrieved
|
406
|
+
# @param [Hash] opts the optional parameters
|
407
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
408
|
+
def ecommerce_attribution_metrics_conversion_source_conversion_source_id_get_with_http_info(conversion_source, conversion_source_id, opts = {})
|
409
|
+
if @api_client.config.debugging
|
410
|
+
@api_client.config.logger.debug 'Calling API: EcommerceApi.ecommerce_attribution_metrics_conversion_source_conversion_source_id_get ...'
|
411
|
+
end
|
412
|
+
# verify the required parameter 'conversion_source' is set
|
413
|
+
if @api_client.config.client_side_validation && conversion_source.nil?
|
414
|
+
fail ArgumentError, "Missing the required parameter 'conversion_source' when calling EcommerceApi.ecommerce_attribution_metrics_conversion_source_conversion_source_id_get"
|
415
|
+
end
|
416
|
+
# verify the required parameter 'conversion_source_id' is set
|
417
|
+
if @api_client.config.client_side_validation && conversion_source_id.nil?
|
418
|
+
fail ArgumentError, "Missing the required parameter 'conversion_source_id' when calling EcommerceApi.ecommerce_attribution_metrics_conversion_source_conversion_source_id_get"
|
419
|
+
end
|
420
|
+
# resource path
|
421
|
+
local_var_path = '/ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId}'.sub('{' + 'conversionSource' + '}', conversion_source.to_s).sub('{' + 'conversionSourceId' + '}', conversion_source_id.to_s)
|
422
|
+
|
423
|
+
# query parameters
|
424
|
+
query_params = {}
|
425
|
+
|
426
|
+
# header parameters
|
427
|
+
header_params = {}
|
428
|
+
# HTTP header 'Accept' (if needed)
|
429
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
430
|
+
# HTTP header 'Content-Type'
|
431
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
432
|
+
|
433
|
+
# form parameters
|
434
|
+
form_params = {}
|
435
|
+
|
436
|
+
# http body (model)
|
437
|
+
post_body = nil
|
438
|
+
auth_names = ['api-key', 'partner-key']
|
439
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
440
|
+
:header_params => header_params,
|
441
|
+
:query_params => query_params,
|
442
|
+
:form_params => form_params,
|
443
|
+
:body => post_body,
|
444
|
+
:auth_names => auth_names)
|
445
|
+
if @api_client.config.debugging
|
446
|
+
@api_client.config.logger.debug "API called: EcommerceApi#ecommerce_attribution_metrics_conversion_source_conversion_source_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
447
|
+
end
|
448
|
+
return data, status_code, headers
|
449
|
+
end
|
450
|
+
# Get attribution metrics for one or more Brevo campaigns
|
451
|
+
# @param [Hash] opts the optional parameters
|
452
|
+
# @option opts [Object] :period_from When getting metrics for a specific period, define the starting datetime in RFC3339 format
|
453
|
+
# @option opts [Object] :period_to When getting metrics for a specific period, define the end datetime in RFC3339 format
|
454
|
+
# @option opts [Object] :email_campaign_id The email campaign id(s) to get metrics for
|
455
|
+
# @return [nil]
|
456
|
+
def ecommerce_attribution_metrics_get(opts = {})
|
457
|
+
ecommerce_attribution_metrics_get_with_http_info(opts)
|
458
|
+
nil
|
459
|
+
end
|
460
|
+
|
461
|
+
# Get attribution metrics for one or more Brevo campaigns
|
462
|
+
# @param [Hash] opts the optional parameters
|
463
|
+
# @option opts [Object] :period_from When getting metrics for a specific period, define the starting datetime in RFC3339 format
|
464
|
+
# @option opts [Object] :period_to When getting metrics for a specific period, define the end datetime in RFC3339 format
|
465
|
+
# @option opts [Object] :email_campaign_id The email campaign id(s) to get metrics for
|
466
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
467
|
+
def ecommerce_attribution_metrics_get_with_http_info(opts = {})
|
468
|
+
if @api_client.config.debugging
|
469
|
+
@api_client.config.logger.debug 'Calling API: EcommerceApi.ecommerce_attribution_metrics_get ...'
|
470
|
+
end
|
471
|
+
# resource path
|
472
|
+
local_var_path = '/ecommerce/attribution/metrics'
|
473
|
+
|
474
|
+
# query parameters
|
475
|
+
query_params = {}
|
476
|
+
query_params[:'periodFrom'] = opts[:'period_from'] if !opts[:'period_from'].nil?
|
477
|
+
query_params[:'periodTo'] = opts[:'period_to'] if !opts[:'period_to'].nil?
|
478
|
+
query_params[:'emailCampaignId[]'] = opts[:'email_campaign_id'] if !opts[:'email_campaign_id'].nil?
|
479
|
+
|
480
|
+
# header parameters
|
481
|
+
header_params = {}
|
482
|
+
# HTTP header 'Accept' (if needed)
|
483
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
484
|
+
# HTTP header 'Content-Type'
|
485
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
486
|
+
|
487
|
+
# form parameters
|
488
|
+
form_params = {}
|
489
|
+
|
490
|
+
# http body (model)
|
491
|
+
post_body = nil
|
492
|
+
auth_names = ['api-key', 'partner-key']
|
493
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
494
|
+
:header_params => header_params,
|
495
|
+
:query_params => query_params,
|
496
|
+
:form_params => form_params,
|
497
|
+
:body => post_body,
|
498
|
+
:auth_names => auth_names)
|
499
|
+
if @api_client.config.debugging
|
500
|
+
@api_client.config.logger.debug "API called: EcommerceApi#ecommerce_attribution_metrics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
501
|
+
end
|
502
|
+
return data, status_code, headers
|
503
|
+
end
|
504
|
+
# Get attributed product sales for a single Brevo campaign
|
505
|
+
# @param conversion_source The Brevo campaign type for which data will be retrieved
|
506
|
+
# @param conversion_source_id The Brevo campaign id for which data will be retrieved
|
507
|
+
# @param [Hash] opts the optional parameters
|
508
|
+
# @return [nil]
|
509
|
+
def ecommerce_attribution_products_conversion_source_conversion_source_id_get(conversion_source, conversion_source_id, opts = {})
|
510
|
+
ecommerce_attribution_products_conversion_source_conversion_source_id_get_with_http_info(conversion_source, conversion_source_id, opts)
|
511
|
+
nil
|
512
|
+
end
|
513
|
+
|
514
|
+
# Get attributed product sales for a single Brevo campaign
|
515
|
+
# @param conversion_source The Brevo campaign type for which data will be retrieved
|
516
|
+
# @param conversion_source_id The Brevo campaign id for which data will be retrieved
|
517
|
+
# @param [Hash] opts the optional parameters
|
518
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
519
|
+
def ecommerce_attribution_products_conversion_source_conversion_source_id_get_with_http_info(conversion_source, conversion_source_id, opts = {})
|
520
|
+
if @api_client.config.debugging
|
521
|
+
@api_client.config.logger.debug 'Calling API: EcommerceApi.ecommerce_attribution_products_conversion_source_conversion_source_id_get ...'
|
522
|
+
end
|
523
|
+
# verify the required parameter 'conversion_source' is set
|
524
|
+
if @api_client.config.client_side_validation && conversion_source.nil?
|
525
|
+
fail ArgumentError, "Missing the required parameter 'conversion_source' when calling EcommerceApi.ecommerce_attribution_products_conversion_source_conversion_source_id_get"
|
526
|
+
end
|
527
|
+
# verify the required parameter 'conversion_source_id' is set
|
528
|
+
if @api_client.config.client_side_validation && conversion_source_id.nil?
|
529
|
+
fail ArgumentError, "Missing the required parameter 'conversion_source_id' when calling EcommerceApi.ecommerce_attribution_products_conversion_source_conversion_source_id_get"
|
530
|
+
end
|
531
|
+
# resource path
|
532
|
+
local_var_path = '/ecommerce/attribution/products/{conversionSource}/{conversionSourceId}'.sub('{' + 'conversionSource' + '}', conversion_source.to_s).sub('{' + 'conversionSourceId' + '}', conversion_source_id.to_s)
|
533
|
+
|
534
|
+
# query parameters
|
535
|
+
query_params = {}
|
536
|
+
|
537
|
+
# header parameters
|
538
|
+
header_params = {}
|
539
|
+
# HTTP header 'Accept' (if needed)
|
540
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
541
|
+
# HTTP header 'Content-Type'
|
542
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
543
|
+
|
544
|
+
# form parameters
|
545
|
+
form_params = {}
|
546
|
+
|
547
|
+
# http body (model)
|
548
|
+
post_body = nil
|
549
|
+
auth_names = ['api-key', 'partner-key']
|
550
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
551
|
+
:header_params => header_params,
|
552
|
+
:query_params => query_params,
|
553
|
+
:form_params => form_params,
|
554
|
+
:body => post_body,
|
555
|
+
:auth_names => auth_names)
|
556
|
+
if @api_client.config.debugging
|
557
|
+
@api_client.config.logger.debug "API called: EcommerceApi#ecommerce_attribution_products_conversion_source_conversion_source_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
558
|
+
end
|
559
|
+
return data, status_code, headers
|
560
|
+
end
|
393
561
|
# Return all your categories
|
394
562
|
# @param [Hash] opts the optional parameters
|
395
563
|
# @option opts [Integer] :limit Number of documents per page (default to 50)
|
@@ -397,6 +565,8 @@ module Brevo
|
|
397
565
|
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
398
566
|
# @option opts [Array<String>] :ids Filter by category ids
|
399
567
|
# @option opts [String] :name Filter by category name
|
568
|
+
# @option opts [String] :modified_since Filter (urlencoded) the categories 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.**
|
569
|
+
# @option opts [String] :created_since Filter (urlencoded) the categories 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.**
|
400
570
|
# @return [GetCategories]
|
401
571
|
def get_categories(opts = {})
|
402
572
|
data, _status_code, _headers = get_categories_with_http_info(opts)
|
@@ -410,6 +580,8 @@ module Brevo
|
|
410
580
|
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
411
581
|
# @option opts [Array<String>] :ids Filter by category ids
|
412
582
|
# @option opts [String] :name Filter by category name
|
583
|
+
# @option opts [String] :modified_since Filter (urlencoded) the categories 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.**
|
584
|
+
# @option opts [String] :created_since Filter (urlencoded) the categories 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.**
|
413
585
|
# @return [Array<(GetCategories, Fixnum, Hash)>] GetCategories data, response status code and response headers
|
414
586
|
def get_categories_with_http_info(opts = {})
|
415
587
|
if @api_client.config.debugging
|
@@ -432,6 +604,8 @@ module Brevo
|
|
432
604
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
433
605
|
query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
|
434
606
|
query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
|
607
|
+
query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
|
608
|
+
query_params[:'createdSince'] = opts[:'created_since'] if !opts[:'created_since'].nil?
|
435
609
|
|
436
610
|
# header parameters
|
437
611
|
header_params = {}
|
@@ -510,6 +684,76 @@ module Brevo
|
|
510
684
|
end
|
511
685
|
return data, status_code, headers
|
512
686
|
end
|
687
|
+
# Get order details
|
688
|
+
# Get all the orders
|
689
|
+
# @param [Hash] opts the optional parameters
|
690
|
+
# @option opts [Integer] :limit Number of documents per page (default to 50)
|
691
|
+
# @option opts [Integer] :offset Index of the first document in the page (default to 0)
|
692
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
|
693
|
+
# @option opts [String] :modified_since Filter (urlencoded) the orders 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.**
|
694
|
+
# @option opts [String] :created_since Filter (urlencoded) the orders 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.**
|
695
|
+
# @return [GetOrders]
|
696
|
+
def get_orders(opts = {})
|
697
|
+
data, _status_code, _headers = get_orders_with_http_info(opts)
|
698
|
+
data
|
699
|
+
end
|
700
|
+
|
701
|
+
# Get order details
|
702
|
+
# Get all the orders
|
703
|
+
# @param [Hash] opts the optional parameters
|
704
|
+
# @option opts [Integer] :limit Number of documents per page
|
705
|
+
# @option opts [Integer] :offset Index of the first document in the page
|
706
|
+
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
707
|
+
# @option opts [String] :modified_since Filter (urlencoded) the orders 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.**
|
708
|
+
# @option opts [String] :created_since Filter (urlencoded) the orders 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.**
|
709
|
+
# @return [Array<(GetOrders, Fixnum, Hash)>] GetOrders data, response status code and response headers
|
710
|
+
def get_orders_with_http_info(opts = {})
|
711
|
+
if @api_client.config.debugging
|
712
|
+
@api_client.config.logger.debug 'Calling API: EcommerceApi.get_orders ...'
|
713
|
+
end
|
714
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
715
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EcommerceApi.get_orders, must be smaller than or equal to 100.'
|
716
|
+
end
|
717
|
+
|
718
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
|
719
|
+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
|
720
|
+
end
|
721
|
+
# resource path
|
722
|
+
local_var_path = '/orders'
|
723
|
+
|
724
|
+
# query parameters
|
725
|
+
query_params = {}
|
726
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
727
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
728
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
729
|
+
query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
|
730
|
+
query_params[:'createdSince'] = opts[:'created_since'] if !opts[:'created_since'].nil?
|
731
|
+
|
732
|
+
# header parameters
|
733
|
+
header_params = {}
|
734
|
+
# HTTP header 'Accept' (if needed)
|
735
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
736
|
+
# HTTP header 'Content-Type'
|
737
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
738
|
+
|
739
|
+
# form parameters
|
740
|
+
form_params = {}
|
741
|
+
|
742
|
+
# http body (model)
|
743
|
+
post_body = nil
|
744
|
+
auth_names = ['api-key', 'partner-key']
|
745
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
746
|
+
:header_params => header_params,
|
747
|
+
:query_params => query_params,
|
748
|
+
:form_params => form_params,
|
749
|
+
:body => post_body,
|
750
|
+
:auth_names => auth_names,
|
751
|
+
:return_type => 'GetOrders')
|
752
|
+
if @api_client.config.debugging
|
753
|
+
@api_client.config.logger.debug "API called: EcommerceApi#get_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
754
|
+
end
|
755
|
+
return data, status_code, headers
|
756
|
+
end
|
513
757
|
# Get a product's details
|
514
758
|
# @param id Product ID
|
515
759
|
# @param [Hash] opts the optional parameters
|
@@ -576,6 +820,8 @@ module Brevo
|
|
576
820
|
# @option opts [Float] :price_eq Price filter for products equals to particular amount
|
577
821
|
# @option opts [Float] :price_ne Price filter for products not equals to particular amount
|
578
822
|
# @option opts [Array<String>] :categories Filter by category ids
|
823
|
+
# @option opts [String] :modified_since Filter (urlencoded) the orders 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.**
|
824
|
+
# @option opts [String] :created_since Filter (urlencoded) the orders 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.**
|
579
825
|
# @return [GetProducts]
|
580
826
|
def get_products(opts = {})
|
581
827
|
data, _status_code, _headers = get_products_with_http_info(opts)
|
@@ -596,6 +842,8 @@ module Brevo
|
|
596
842
|
# @option opts [Float] :price_eq Price filter for products equals to particular amount
|
597
843
|
# @option opts [Float] :price_ne Price filter for products not equals to particular amount
|
598
844
|
# @option opts [Array<String>] :categories Filter by category ids
|
845
|
+
# @option opts [String] :modified_since Filter (urlencoded) the orders 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.**
|
846
|
+
# @option opts [String] :created_since Filter (urlencoded) the orders 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.**
|
599
847
|
# @return [Array<(GetProducts, Fixnum, Hash)>] GetProducts data, response status code and response headers
|
600
848
|
def get_products_with_http_info(opts = {})
|
601
849
|
if @api_client.config.debugging
|
@@ -625,6 +873,8 @@ module Brevo
|
|
625
873
|
query_params[:'price[eq]'] = opts[:'price_eq'] if !opts[:'price_eq'].nil?
|
626
874
|
query_params[:'price[ne]'] = opts[:'price_ne'] if !opts[:'price_ne'].nil?
|
627
875
|
query_params[:'categories'] = @api_client.build_collection_param(opts[:'categories'], :csv) if !opts[:'categories'].nil?
|
876
|
+
query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
|
877
|
+
query_params[:'createdSince'] = opts[:'created_since'] if !opts[:'created_since'].nil?
|
628
878
|
|
629
879
|
# header parameters
|
630
880
|
header_params = {}
|
@@ -244,7 +244,6 @@ module Brevo
|
|
244
244
|
# @param campaign_id Id of the campaign
|
245
245
|
# @param [Hash] opts the optional parameters
|
246
246
|
# @option opts [String] :statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
|
247
|
-
# @option opts [String] :utm_value Get email campaign report on the basis of custom UTM Value.**You can use either campaignId or utmValue to fetch campaign report.To use utmValue filter pass campaignId as empty.**
|
248
247
|
# @return [GetEmailCampaign]
|
249
248
|
def get_email_campaign(campaign_id, opts = {})
|
250
249
|
data, _status_code, _headers = get_email_campaign_with_http_info(campaign_id, opts)
|
@@ -255,7 +254,6 @@ module Brevo
|
|
255
254
|
# @param campaign_id Id of the campaign
|
256
255
|
# @param [Hash] opts the optional parameters
|
257
256
|
# @option opts [String] :statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
|
258
|
-
# @option opts [String] :utm_value Get email campaign report on the basis of custom UTM Value.**You can use either campaignId or utmValue to fetch campaign report.To use utmValue filter pass campaignId as empty.**
|
259
257
|
# @return [Array<(GetEmailCampaign, Fixnum, Hash)>] GetEmailCampaign data, response status code and response headers
|
260
258
|
def get_email_campaign_with_http_info(campaign_id, opts = {})
|
261
259
|
if @api_client.config.debugging
|
@@ -274,7 +272,6 @@ module Brevo
|
|
274
272
|
# query parameters
|
275
273
|
query_params = {}
|
276
274
|
query_params[:'statistics'] = opts[:'statistics'] if !opts[:'statistics'].nil?
|
277
|
-
query_params[:'utmValue'] = opts[:'utm_value'] if !opts[:'utm_value'].nil?
|
278
275
|
|
279
276
|
# header parameters
|
280
277
|
header_params = {}
|