@getbrevo/brevo 2.0.0-beta.4 → 2.1.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.
Files changed (244) hide show
  1. package/.openapi-generator/FILES +396 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/api/apis.ts +5 -1
  4. package/api/contactsApi.ts +12 -2
  5. package/api/couponsApi.ts +7 -7
  6. package/api/dealsApi.ts +1 -1
  7. package/api/ecommerceApi.ts +360 -2
  8. package/api/eventsApi.ts +169 -0
  9. package/api/masterAccountApi.ts +1056 -143
  10. package/api/paymentsApi.ts +321 -0
  11. package/api/tasksApi.ts +1 -1
  12. package/api/userApi.ts +2 -2
  13. package/api/whatsAppCampaignsApi.ts +6 -1
  14. package/dist/api/apis.d.ts +5 -1
  15. package/dist/api/apis.js +5 -1
  16. package/dist/api/apis.js.map +1 -1
  17. package/dist/api/contactsApi.d.ts +1 -1
  18. package/dist/api/contactsApi.js +7 -1
  19. package/dist/api/contactsApi.js.map +1 -1
  20. package/dist/api/couponsApi.d.ts +2 -2
  21. package/dist/api/couponsApi.js +4 -4
  22. package/dist/api/couponsApi.js.map +1 -1
  23. package/dist/api/ecommerceApi.d.ts +35 -2
  24. package/dist/api/ecommerceApi.js +303 -2
  25. package/dist/api/ecommerceApi.js.map +1 -1
  26. package/dist/api/eventsApi.d.ts +37 -0
  27. package/dist/api/eventsApi.js +140 -0
  28. package/dist/api/eventsApi.js.map +1 -0
  29. package/dist/api/masterAccountApi.d.ts +106 -0
  30. package/dist/api/masterAccountApi.js +882 -78
  31. package/dist/api/masterAccountApi.js.map +1 -1
  32. package/dist/api/paymentsApi.d.ts +55 -0
  33. package/dist/api/paymentsApi.js +274 -0
  34. package/dist/api/paymentsApi.js.map +1 -0
  35. package/dist/api/whatsAppCampaignsApi.d.ts +1 -1
  36. package/dist/api/whatsAppCampaignsApi.js +4 -1
  37. package/dist/api/whatsAppCampaignsApi.js.map +1 -1
  38. package/dist/api.js +1 -0
  39. package/dist/model/cart.d.ts +20 -0
  40. package/dist/model/cart.js +29 -0
  41. package/dist/model/cart.js.map +1 -0
  42. package/dist/model/configuration.d.ts +14 -0
  43. package/dist/model/configuration.js +18 -0
  44. package/dist/model/configuration.js.map +1 -0
  45. package/dist/model/conversionSourceMetrics.d.ts +23 -0
  46. package/dist/model/conversionSourceMetrics.js +44 -0
  47. package/dist/model/conversionSourceMetrics.js.map +1 -0
  48. package/dist/model/conversionSourceProduct.d.ts +21 -0
  49. package/dist/model/conversionSourceProduct.js +53 -0
  50. package/dist/model/conversionSourceProduct.js.map +1 -0
  51. package/dist/model/corporateGroupDetailsResponse.d.ts +19 -0
  52. package/dist/model/corporateGroupDetailsResponse.js +28 -0
  53. package/dist/model/corporateGroupDetailsResponse.js.map +1 -0
  54. package/dist/model/corporateGroupDetailsResponseGroup.d.ts +16 -0
  55. package/dist/model/corporateGroupDetailsResponseGroup.js +28 -0
  56. package/dist/model/corporateGroupDetailsResponseGroup.js.map +1 -0
  57. package/dist/model/corporateGroupDetailsResponseSubAccountsInner.d.ts +16 -0
  58. package/dist/model/corporateGroupDetailsResponseSubAccountsInner.js +28 -0
  59. package/dist/model/corporateGroupDetailsResponseSubAccountsInner.js.map +1 -0
  60. package/dist/model/corporateGroupDetailsResponseUsersInner.d.ts +16 -0
  61. package/dist/model/corporateGroupDetailsResponseUsersInner.js +28 -0
  62. package/dist/model/corporateGroupDetailsResponseUsersInner.js.map +1 -0
  63. package/dist/model/corporateGroupPost201Response.d.ts +14 -0
  64. package/dist/model/corporateGroupPost201Response.js +18 -0
  65. package/dist/model/corporateGroupPost201Response.js.map +1 -0
  66. package/dist/model/corporateGroupPostRequest.d.ts +15 -0
  67. package/dist/model/corporateGroupPostRequest.js +23 -0
  68. package/dist/model/corporateGroupPostRequest.js.map +1 -0
  69. package/dist/model/corporateGroupUnlinkGroupIdSubAccountsPutRequest.d.ts +14 -0
  70. package/dist/model/corporateGroupUnlinkGroupIdSubAccountsPutRequest.js +18 -0
  71. package/dist/model/corporateGroupUnlinkGroupIdSubAccountsPutRequest.js.map +1 -0
  72. package/dist/model/corporateUserInvitationActionEmailPut200Response.d.ts +14 -0
  73. package/dist/model/corporateUserInvitationActionEmailPut200Response.js +18 -0
  74. package/dist/model/corporateUserInvitationActionEmailPut200Response.js.map +1 -0
  75. package/dist/model/createCouponCollectionRequest.d.ts +5 -2
  76. package/dist/model/createCouponCollectionRequest.js +17 -2
  77. package/dist/model/createCouponCollectionRequest.js.map +1 -1
  78. package/dist/model/createDomainModel.d.ts +1 -0
  79. package/dist/model/createDomainModel.js +5 -0
  80. package/dist/model/createDomainModel.js.map +1 -1
  81. package/dist/model/createDomainModelDnsRecords.d.ts +1 -0
  82. package/dist/model/createDomainModelDnsRecords.js +5 -0
  83. package/dist/model/createDomainModelDnsRecords.js.map +1 -1
  84. package/dist/model/createPaymentRequest.d.ts +21 -0
  85. package/dist/model/createPaymentRequest.js +38 -0
  86. package/dist/model/createPaymentRequest.js.map +1 -0
  87. package/dist/model/createWebhook.d.ts +5 -0
  88. package/dist/model/createWebhook.js +15 -0
  89. package/dist/model/createWebhook.js.map +1 -1
  90. package/dist/model/createWhatsAppTemplate.d.ts +2 -2
  91. package/dist/model/createWhatsAppTemplate.js +2 -2
  92. package/dist/model/createWhatsAppTemplate.js.map +1 -1
  93. package/dist/model/event.d.ts +19 -0
  94. package/dist/model/event.js +38 -0
  95. package/dist/model/event.js.map +1 -0
  96. package/dist/model/eventIdentifiers.d.ts +18 -0
  97. package/dist/model/eventIdentifiers.js +38 -0
  98. package/dist/model/eventIdentifiers.js.map +1 -0
  99. package/dist/model/getContactDetails.d.ts +1 -1
  100. package/dist/model/getCorporateInvitedUsersList.d.ts +15 -0
  101. package/dist/model/getCorporateInvitedUsersList.js +18 -0
  102. package/dist/model/getCorporateInvitedUsersList.js.map +1 -0
  103. package/dist/model/getCorporateInvitedUsersListUsersInner.d.ts +20 -0
  104. package/dist/model/getCorporateInvitedUsersListUsersInner.js +38 -0
  105. package/dist/model/getCorporateInvitedUsersListUsersInner.js.map +1 -0
  106. package/dist/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.d.ts +17 -0
  107. package/dist/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.js +33 -0
  108. package/dist/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.js.map +1 -0
  109. package/dist/model/getCorporateInvitedUsersListUsersInnerGroups.d.ts +15 -0
  110. package/dist/model/getCorporateInvitedUsersListUsersInnerGroups.js +23 -0
  111. package/dist/model/getCorporateInvitedUsersListUsersInnerGroups.js.map +1 -0
  112. package/dist/model/getCorporateUserPermission.d.ts +19 -0
  113. package/dist/model/getCorporateUserPermission.js +33 -0
  114. package/dist/model/getCorporateUserPermission.js.map +1 -0
  115. package/dist/model/getCorporateUserPermissionFeatureAccess.d.ts +17 -0
  116. package/dist/model/getCorporateUserPermissionFeatureAccess.js +33 -0
  117. package/dist/model/getCorporateUserPermissionFeatureAccess.js.map +1 -0
  118. package/dist/model/getCorporateUserPermissionGroupsInner.d.ts +15 -0
  119. package/dist/model/getCorporateUserPermissionGroupsInner.js +23 -0
  120. package/dist/model/getCorporateUserPermissionGroupsInner.js.map +1 -0
  121. package/dist/model/getCouponCollection.d.ts +3 -0
  122. package/dist/model/getCouponCollection.js +15 -0
  123. package/dist/model/getCouponCollection.js.map +1 -1
  124. package/dist/model/getExtendedContactDetails.d.ts +1 -1
  125. package/dist/model/getOrders.d.ts +16 -0
  126. package/dist/model/getOrders.js +23 -0
  127. package/dist/model/getOrders.js.map +1 -0
  128. package/dist/model/getOrdersOrdersInner.d.ts +25 -0
  129. package/dist/model/getOrdersOrdersInner.js +63 -0
  130. package/dist/model/getOrdersOrdersInner.js.map +1 -0
  131. package/dist/model/getPaymentRequest.d.ts +29 -0
  132. package/dist/model/getPaymentRequest.js +51 -0
  133. package/dist/model/getPaymentRequest.js.map +1 -0
  134. package/dist/model/getSubAccountGroups200ResponseInner.d.ts +15 -0
  135. package/dist/model/getSubAccountGroups200ResponseInner.js +23 -0
  136. package/dist/model/getSubAccountGroups200ResponseInner.js.map +1 -0
  137. package/dist/model/getWebhook.d.ts +5 -0
  138. package/dist/model/getWebhook.js +15 -0
  139. package/dist/model/getWebhook.js.map +1 -1
  140. package/dist/model/getWebhookAuth.d.ts +15 -0
  141. package/dist/model/getWebhookAuth.js +23 -0
  142. package/dist/model/getWebhookAuth.js.map +1 -0
  143. package/dist/model/getWebhookHeadersInner.d.ts +15 -0
  144. package/dist/model/getWebhookHeadersInner.js +23 -0
  145. package/dist/model/getWebhookHeadersInner.js.map +1 -0
  146. package/dist/model/inviteAdminUser.d.ts +18 -0
  147. package/dist/model/inviteAdminUser.js +33 -0
  148. package/dist/model/inviteAdminUser.js.map +1 -0
  149. package/dist/model/inviteAdminUserPrivilegesInner.d.ts +27 -0
  150. package/dist/model/inviteAdminUserPrivilegesInner.js +37 -0
  151. package/dist/model/inviteAdminUserPrivilegesInner.js.map +1 -0
  152. package/dist/model/inviteuserPrivilegesInner.d.ts +14 -2
  153. package/dist/model/inviteuserPrivilegesInner.js +13 -1
  154. package/dist/model/inviteuserPrivilegesInner.js.map +1 -1
  155. package/dist/model/masterDetailsResponsePlanInfoFeaturesInner.d.ts +2 -0
  156. package/dist/model/masterDetailsResponsePlanInfoFeaturesInner.js +10 -0
  157. package/dist/model/masterDetailsResponsePlanInfoFeaturesInner.js.map +1 -1
  158. package/dist/model/models.d.ts +32 -0
  159. package/dist/model/models.js +102 -0
  160. package/dist/model/models.js.map +1 -1
  161. package/dist/model/notification.d.ts +20 -0
  162. package/dist/model/notification.js +29 -0
  163. package/dist/model/notification.js.map +1 -0
  164. package/dist/model/orderBatch.d.ts +1 -0
  165. package/dist/model/orderBatch.js +8 -0
  166. package/dist/model/orderBatch.js.map +1 -1
  167. package/dist/model/sendSmtpEmailMessageVersionsInner.d.ts +2 -0
  168. package/dist/model/sendSmtpEmailMessageVersionsInner.js +10 -0
  169. package/dist/model/sendSmtpEmailMessageVersionsInner.js.map +1 -1
  170. package/dist/model/sendWhatsappMessage.d.ts +1 -0
  171. package/dist/model/sendWhatsappMessage.js +5 -0
  172. package/dist/model/sendWhatsappMessage.js.map +1 -1
  173. package/dist/model/ssoTokenRequestCorporate.d.ts +14 -0
  174. package/dist/model/ssoTokenRequestCorporate.js +18 -0
  175. package/dist/model/ssoTokenRequestCorporate.js.map +1 -0
  176. package/dist/model/updateCouponCollection200Response.d.ts +1 -1
  177. package/dist/model/updateCouponCollectionRequest.d.ts +4 -1
  178. package/dist/model/updateCouponCollectionRequest.js +15 -0
  179. package/dist/model/updateCouponCollectionRequest.js.map +1 -1
  180. package/dist/model/updateWebhook.d.ts +5 -0
  181. package/dist/model/updateWebhook.js +15 -0
  182. package/dist/model/updateWebhook.js.map +1 -1
  183. package/model/cart.ts +51 -0
  184. package/model/configuration.ts +37 -0
  185. package/model/conversionSourceMetrics.ts +60 -0
  186. package/model/conversionSourceProduct.ts +73 -0
  187. package/model/corporateGroupDetailsResponse.ts +46 -0
  188. package/model/corporateGroupDetailsResponseGroup.ts +52 -0
  189. package/model/corporateGroupDetailsResponseSubAccountsInner.ts +52 -0
  190. package/model/corporateGroupDetailsResponseUsersInner.ts +52 -0
  191. package/model/corporateGroupPost201Response.ts +31 -0
  192. package/model/corporateGroupPostRequest.ts +43 -0
  193. package/model/corporateGroupUnlinkGroupIdSubAccountsPutRequest.ts +34 -0
  194. package/model/corporateUserInvitationActionEmailPut200Response.ts +31 -0
  195. package/model/createContact.ts +1 -1
  196. package/model/createCouponCollectionRequest.ts +33 -6
  197. package/model/createDomainModel.ts +9 -0
  198. package/model/createDomainModelDnsRecords.ts +6 -0
  199. package/model/createPaymentRequest.ts +64 -0
  200. package/model/createWebhook.ts +26 -0
  201. package/model/createWhatsAppTemplate.ts +2 -2
  202. package/model/crmDealsIdPatchRequest.ts +1 -1
  203. package/model/crmDealsPostRequest.ts +1 -1
  204. package/model/crmTasksIdPatchRequest.ts +1 -1
  205. package/model/crmTasksPostRequest.ts +1 -1
  206. package/model/event.ts +68 -0
  207. package/model/eventIdentifiers.ts +73 -0
  208. package/model/getContactDetails.ts +1 -1
  209. package/model/getCorporateInvitedUsersList.ts +35 -0
  210. package/model/getCorporateInvitedUsersListUsersInner.ts +66 -0
  211. package/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.ts +64 -0
  212. package/model/getCorporateInvitedUsersListUsersInnerGroups.ts +46 -0
  213. package/model/getCorporateUserPermission.ts +60 -0
  214. package/model/getCorporateUserPermissionFeatureAccess.ts +64 -0
  215. package/model/getCorporateUserPermissionGroupsInner.ts +46 -0
  216. package/model/getCouponCollection.ts +33 -6
  217. package/model/getExtendedContactDetails.ts +1 -1
  218. package/model/getOrders.ts +41 -0
  219. package/model/getOrdersOrdersInner.ts +111 -0
  220. package/model/getPaymentRequest.ts +80 -0
  221. package/model/getSubAccountGroups200ResponseInner.ts +43 -0
  222. package/model/getWebhook.ts +26 -0
  223. package/model/getWebhookAuth.ts +46 -0
  224. package/model/getWebhookHeadersInner.ts +43 -0
  225. package/model/inviteAdminUser.ts +59 -0
  226. package/model/inviteAdminUserPrivilegesInner.ts +58 -0
  227. package/model/inviteuserPrivilegesInner.ts +14 -2
  228. package/model/masterDetailsResponsePlanInfoFeaturesInner.ts +18 -0
  229. package/model/models.ts +102 -0
  230. package/model/notification.ts +51 -0
  231. package/model/orderBatch.ts +9 -0
  232. package/model/sendSmtpEmailMessageVersionsInner.ts +18 -0
  233. package/model/sendWhatsappMessage.ts +9 -0
  234. package/model/ssoTokenRequestCorporate.ts +34 -0
  235. package/model/subAccountAppsToggleRequest.ts +1 -1
  236. package/model/subAccountDetailsResponsePlanInfoFeaturesInbox.ts +1 -1
  237. package/model/subAccountDetailsResponsePlanInfoFeaturesLandingPage.ts +1 -1
  238. package/model/subAccountUpdatePlanRequestFeatures.ts +2 -2
  239. package/model/updateContact.ts +1 -1
  240. package/model/updateCouponCollection200Response.ts +1 -1
  241. package/model/updateCouponCollectionRequest.ts +28 -1
  242. package/model/updateWebhook.ts +26 -0
  243. package/package.json +3 -3
  244. /package/{.swagger-codegen-ignore → .openapi-generator-ignore} +0 -0
@@ -26,6 +26,7 @@ import { CreateUpdateProduct } from '../model/createUpdateProduct';
26
26
  import { ErrorModel } from '../model/errorModel';
27
27
  import { GetCategories } from '../model/getCategories';
28
28
  import { GetCategoryDetails } from '../model/getCategoryDetails';
29
+ import { GetOrders } from '../model/getOrders';
29
30
  import { GetProductDetails } from '../model/getProductDetails';
30
31
  import { GetProducts } from '../model/getProducts';
31
32
  import { Order } from '../model/order';
@@ -620,6 +621,250 @@ export class EcommerceApi {
620
621
  });
621
622
  });
622
623
  }
624
+ /**
625
+ *
626
+ * @summary Get detailed attribution metrics for a single Brevo campaign
627
+ * @param conversionSource The Brevo campaign type for which data will be retrieved
628
+ * @param conversionSourceId The Brevo campaign id for which data will be retrieved
629
+ */
630
+ public async ecommerceAttributionMetricsConversionSourceConversionSourceIdGet (conversionSource: any, conversionSourceId: any, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any; }> {
631
+ const localVarPath = this.basePath + '/ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId}'
632
+ .replace('{' + 'conversionSource' + '}', encodeURIComponent(String(conversionSource)))
633
+ .replace('{' + 'conversionSourceId' + '}', encodeURIComponent(String(conversionSourceId)));
634
+ let localVarQueryParameters: any = {};
635
+ let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
636
+ const produces = ['application/json'];
637
+ // give precedence to 'application/json'
638
+ if (produces.indexOf('application/json') >= 0) {
639
+ localVarHeaderParams.Accept = 'application/json';
640
+ } else {
641
+ localVarHeaderParams.Accept = produces.join(',');
642
+ }
643
+ let localVarFormParams: any = {};
644
+
645
+ // verify required parameter 'conversionSource' is not null or undefined
646
+ if (conversionSource === null || conversionSource === undefined) {
647
+ throw new Error('Required parameter conversionSource was null or undefined when calling ecommerceAttributionMetricsConversionSourceConversionSourceIdGet.');
648
+ }
649
+
650
+ // verify required parameter 'conversionSourceId' is not null or undefined
651
+ if (conversionSourceId === null || conversionSourceId === undefined) {
652
+ throw new Error('Required parameter conversionSourceId was null or undefined when calling ecommerceAttributionMetricsConversionSourceConversionSourceIdGet.');
653
+ }
654
+
655
+ (<any>Object).assign(localVarHeaderParams, options.headers);
656
+
657
+ let localVarUseFormData = false;
658
+
659
+ let localVarRequestOptions: localVarRequest.Options = {
660
+ method: 'GET',
661
+ qs: localVarQueryParameters,
662
+ headers: localVarHeaderParams,
663
+ uri: localVarPath,
664
+ useQuerystring: this._useQuerystring,
665
+ json: true,
666
+ };
667
+
668
+ let authenticationPromise = Promise.resolve();
669
+ if (this.authentications.apiKey.apiKey) {
670
+ authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
671
+ }
672
+ if (this.authentications.partnerKey.apiKey) {
673
+ authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
674
+ }
675
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
676
+
677
+ let interceptorPromise = authenticationPromise;
678
+ for (const interceptor of this.interceptors) {
679
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
680
+ }
681
+
682
+ return interceptorPromise.then(() => {
683
+ if (Object.keys(localVarFormParams).length) {
684
+ if (localVarUseFormData) {
685
+ (<any>localVarRequestOptions).formData = localVarFormParams;
686
+ } else {
687
+ localVarRequestOptions.form = localVarFormParams;
688
+ }
689
+ }
690
+ return new Promise<{ response: http.IncomingMessage; body?: any; }>((resolve, reject) => {
691
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
692
+ if (error) {
693
+ reject(error);
694
+ } else {
695
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
696
+ resolve({ response: response, body: body });
697
+ } else {
698
+ reject(new HttpError(response, body, response.statusCode));
699
+ }
700
+ }
701
+ });
702
+ });
703
+ });
704
+ }
705
+ /**
706
+ *
707
+ * @summary Get attribution metrics for one or more Brevo campaigns
708
+ * @param periodFrom When getting metrics for a specific period, define the starting datetime in RFC3339 format
709
+ * @param periodTo When getting metrics for a specific period, define the end datetime in RFC3339 format
710
+ * @param emailCampaignId The email campaign id(s) to get metrics for
711
+ */
712
+ public async ecommerceAttributionMetricsGet (periodFrom?: any, periodTo?: any, emailCampaignId?: any, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any; }> {
713
+ const localVarPath = this.basePath + '/ecommerce/attribution/metrics';
714
+ let localVarQueryParameters: any = {};
715
+ let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
716
+ const produces = ['application/json'];
717
+ // give precedence to 'application/json'
718
+ if (produces.indexOf('application/json') >= 0) {
719
+ localVarHeaderParams.Accept = 'application/json';
720
+ } else {
721
+ localVarHeaderParams.Accept = produces.join(',');
722
+ }
723
+ let localVarFormParams: any = {};
724
+
725
+ if (periodFrom !== undefined) {
726
+ localVarQueryParameters['periodFrom'] = ObjectSerializer.serialize(periodFrom, "any");
727
+ }
728
+
729
+ if (periodTo !== undefined) {
730
+ localVarQueryParameters['periodTo'] = ObjectSerializer.serialize(periodTo, "any");
731
+ }
732
+
733
+ if (emailCampaignId !== undefined) {
734
+ localVarQueryParameters['emailCampaignId[]'] = ObjectSerializer.serialize(emailCampaignId, "any");
735
+ }
736
+
737
+ (<any>Object).assign(localVarHeaderParams, options.headers);
738
+
739
+ let localVarUseFormData = false;
740
+
741
+ let localVarRequestOptions: localVarRequest.Options = {
742
+ method: 'GET',
743
+ qs: localVarQueryParameters,
744
+ headers: localVarHeaderParams,
745
+ uri: localVarPath,
746
+ useQuerystring: this._useQuerystring,
747
+ json: true,
748
+ };
749
+
750
+ let authenticationPromise = Promise.resolve();
751
+ if (this.authentications.apiKey.apiKey) {
752
+ authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
753
+ }
754
+ if (this.authentications.partnerKey.apiKey) {
755
+ authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
756
+ }
757
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
758
+
759
+ let interceptorPromise = authenticationPromise;
760
+ for (const interceptor of this.interceptors) {
761
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
762
+ }
763
+
764
+ return interceptorPromise.then(() => {
765
+ if (Object.keys(localVarFormParams).length) {
766
+ if (localVarUseFormData) {
767
+ (<any>localVarRequestOptions).formData = localVarFormParams;
768
+ } else {
769
+ localVarRequestOptions.form = localVarFormParams;
770
+ }
771
+ }
772
+ return new Promise<{ response: http.IncomingMessage; body?: any; }>((resolve, reject) => {
773
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
774
+ if (error) {
775
+ reject(error);
776
+ } else {
777
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
778
+ resolve({ response: response, body: body });
779
+ } else {
780
+ reject(new HttpError(response, body, response.statusCode));
781
+ }
782
+ }
783
+ });
784
+ });
785
+ });
786
+ }
787
+ /**
788
+ *
789
+ * @summary Get attributed product sales for a single Brevo campaign
790
+ * @param conversionSource The Brevo campaign type for which data will be retrieved
791
+ * @param conversionSourceId The Brevo campaign id for which data will be retrieved
792
+ */
793
+ public async ecommerceAttributionProductsConversionSourceConversionSourceIdGet (conversionSource: any, conversionSourceId: any, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any; }> {
794
+ const localVarPath = this.basePath + '/ecommerce/attribution/products/{conversionSource}/{conversionSourceId}'
795
+ .replace('{' + 'conversionSource' + '}', encodeURIComponent(String(conversionSource)))
796
+ .replace('{' + 'conversionSourceId' + '}', encodeURIComponent(String(conversionSourceId)));
797
+ let localVarQueryParameters: any = {};
798
+ let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
799
+ const produces = ['application/json'];
800
+ // give precedence to 'application/json'
801
+ if (produces.indexOf('application/json') >= 0) {
802
+ localVarHeaderParams.Accept = 'application/json';
803
+ } else {
804
+ localVarHeaderParams.Accept = produces.join(',');
805
+ }
806
+ let localVarFormParams: any = {};
807
+
808
+ // verify required parameter 'conversionSource' is not null or undefined
809
+ if (conversionSource === null || conversionSource === undefined) {
810
+ throw new Error('Required parameter conversionSource was null or undefined when calling ecommerceAttributionProductsConversionSourceConversionSourceIdGet.');
811
+ }
812
+
813
+ // verify required parameter 'conversionSourceId' is not null or undefined
814
+ if (conversionSourceId === null || conversionSourceId === undefined) {
815
+ throw new Error('Required parameter conversionSourceId was null or undefined when calling ecommerceAttributionProductsConversionSourceConversionSourceIdGet.');
816
+ }
817
+
818
+ (<any>Object).assign(localVarHeaderParams, options.headers);
819
+
820
+ let localVarUseFormData = false;
821
+
822
+ let localVarRequestOptions: localVarRequest.Options = {
823
+ method: 'GET',
824
+ qs: localVarQueryParameters,
825
+ headers: localVarHeaderParams,
826
+ uri: localVarPath,
827
+ useQuerystring: this._useQuerystring,
828
+ json: true,
829
+ };
830
+
831
+ let authenticationPromise = Promise.resolve();
832
+ if (this.authentications.apiKey.apiKey) {
833
+ authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
834
+ }
835
+ if (this.authentications.partnerKey.apiKey) {
836
+ authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
837
+ }
838
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
839
+
840
+ let interceptorPromise = authenticationPromise;
841
+ for (const interceptor of this.interceptors) {
842
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
843
+ }
844
+
845
+ return interceptorPromise.then(() => {
846
+ if (Object.keys(localVarFormParams).length) {
847
+ if (localVarUseFormData) {
848
+ (<any>localVarRequestOptions).formData = localVarFormParams;
849
+ } else {
850
+ localVarRequestOptions.form = localVarFormParams;
851
+ }
852
+ }
853
+ return new Promise<{ response: http.IncomingMessage; body?: any; }>((resolve, reject) => {
854
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
855
+ if (error) {
856
+ reject(error);
857
+ } else {
858
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
859
+ resolve({ response: response, body: body });
860
+ } else {
861
+ reject(new HttpError(response, body, response.statusCode));
862
+ }
863
+ }
864
+ });
865
+ });
866
+ });
867
+ }
623
868
  /**
624
869
  *
625
870
  * @summary Return all your categories
@@ -628,8 +873,10 @@ export class EcommerceApi {
628
873
  * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
629
874
  * @param ids Filter by category ids
630
875
  * @param name Filter by category name
876
+ * @param modifiedSince 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.**
877
+ * @param createdSince 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.**
631
878
  */
632
- public async getCategories (limit?: number, offset?: number, sort?: 'asc' | 'desc', ids?: Array<string>, name?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetCategories; }> {
879
+ public async getCategories (limit?: number, offset?: number, sort?: 'asc' | 'desc', ids?: Array<string>, name?: string, modifiedSince?: string, createdSince?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetCategories; }> {
633
880
  const localVarPath = this.basePath + '/categories';
634
881
  let localVarQueryParameters: any = {};
635
882
  let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -662,6 +909,14 @@ export class EcommerceApi {
662
909
  localVarQueryParameters['name'] = ObjectSerializer.serialize(name, "string");
663
910
  }
664
911
 
912
+ if (modifiedSince !== undefined) {
913
+ localVarQueryParameters['modifiedSince'] = ObjectSerializer.serialize(modifiedSince, "string");
914
+ }
915
+
916
+ if (createdSince !== undefined) {
917
+ localVarQueryParameters['createdSince'] = ObjectSerializer.serialize(createdSince, "string");
918
+ }
919
+
665
920
  (<any>Object).assign(localVarHeaderParams, options.headers);
666
921
 
667
922
  let localVarUseFormData = false;
@@ -788,6 +1043,99 @@ export class EcommerceApi {
788
1043
  });
789
1044
  });
790
1045
  }
1046
+ /**
1047
+ * Get all the orders
1048
+ * @summary Get order details
1049
+ * @param limit Number of documents per page
1050
+ * @param offset Index of the first document in the page
1051
+ * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
1052
+ * @param modifiedSince 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.**
1053
+ * @param createdSince 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.**
1054
+ */
1055
+ public async getOrders (limit?: number, offset?: number, sort?: 'asc' | 'desc', modifiedSince?: string, createdSince?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetOrders; }> {
1056
+ const localVarPath = this.basePath + '/orders';
1057
+ let localVarQueryParameters: any = {};
1058
+ let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
1059
+ const produces = ['application/json', 'response'];
1060
+ // give precedence to 'application/json'
1061
+ if (produces.indexOf('application/json') >= 0) {
1062
+ localVarHeaderParams.Accept = 'application/json';
1063
+ } else {
1064
+ localVarHeaderParams.Accept = produces.join(',');
1065
+ }
1066
+ let localVarFormParams: any = {};
1067
+
1068
+ if (limit !== undefined) {
1069
+ localVarQueryParameters['limit'] = ObjectSerializer.serialize(limit, "number");
1070
+ }
1071
+
1072
+ if (offset !== undefined) {
1073
+ localVarQueryParameters['offset'] = ObjectSerializer.serialize(offset, "number");
1074
+ }
1075
+
1076
+ if (sort !== undefined) {
1077
+ localVarQueryParameters['sort'] = ObjectSerializer.serialize(sort, "'asc' | 'desc'");
1078
+ }
1079
+
1080
+ if (modifiedSince !== undefined) {
1081
+ localVarQueryParameters['modifiedSince'] = ObjectSerializer.serialize(modifiedSince, "string");
1082
+ }
1083
+
1084
+ if (createdSince !== undefined) {
1085
+ localVarQueryParameters['createdSince'] = ObjectSerializer.serialize(createdSince, "string");
1086
+ }
1087
+
1088
+ (<any>Object).assign(localVarHeaderParams, options.headers);
1089
+
1090
+ let localVarUseFormData = false;
1091
+
1092
+ let localVarRequestOptions: localVarRequest.Options = {
1093
+ method: 'GET',
1094
+ qs: localVarQueryParameters,
1095
+ headers: localVarHeaderParams,
1096
+ uri: localVarPath,
1097
+ useQuerystring: this._useQuerystring,
1098
+ json: true,
1099
+ };
1100
+
1101
+ let authenticationPromise = Promise.resolve();
1102
+ if (this.authentications.apiKey.apiKey) {
1103
+ authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
1104
+ }
1105
+ if (this.authentications.partnerKey.apiKey) {
1106
+ authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
1107
+ }
1108
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
1109
+
1110
+ let interceptorPromise = authenticationPromise;
1111
+ for (const interceptor of this.interceptors) {
1112
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
1113
+ }
1114
+
1115
+ return interceptorPromise.then(() => {
1116
+ if (Object.keys(localVarFormParams).length) {
1117
+ if (localVarUseFormData) {
1118
+ (<any>localVarRequestOptions).formData = localVarFormParams;
1119
+ } else {
1120
+ localVarRequestOptions.form = localVarFormParams;
1121
+ }
1122
+ }
1123
+ return new Promise<{ response: http.IncomingMessage; body: GetOrders; }>((resolve, reject) => {
1124
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
1125
+ if (error) {
1126
+ reject(error);
1127
+ } else {
1128
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
1129
+ body = ObjectSerializer.deserialize(body, "GetOrders");
1130
+ resolve({ response: response, body: body });
1131
+ } else {
1132
+ reject(new HttpError(response, body, response.statusCode));
1133
+ }
1134
+ }
1135
+ });
1136
+ });
1137
+ });
1138
+ }
791
1139
  /**
792
1140
  *
793
1141
  * @summary Get a product\'s details
@@ -878,8 +1226,10 @@ export class EcommerceApi {
878
1226
  * @param priceEq Price filter for products equals to particular amount
879
1227
  * @param priceNe Price filter for products not equals to particular amount
880
1228
  * @param categories Filter by category ids
1229
+ * @param modifiedSince 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.**
1230
+ * @param createdSince 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.**
881
1231
  */
882
- public async getProducts (limit?: number, offset?: number, sort?: 'asc' | 'desc', ids?: Array<string>, name?: string, priceLte?: number, priceGte?: number, priceLt?: number, priceGt?: number, priceEq?: number, priceNe?: number, categories?: Array<string>, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetProducts; }> {
1232
+ public async getProducts (limit?: number, offset?: number, sort?: 'asc' | 'desc', ids?: Array<string>, name?: string, priceLte?: number, priceGte?: number, priceLt?: number, priceGt?: number, priceEq?: number, priceNe?: number, categories?: Array<string>, modifiedSince?: string, createdSince?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetProducts; }> {
883
1233
  const localVarPath = this.basePath + '/products';
884
1234
  let localVarQueryParameters: any = {};
885
1235
  let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
@@ -940,6 +1290,14 @@ export class EcommerceApi {
940
1290
  localVarQueryParameters['categories'] = ObjectSerializer.serialize(categories, "Array<string>");
941
1291
  }
942
1292
 
1293
+ if (modifiedSince !== undefined) {
1294
+ localVarQueryParameters['modifiedSince'] = ObjectSerializer.serialize(modifiedSince, "string");
1295
+ }
1296
+
1297
+ if (createdSince !== undefined) {
1298
+ localVarQueryParameters['createdSince'] = ObjectSerializer.serialize(createdSince, "string");
1299
+ }
1300
+
943
1301
  (<any>Object).assign(localVarHeaderParams, options.headers);
944
1302
 
945
1303
  let localVarUseFormData = false;
@@ -0,0 +1,169 @@
1
+ /**
2
+ * Brevo API
3
+ * 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 |
4
+ *
5
+ * The version of the OpenAPI document: 3.0.0
6
+ * Contact: contact@brevo.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+
13
+
14
+ import localVarRequest from 'request';
15
+ import http from 'http';
16
+
17
+ /* tslint:disable:no-unused-locals */
18
+ import { ErrorModel } from '../model/errorModel';
19
+ import { Event } from '../model/event';
20
+
21
+ import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
22
+ import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
23
+
24
+ import { HttpError, RequestFile } from './apis';
25
+
26
+ let defaultBasePath = 'https://api.brevo.com/v3';
27
+
28
+ // ===============================================
29
+ // This file is autogenerated - Please do not edit
30
+ // ===============================================
31
+
32
+ export enum EventsApiApiKeys {
33
+ apiKey,
34
+ partnerKey,
35
+ }
36
+
37
+ export class EventsApi {
38
+ protected _basePath = defaultBasePath;
39
+ protected _defaultHeaders : any = {};
40
+ protected _useQuerystring : boolean = false;
41
+
42
+ protected authentications = {
43
+ 'default': <Authentication>new VoidAuth(),
44
+ 'apiKey': new ApiKeyAuth('header', 'api-key'),
45
+ 'partnerKey': new ApiKeyAuth('header', 'partner-key'),
46
+ }
47
+
48
+ protected interceptors: Interceptor[] = [];
49
+
50
+ constructor(basePath?: string);
51
+ constructor(basePathOrUsername: string, password?: string, basePath?: string) {
52
+ if (password) {
53
+ if (basePath) {
54
+ this.basePath = basePath;
55
+ }
56
+ } else {
57
+ if (basePathOrUsername) {
58
+ this.basePath = basePathOrUsername
59
+ }
60
+ }
61
+ }
62
+
63
+ set useQuerystring(value: boolean) {
64
+ this._useQuerystring = value;
65
+ }
66
+
67
+ set basePath(basePath: string) {
68
+ this._basePath = basePath;
69
+ }
70
+
71
+ set defaultHeaders(defaultHeaders: any) {
72
+ this._defaultHeaders = defaultHeaders;
73
+ }
74
+
75
+ get defaultHeaders() {
76
+ return this._defaultHeaders;
77
+ }
78
+
79
+ get basePath() {
80
+ return this._basePath;
81
+ }
82
+
83
+ public setDefaultAuthentication(auth: Authentication) {
84
+ this.authentications.default = auth;
85
+ }
86
+
87
+ public setApiKey(key: EventsApiApiKeys, value: string) {
88
+ (this.authentications as any)[EventsApiApiKeys[key]].apiKey = value;
89
+ }
90
+
91
+ public addInterceptor(interceptor: Interceptor) {
92
+ this.interceptors.push(interceptor);
93
+ }
94
+
95
+ /**
96
+ * Create an event to track a contact\'s interaction.
97
+ * @summary Create an event
98
+ * @param event
99
+ */
100
+ public async createEvent (event: Event, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any; }> {
101
+ const localVarPath = this.basePath + '/events';
102
+ let localVarQueryParameters: any = {};
103
+ let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
104
+ const produces = ['application/json'];
105
+ // give precedence to 'application/json'
106
+ if (produces.indexOf('application/json') >= 0) {
107
+ localVarHeaderParams.Accept = 'application/json';
108
+ } else {
109
+ localVarHeaderParams.Accept = produces.join(',');
110
+ }
111
+ let localVarFormParams: any = {};
112
+
113
+ // verify required parameter 'event' is not null or undefined
114
+ if (event === null || event === undefined) {
115
+ throw new Error('Required parameter event was null or undefined when calling createEvent.');
116
+ }
117
+
118
+ (<any>Object).assign(localVarHeaderParams, options.headers);
119
+
120
+ let localVarUseFormData = false;
121
+
122
+ let localVarRequestOptions: localVarRequest.Options = {
123
+ method: 'POST',
124
+ qs: localVarQueryParameters,
125
+ headers: localVarHeaderParams,
126
+ uri: localVarPath,
127
+ useQuerystring: this._useQuerystring,
128
+ json: true,
129
+ body: ObjectSerializer.serialize(event, "Event")
130
+ };
131
+
132
+ let authenticationPromise = Promise.resolve();
133
+ if (this.authentications.apiKey.apiKey) {
134
+ authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
135
+ }
136
+ if (this.authentications.partnerKey.apiKey) {
137
+ authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
138
+ }
139
+ authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
140
+
141
+ let interceptorPromise = authenticationPromise;
142
+ for (const interceptor of this.interceptors) {
143
+ interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
144
+ }
145
+
146
+ return interceptorPromise.then(() => {
147
+ if (Object.keys(localVarFormParams).length) {
148
+ if (localVarUseFormData) {
149
+ (<any>localVarRequestOptions).formData = localVarFormParams;
150
+ } else {
151
+ localVarRequestOptions.form = localVarFormParams;
152
+ }
153
+ }
154
+ return new Promise<{ response: http.IncomingMessage; body?: any; }>((resolve, reject) => {
155
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
156
+ if (error) {
157
+ reject(error);
158
+ } else {
159
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
160
+ resolve({ response: response, body: body });
161
+ } else {
162
+ reject(new HttpError(response, body, response.statusCode));
163
+ }
164
+ }
165
+ });
166
+ });
167
+ });
168
+ }
169
+ }