hey-pharmacist-ecommerce 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +269 -0
- package/dist/index.d.mts +564 -0
- package/dist/index.d.ts +564 -0
- package/dist/index.js +7541 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +7485 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +70 -0
- package/src/components/CartItem.tsx +103 -0
- package/src/components/EmptyState.tsx +27 -0
- package/src/components/Footer.tsx +147 -0
- package/src/components/Header.tsx +151 -0
- package/src/components/OrderCard.tsx +98 -0
- package/src/components/ProductCard.tsx +122 -0
- package/src/components/ui/Badge.tsx +31 -0
- package/src/components/ui/Button.tsx +61 -0
- package/src/components/ui/Input.tsx +45 -0
- package/src/components/ui/Modal.tsx +79 -0
- package/src/components/ui/Skeleton.tsx +46 -0
- package/src/hooks/useOrders.ts +98 -0
- package/src/hooks/useProducts.ts +125 -0
- package/src/index.ts +71 -0
- package/src/lib/Apis/api.ts +46 -0
- package/src/lib/Apis/apis/addresses-api.ts +1461 -0
- package/src/lib/Apis/apis/auth-api.ts +945 -0
- package/src/lib/Apis/apis/blogs-api.ts +582 -0
- package/src/lib/Apis/apis/cart-api.ts +456 -0
- package/src/lib/Apis/apis/categories-api.ts +725 -0
- package/src/lib/Apis/apis/chats-api.ts +1101 -0
- package/src/lib/Apis/apis/contact-us-api.ts +394 -0
- package/src/lib/Apis/apis/discounts-api.ts +763 -0
- package/src/lib/Apis/apis/drafts-api.ts +448 -0
- package/src/lib/Apis/apis/events-api.ts +1311 -0
- package/src/lib/Apis/apis/file-proccesor-api.ts +293 -0
- package/src/lib/Apis/apis/health-api.ts +119 -0
- package/src/lib/Apis/apis/images-api.ts +271 -0
- package/src/lib/Apis/apis/inventory-api.ts +375 -0
- package/src/lib/Apis/apis/marketing-api.ts +3099 -0
- package/src/lib/Apis/apis/notifications-api.ts +843 -0
- package/src/lib/Apis/apis/open-aiapi.ts +513 -0
- package/src/lib/Apis/apis/orders-api.ts +1343 -0
- package/src/lib/Apis/apis/payment-methods-api.ts +411 -0
- package/src/lib/Apis/apis/payments-api.ts +469 -0
- package/src/lib/Apis/apis/product-attributes-api.ts +538 -0
- package/src/lib/Apis/apis/product-favorite-list-api.ts +321 -0
- package/src/lib/Apis/apis/product-variants-api.ts +648 -0
- package/src/lib/Apis/apis/products-api.ts +1442 -0
- package/src/lib/Apis/apis/review-api.ts +1383 -0
- package/src/lib/Apis/apis/roles-api.ts +614 -0
- package/src/lib/Apis/apis/shipping-api.ts +703 -0
- package/src/lib/Apis/apis/statistics-api.ts +234 -0
- package/src/lib/Apis/apis/stores-api.ts +1519 -0
- package/src/lib/Apis/apis/sub-categories-api.ts +1208 -0
- package/src/lib/Apis/apis/user-groups-api.ts +1198 -0
- package/src/lib/Apis/apis/users-api.ts +1403 -0
- package/src/lib/Apis/apis/web-hooks-api.ts +198 -0
- package/src/lib/Apis/base.ts +70 -0
- package/src/lib/Apis/configuration.ts +75 -0
- package/src/lib/Apis/index.ts +17 -0
- package/src/lib/Apis/models/add-contact-to-list-dto.ts +33 -0
- package/src/lib/Apis/models/add-message-dto.ts +56 -0
- package/src/lib/Apis/models/address-created-request.ts +134 -0
- package/src/lib/Apis/models/address.ts +164 -0
- package/src/lib/Apis/models/allow-user-credit-dto.ts +27 -0
- package/src/lib/Apis/models/appointment.ts +75 -0
- package/src/lib/Apis/models/available-dates-dto.ts +33 -0
- package/src/lib/Apis/models/available-suggested-dates-dto.ts +33 -0
- package/src/lib/Apis/models/blog.ts +75 -0
- package/src/lib/Apis/models/browser-stats-response-dto.ts +40 -0
- package/src/lib/Apis/models/bulk-move-subcategories-dto.ts +33 -0
- package/src/lib/Apis/models/bulk-unassign-subcategories-dto.ts +27 -0
- package/src/lib/Apis/models/campaign-content-response-dto.ts +40 -0
- package/src/lib/Apis/models/campaign-draft-dto.ts +175 -0
- package/src/lib/Apis/models/campaign-draft-response-dto.ts +40 -0
- package/src/lib/Apis/models/campaign-draft-schedule-dto.ts +49 -0
- package/src/lib/Apis/models/campaign-draft-schedule-response-dto.ts +40 -0
- package/src/lib/Apis/models/campaign-draft-sending-dto.ts +43 -0
- package/src/lib/Apis/models/campaign-draft-sending-response-dto.ts +40 -0
- package/src/lib/Apis/models/cart-body-dto.ts +40 -0
- package/src/lib/Apis/models/cart-body-populated.ts +47 -0
- package/src/lib/Apis/models/cart-item-populated.ts +41 -0
- package/src/lib/Apis/models/cart-item.ts +33 -0
- package/src/lib/Apis/models/cart-response-dto.ts +70 -0
- package/src/lib/Apis/models/categories-paginated-response-dto.ts +52 -0
- package/src/lib/Apis/models/category-filters.ts +40 -0
- package/src/lib/Apis/models/category-populated.ts +106 -0
- package/src/lib/Apis/models/category-sub-category-populated.ts +51 -0
- package/src/lib/Apis/models/category.ts +99 -0
- package/src/lib/Apis/models/categorys-headlines-response-dto.ts +40 -0
- package/src/lib/Apis/models/change-user-email-dto.ts +27 -0
- package/src/lib/Apis/models/chat.ts +33 -0
- package/src/lib/Apis/models/check-notifications-response-dto.ts +33 -0
- package/src/lib/Apis/models/contact-aggregated-stats-response-dto.ts +40 -0
- package/src/lib/Apis/models/contact-full-dto.ts +93 -0
- package/src/lib/Apis/models/contact-full-response-dto.ts +40 -0
- package/src/lib/Apis/models/contact-list-stats-response-dto.ts +40 -0
- package/src/lib/Apis/models/contact-lists-response-dto.ts +40 -0
- package/src/lib/Apis/models/contact-us.ts +81 -0
- package/src/lib/Apis/models/country-stats-response-dto.ts +40 -0
- package/src/lib/Apis/models/create-address-dto.ts +134 -0
- package/src/lib/Apis/models/create-blog-dto.ts +45 -0
- package/src/lib/Apis/models/create-category-dto.ts +45 -0
- package/src/lib/Apis/models/create-chat-dto.ts +39 -0
- package/src/lib/Apis/models/create-contact-dto.ts +39 -0
- package/src/lib/Apis/models/create-contact-list-dto.ts +27 -0
- package/src/lib/Apis/models/create-discount-dto.ts +208 -0
- package/src/lib/Apis/models/create-draft-dto.ts +67 -0
- package/src/lib/Apis/models/create-email-template-dto.ts +51 -0
- package/src/lib/Apis/models/create-event-dto.ts +52 -0
- package/src/lib/Apis/models/create-marketing-campaign-dto.ts +81 -0
- package/src/lib/Apis/models/create-message-dto.ts +57 -0
- package/src/lib/Apis/models/create-notification-dto.ts +75 -0
- package/src/lib/Apis/models/create-product-attribute-dto.ts +33 -0
- package/src/lib/Apis/models/create-product-dto.ts +94 -0
- package/src/lib/Apis/models/create-review-dto.ts +63 -0
- package/src/lib/Apis/models/create-role-dto.ts +57 -0
- package/src/lib/Apis/models/create-single-variant-product-dto.ts +155 -0
- package/src/lib/Apis/models/create-store-address-dto.ts +134 -0
- package/src/lib/Apis/models/create-store-dto.ts +105 -0
- package/src/lib/Apis/models/create-sub-category-dto.ts +45 -0
- package/src/lib/Apis/models/create-user-dto.ts +89 -0
- package/src/lib/Apis/models/create-user-group-dto.ts +39 -0
- package/src/lib/Apis/models/create-variant-dto.ts +119 -0
- package/src/lib/Apis/models/create-zone-dto.ts +82 -0
- package/src/lib/Apis/models/custom-product-dto.ts +63 -0
- package/src/lib/Apis/models/default-payment-method-request-dto.ts +27 -0
- package/src/lib/Apis/models/delete-file-dto.ts +27 -0
- package/src/lib/Apis/models/delete-many-files-dto.ts +27 -0
- package/src/lib/Apis/models/discount-paginated-response.ts +52 -0
- package/src/lib/Apis/models/discount.ts +245 -0
- package/src/lib/Apis/models/discounts-insights-dto.ts +57 -0
- package/src/lib/Apis/models/draft.ts +79 -0
- package/src/lib/Apis/models/email-invoice-dto.ts +45 -0
- package/src/lib/Apis/models/email-template-response-dto.ts +117 -0
- package/src/lib/Apis/models/event.ts +76 -0
- package/src/lib/Apis/models/extended-product-dto.ts +204 -0
- package/src/lib/Apis/models/fileproccesor-upload-body.ts +27 -0
- package/src/lib/Apis/models/forget-password.ts +27 -0
- package/src/lib/Apis/models/frequently-bought-product-dto.ts +71 -0
- package/src/lib/Apis/models/general-stats-response-dto.ts +40 -0
- package/src/lib/Apis/models/generate-day-slots-dto.ts +51 -0
- package/src/lib/Apis/models/generate-month-slots-dto.ts +57 -0
- package/src/lib/Apis/models/generate-week-slots-dto.ts +57 -0
- package/src/lib/Apis/models/google-analytics-request-dto.ts +55 -0
- package/src/lib/Apis/models/google-analytics-response-dto.ts +39 -0
- package/src/lib/Apis/models/group-with-no-users-dto.ts +75 -0
- package/src/lib/Apis/models/group-with-users-dto.ts +76 -0
- package/src/lib/Apis/models/images-upload-body.ts +27 -0
- package/src/lib/Apis/models/index.ts +197 -0
- package/src/lib/Apis/models/inventory-paginated-response.ts +75 -0
- package/src/lib/Apis/models/link-stats-response-dto.ts +40 -0
- package/src/lib/Apis/models/login-dto.ts +33 -0
- package/src/lib/Apis/models/manual-discount.ts +49 -0
- package/src/lib/Apis/models/manual-order-dto.ts +133 -0
- package/src/lib/Apis/models/manual-shipping-dto.ts +45 -0
- package/src/lib/Apis/models/marketing-campaign-content-dto.ts +27 -0
- package/src/lib/Apis/models/marketing-list-contact-dto.ts +51 -0
- package/src/lib/Apis/models/move-subcategory-dto.ts +27 -0
- package/src/lib/Apis/models/my-favorite-list-dto.ts +52 -0
- package/src/lib/Apis/models/notification.ts +93 -0
- package/src/lib/Apis/models/object-id.ts +21 -0
- package/src/lib/Apis/models/open-api.ts +33 -0
- package/src/lib/Apis/models/order-paginated-response.ts +52 -0
- package/src/lib/Apis/models/order.ts +214 -0
- package/src/lib/Apis/models/orders-insights-dto.ts +69 -0
- package/src/lib/Apis/models/paginated-products-dto.ts +52 -0
- package/src/lib/Apis/models/payment-method-data.ts +34 -0
- package/src/lib/Apis/models/payment-method.ts +51 -0
- package/src/lib/Apis/models/payment-time-line-dto.ts +56 -0
- package/src/lib/Apis/models/payment.ts +182 -0
- package/src/lib/Apis/models/payments-insights-dto.ts +69 -0
- package/src/lib/Apis/models/payments-paginated-response.ts +52 -0
- package/src/lib/Apis/models/pick-type-class.ts +51 -0
- package/src/lib/Apis/models/populated-chat-dto.ts +95 -0
- package/src/lib/Apis/models/populated-discount.ts +246 -0
- package/src/lib/Apis/models/populated-order.ts +209 -0
- package/src/lib/Apis/models/prefered-pick-or-delivery-time-dto.ts +33 -0
- package/src/lib/Apis/models/price-range.ts +33 -0
- package/src/lib/Apis/models/product-attribute.ts +57 -0
- package/src/lib/Apis/models/product-variant.ts +167 -0
- package/src/lib/Apis/models/product.ts +136 -0
- package/src/lib/Apis/models/products-insights-dto.ts +45 -0
- package/src/lib/Apis/models/rate-dto.ts +123 -0
- package/src/lib/Apis/models/refill-request-dto.ts +75 -0
- package/src/lib/Apis/models/refill-request.ts +105 -0
- package/src/lib/Apis/models/register-or-login-with-gmail.ts +27 -0
- package/src/lib/Apis/models/reserve-appointment.ts +261 -0
- package/src/lib/Apis/models/review.ts +93 -0
- package/src/lib/Apis/models/role.ts +69 -0
- package/src/lib/Apis/models/schedule-campaign-draft-dto.ts +27 -0
- package/src/lib/Apis/models/send-test-email-dto.ts +28 -0
- package/src/lib/Apis/models/shallow-parent-category-dto.ts +33 -0
- package/src/lib/Apis/models/shipment-details-dto.ts +88 -0
- package/src/lib/Apis/models/shipment-status-dto.ts +117 -0
- package/src/lib/Apis/models/shipment-with-order.ts +105 -0
- package/src/lib/Apis/models/shipment.ts +104 -0
- package/src/lib/Apis/models/shipping-info.ts +88 -0
- package/src/lib/Apis/models/single-browser-stats-dto.ts +45 -0
- package/src/lib/Apis/models/single-contact-aggregated-stats-dto.ts +129 -0
- package/src/lib/Apis/models/single-contact-list-stats-dto.ts +117 -0
- package/src/lib/Apis/models/single-country-stats-dto.ts +39 -0
- package/src/lib/Apis/models/single-general-stats.ts +153 -0
- package/src/lib/Apis/models/single-link-stats-dto.ts +39 -0
- package/src/lib/Apis/models/single-message-populated.ts +59 -0
- package/src/lib/Apis/models/single-notification-dto.ts +99 -0
- package/src/lib/Apis/models/single-product-media.ts +74 -0
- package/src/lib/Apis/models/single-recipient-dto.ts +33 -0
- package/src/lib/Apis/models/single-suggest-attribute.ts +33 -0
- package/src/lib/Apis/models/statistic-dto.ts +171 -0
- package/src/lib/Apis/models/store-entity.ts +117 -0
- package/src/lib/Apis/models/store.ts +135 -0
- package/src/lib/Apis/models/sub-category-headlines-only-response-dto.ts +39 -0
- package/src/lib/Apis/models/sub-category.ts +93 -0
- package/src/lib/Apis/models/suggest-attributes.ts +28 -0
- package/src/lib/Apis/models/suggested-slot.ts +33 -0
- package/src/lib/Apis/models/table-cell-dto.ts +33 -0
- package/src/lib/Apis/models/table-dto.ts +34 -0
- package/src/lib/Apis/models/tadmin-session-data.ts +47 -0
- package/src/lib/Apis/models/track-dto.ts +94 -0
- package/src/lib/Apis/models/tracking-status-location-base.ts +45 -0
- package/src/lib/Apis/models/tracking-status-substatus.ts +39 -0
- package/src/lib/Apis/models/tracking-status.ts +71 -0
- package/src/lib/Apis/models/transfere-patient-request.ts +123 -0
- package/src/lib/Apis/models/transfere-patients-request-dto.ts +99 -0
- package/src/lib/Apis/models/tuser-session-data.ts +34 -0
- package/src/lib/Apis/models/update-address-dto.ts +134 -0
- package/src/lib/Apis/models/update-blog-dto.ts +45 -0
- package/src/lib/Apis/models/update-campaign-draft-content-dto.ts +27 -0
- package/src/lib/Apis/models/update-category-dto.ts +45 -0
- package/src/lib/Apis/models/update-discount-dto.ts +208 -0
- package/src/lib/Apis/models/update-event-dto.ts +52 -0
- package/src/lib/Apis/models/update-items-order-dto.ts +27 -0
- package/src/lib/Apis/models/update-marketing-camp-draft-dto.ts +81 -0
- package/src/lib/Apis/models/update-message-dto.ts +57 -0
- package/src/lib/Apis/models/update-product-attribute-dto.ts +33 -0
- package/src/lib/Apis/models/update-product-dto.ts +96 -0
- package/src/lib/Apis/models/update-product-variant-dto.ts +119 -0
- package/src/lib/Apis/models/update-refill-request-dto.ts +75 -0
- package/src/lib/Apis/models/update-review-dto.ts +63 -0
- package/src/lib/Apis/models/update-role-dto.ts +57 -0
- package/src/lib/Apis/models/update-store-dto.ts +105 -0
- package/src/lib/Apis/models/update-sub-category-dto.ts +45 -0
- package/src/lib/Apis/models/update-transfere-patients-request-dto.ts +99 -0
- package/src/lib/Apis/models/update-user-dto.ts +239 -0
- package/src/lib/Apis/models/update-user-group-dto.ts +39 -0
- package/src/lib/Apis/models/update-zone-dto.ts +82 -0
- package/src/lib/Apis/models/upload-pdf-body.ts +27 -0
- package/src/lib/Apis/models/used-by.ts +87 -0
- package/src/lib/Apis/models/user-entity.ts +220 -0
- package/src/lib/Apis/models/user-group.ts +75 -0
- package/src/lib/Apis/models/user-insights-dto.ts +39 -0
- package/src/lib/Apis/models/user-with-no-id.ts +226 -0
- package/src/lib/Apis/models/user.ts +232 -0
- package/src/lib/Apis/models/users-paginated-response.ts +52 -0
- package/src/lib/Apis/models/verify-email-dto.ts +33 -0
- package/src/lib/Apis/models/zone-single-size.ts +51 -0
- package/src/lib/Apis/models/zone.ts +106 -0
- package/src/lib/Apis/wrapper.ts +37 -0
- package/src/lib/api/auth.ts +81 -0
- package/src/lib/api/cart.ts +42 -0
- package/src/lib/api/client.ts +118 -0
- package/src/lib/api/orders.ts +53 -0
- package/src/lib/api/products.ts +51 -0
- package/src/lib/api-adapter/auth-adapter.ts +196 -0
- package/src/lib/api-adapter/cart-adapter.ts +193 -0
- package/src/lib/api-adapter/config.ts +76 -0
- package/src/lib/api-adapter/index.ts +13 -0
- package/src/lib/api-adapter/mappers.ts +147 -0
- package/src/lib/api-adapter/orders-adapter.ts +195 -0
- package/src/lib/api-adapter/products-adapter.ts +194 -0
- package/src/lib/types/index.ts +152 -0
- package/src/lib/utils/colors.ts +51 -0
- package/src/lib/utils/format.ts +48 -0
- package/src/providers/AuthProvider.tsx +117 -0
- package/src/providers/CartProvider.tsx +131 -0
- package/src/providers/EcommerceProvider.tsx +34 -0
- package/src/providers/ThemeProvider.tsx +57 -0
- package/src/screens/CartScreen.tsx +140 -0
- package/src/screens/CheckoutScreen.tsx +340 -0
- package/src/screens/CurrentOrdersScreen.tsx +85 -0
- package/src/screens/LoginScreen.tsx +149 -0
- package/src/screens/OrdersScreen.tsx +86 -0
- package/src/screens/ProductDetailScreen.tsx +255 -0
- package/src/screens/ProfileScreen.tsx +211 -0
- package/src/screens/RegisterScreen.tsx +200 -0
- package/src/screens/ShopScreen.tsx +233 -0
- package/src/styles/globals.css +51 -0
|
@@ -0,0 +1,3099 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Hey Pharamcist API
|
|
5
|
+
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
6
|
+
*
|
|
7
|
+
* OpenAPI spec version: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by the swagger code generator program.
|
|
11
|
+
* https://github.com/swagger-api/swagger-codegen.git
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import globalAxios, { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
15
|
+
import { Configuration } from '../configuration';
|
|
16
|
+
// Some imports not used depending on template conditions
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
19
|
+
import { AddContactToListDTO } from '../models';
|
|
20
|
+
import { BrowserStatsResponseDTO } from '../models';
|
|
21
|
+
import { CampaignContentResponseDTO } from '../models';
|
|
22
|
+
import { CampaignDraftResponseDTO } from '../models';
|
|
23
|
+
import { CampaignDraftScheduleResponseDTO } from '../models';
|
|
24
|
+
import { CampaignDraftSendingResponseDTO } from '../models';
|
|
25
|
+
import { ContactAggregatedStatsResponseDTO } from '../models';
|
|
26
|
+
import { ContactFullResponseDTO } from '../models';
|
|
27
|
+
import { ContactListStatsResponseDTO } from '../models';
|
|
28
|
+
import { ContactListsResponseDTO } from '../models';
|
|
29
|
+
import { CountryStatsResponseDTO } from '../models';
|
|
30
|
+
import { CreateContactDTO } from '../models';
|
|
31
|
+
import { CreateContactListDTO } from '../models';
|
|
32
|
+
import { CreateEmailTemplateDTO } from '../models';
|
|
33
|
+
import { CreateMarketingCampaignDTO } from '../models';
|
|
34
|
+
import { EmailTemplateResponseDTO } from '../models';
|
|
35
|
+
import { GeneralStatsResponseDTO } from '../models';
|
|
36
|
+
import { LinkStatsResponseDTO } from '../models';
|
|
37
|
+
import { ScheduleCampaignDraftDTO } from '../models';
|
|
38
|
+
import { SendTestEmailDTO } from '../models';
|
|
39
|
+
import { UpdateCampaignDraftContentDto } from '../models';
|
|
40
|
+
import { UpdateMarketingCampDraftDto } from '../models';
|
|
41
|
+
/**
|
|
42
|
+
* MarketingApi - axios parameter creator
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export const MarketingApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
46
|
+
return {
|
|
47
|
+
/**
|
|
48
|
+
* to add a contact to a list. The user must provide the ID of the contact and the ID of the list.
|
|
49
|
+
* @summary Add a contact to a list
|
|
50
|
+
* @param {AddContactToListDTO} body
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
addContactToList: async (body: AddContactToListDTO, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
55
|
+
// verify required parameter 'body' is not null or undefined
|
|
56
|
+
if (body === null || body === undefined) {
|
|
57
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling addContactToList.');
|
|
58
|
+
}
|
|
59
|
+
const localVarPath = `/marketing/add-contact-to-list`;
|
|
60
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
61
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
62
|
+
let baseOptions;
|
|
63
|
+
if (configuration) {
|
|
64
|
+
baseOptions = configuration.baseOptions;
|
|
65
|
+
}
|
|
66
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
|
|
67
|
+
const localVarHeaderParameter = {} as any;
|
|
68
|
+
const localVarQueryParameter = {} as any;
|
|
69
|
+
|
|
70
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71
|
+
|
|
72
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
73
|
+
for (const key in localVarQueryParameter) {
|
|
74
|
+
query.set(key, localVarQueryParameter[key]);
|
|
75
|
+
}
|
|
76
|
+
for (const key in options.params) {
|
|
77
|
+
query.set(key, options.params[key]);
|
|
78
|
+
}
|
|
79
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
80
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
81
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
82
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
83
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
84
|
+
|
|
85
|
+
return {
|
|
86
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
87
|
+
options: localVarRequestOptions,
|
|
88
|
+
};
|
|
89
|
+
},
|
|
90
|
+
/**
|
|
91
|
+
* to cancel the scheduled sending of a campaign draft by providing the ID of the campaign draft.
|
|
92
|
+
* @summary Cancel the scheduled sending of a campaign draft
|
|
93
|
+
* @param {string} id
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
cancelScheduledSendingOfCampaignDraft: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
98
|
+
// verify required parameter 'id' is not null or undefined
|
|
99
|
+
if (id === null || id === undefined) {
|
|
100
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling cancelScheduledSendingOfCampaignDraft.');
|
|
101
|
+
}
|
|
102
|
+
const localVarPath = `/marketing/cancel-scheduled-sending-of-camp/{id}`
|
|
103
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
104
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
105
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
106
|
+
let baseOptions;
|
|
107
|
+
if (configuration) {
|
|
108
|
+
baseOptions = configuration.baseOptions;
|
|
109
|
+
}
|
|
110
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'DELETE', ...baseOptions, ...options};
|
|
111
|
+
const localVarHeaderParameter = {} as any;
|
|
112
|
+
const localVarQueryParameter = {} as any;
|
|
113
|
+
|
|
114
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
115
|
+
for (const key in localVarQueryParameter) {
|
|
116
|
+
query.set(key, localVarQueryParameter[key]);
|
|
117
|
+
}
|
|
118
|
+
for (const key in options.params) {
|
|
119
|
+
query.set(key, options.params[key]);
|
|
120
|
+
}
|
|
121
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
122
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
123
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
124
|
+
|
|
125
|
+
return {
|
|
126
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
127
|
+
options: localVarRequestOptions,
|
|
128
|
+
};
|
|
129
|
+
},
|
|
130
|
+
/**
|
|
131
|
+
* to create a new campaign draft. The user must provide a title, subject, contactsListId, senderEmail, senderName, senderId and locale.
|
|
132
|
+
* @summary Create a new campaign draft
|
|
133
|
+
* @param {CreateMarketingCampaignDTO} body
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
createCampaignDraft: async (body: CreateMarketingCampaignDTO, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
138
|
+
// verify required parameter 'body' is not null or undefined
|
|
139
|
+
if (body === null || body === undefined) {
|
|
140
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling createCampaignDraft.');
|
|
141
|
+
}
|
|
142
|
+
const localVarPath = `/marketing/create-campaign-draft`;
|
|
143
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
144
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
145
|
+
let baseOptions;
|
|
146
|
+
if (configuration) {
|
|
147
|
+
baseOptions = configuration.baseOptions;
|
|
148
|
+
}
|
|
149
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
|
|
150
|
+
const localVarHeaderParameter = {} as any;
|
|
151
|
+
const localVarQueryParameter = {} as any;
|
|
152
|
+
|
|
153
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
154
|
+
|
|
155
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
156
|
+
for (const key in localVarQueryParameter) {
|
|
157
|
+
query.set(key, localVarQueryParameter[key]);
|
|
158
|
+
}
|
|
159
|
+
for (const key in options.params) {
|
|
160
|
+
query.set(key, options.params[key]);
|
|
161
|
+
}
|
|
162
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
163
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
164
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
165
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
166
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
167
|
+
|
|
168
|
+
return {
|
|
169
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
170
|
+
options: localVarRequestOptions,
|
|
171
|
+
};
|
|
172
|
+
},
|
|
173
|
+
/**
|
|
174
|
+
* to create a new contact. The user must provide a name, email and isExcludedFromCampaigns parameter.
|
|
175
|
+
* @summary Create a new contact
|
|
176
|
+
* @param {CreateContactDTO} body
|
|
177
|
+
* @param {*} [options] Override http request option.
|
|
178
|
+
* @throws {RequiredError}
|
|
179
|
+
*/
|
|
180
|
+
createContact: async (body: CreateContactDTO, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
181
|
+
// verify required parameter 'body' is not null or undefined
|
|
182
|
+
if (body === null || body === undefined) {
|
|
183
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling createContact.');
|
|
184
|
+
}
|
|
185
|
+
const localVarPath = `/marketing/create-contact`;
|
|
186
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
187
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
188
|
+
let baseOptions;
|
|
189
|
+
if (configuration) {
|
|
190
|
+
baseOptions = configuration.baseOptions;
|
|
191
|
+
}
|
|
192
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
|
|
193
|
+
const localVarHeaderParameter = {} as any;
|
|
194
|
+
const localVarQueryParameter = {} as any;
|
|
195
|
+
|
|
196
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
197
|
+
|
|
198
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
199
|
+
for (const key in localVarQueryParameter) {
|
|
200
|
+
query.set(key, localVarQueryParameter[key]);
|
|
201
|
+
}
|
|
202
|
+
for (const key in options.params) {
|
|
203
|
+
query.set(key, options.params[key]);
|
|
204
|
+
}
|
|
205
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
206
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
207
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
208
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
209
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
210
|
+
|
|
211
|
+
return {
|
|
212
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
213
|
+
options: localVarRequestOptions,
|
|
214
|
+
};
|
|
215
|
+
},
|
|
216
|
+
/**
|
|
217
|
+
* to create a new contact list. The user must provide a name for the contact list.
|
|
218
|
+
* @summary Create a new contact list
|
|
219
|
+
* @param {CreateContactListDTO} body
|
|
220
|
+
* @param {*} [options] Override http request option.
|
|
221
|
+
* @throws {RequiredError}
|
|
222
|
+
*/
|
|
223
|
+
createContactList: async (body: CreateContactListDTO, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
224
|
+
// verify required parameter 'body' is not null or undefined
|
|
225
|
+
if (body === null || body === undefined) {
|
|
226
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling createContactList.');
|
|
227
|
+
}
|
|
228
|
+
const localVarPath = `/marketing/create-contact-list`;
|
|
229
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
230
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
231
|
+
let baseOptions;
|
|
232
|
+
if (configuration) {
|
|
233
|
+
baseOptions = configuration.baseOptions;
|
|
234
|
+
}
|
|
235
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
|
|
236
|
+
const localVarHeaderParameter = {} as any;
|
|
237
|
+
const localVarQueryParameter = {} as any;
|
|
238
|
+
|
|
239
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
240
|
+
|
|
241
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
242
|
+
for (const key in localVarQueryParameter) {
|
|
243
|
+
query.set(key, localVarQueryParameter[key]);
|
|
244
|
+
}
|
|
245
|
+
for (const key in options.params) {
|
|
246
|
+
query.set(key, options.params[key]);
|
|
247
|
+
}
|
|
248
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
249
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
250
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
251
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
252
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
253
|
+
|
|
254
|
+
return {
|
|
255
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
256
|
+
options: localVarRequestOptions,
|
|
257
|
+
};
|
|
258
|
+
},
|
|
259
|
+
/**
|
|
260
|
+
* to create a new email template. The user must provide a name, html content, text content, subject and description.
|
|
261
|
+
* @summary Create a new email template
|
|
262
|
+
* @param {CreateEmailTemplateDTO} body
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
createEmailTemplate: async (body: CreateEmailTemplateDTO, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
267
|
+
// verify required parameter 'body' is not null or undefined
|
|
268
|
+
if (body === null || body === undefined) {
|
|
269
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling createEmailTemplate.');
|
|
270
|
+
}
|
|
271
|
+
const localVarPath = `/marketing/create-email-template`;
|
|
272
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
273
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
274
|
+
let baseOptions;
|
|
275
|
+
if (configuration) {
|
|
276
|
+
baseOptions = configuration.baseOptions;
|
|
277
|
+
}
|
|
278
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
|
|
279
|
+
const localVarHeaderParameter = {} as any;
|
|
280
|
+
const localVarQueryParameter = {} as any;
|
|
281
|
+
|
|
282
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
283
|
+
|
|
284
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
285
|
+
for (const key in localVarQueryParameter) {
|
|
286
|
+
query.set(key, localVarQueryParameter[key]);
|
|
287
|
+
}
|
|
288
|
+
for (const key in options.params) {
|
|
289
|
+
query.set(key, options.params[key]);
|
|
290
|
+
}
|
|
291
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
292
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
293
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
294
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
295
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
296
|
+
|
|
297
|
+
return {
|
|
298
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
299
|
+
options: localVarRequestOptions,
|
|
300
|
+
};
|
|
301
|
+
},
|
|
302
|
+
/**
|
|
303
|
+
* to delete a contact list by providing the ID of the contact list.
|
|
304
|
+
* @summary Delete a contact list
|
|
305
|
+
* @param {string} id
|
|
306
|
+
* @param {*} [options] Override http request option.
|
|
307
|
+
* @throws {RequiredError}
|
|
308
|
+
*/
|
|
309
|
+
deleteContactList: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
310
|
+
// verify required parameter 'id' is not null or undefined
|
|
311
|
+
if (id === null || id === undefined) {
|
|
312
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling deleteContactList.');
|
|
313
|
+
}
|
|
314
|
+
const localVarPath = `/marketing/delete-contact-list/{id}`
|
|
315
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
316
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
317
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
318
|
+
let baseOptions;
|
|
319
|
+
if (configuration) {
|
|
320
|
+
baseOptions = configuration.baseOptions;
|
|
321
|
+
}
|
|
322
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'DELETE', ...baseOptions, ...options};
|
|
323
|
+
const localVarHeaderParameter = {} as any;
|
|
324
|
+
const localVarQueryParameter = {} as any;
|
|
325
|
+
|
|
326
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
327
|
+
for (const key in localVarQueryParameter) {
|
|
328
|
+
query.set(key, localVarQueryParameter[key]);
|
|
329
|
+
}
|
|
330
|
+
for (const key in options.params) {
|
|
331
|
+
query.set(key, options.params[key]);
|
|
332
|
+
}
|
|
333
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
334
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
335
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
336
|
+
|
|
337
|
+
return {
|
|
338
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
339
|
+
options: localVarRequestOptions,
|
|
340
|
+
};
|
|
341
|
+
},
|
|
342
|
+
/**
|
|
343
|
+
* to delete an existing email template. The user must provide the ID of the email template.
|
|
344
|
+
* @summary Delete an existing email template
|
|
345
|
+
* @param {string} id
|
|
346
|
+
* @param {*} [options] Override http request option.
|
|
347
|
+
* @throws {RequiredError}
|
|
348
|
+
*/
|
|
349
|
+
deleteEmailTemplate: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
350
|
+
// verify required parameter 'id' is not null or undefined
|
|
351
|
+
if (id === null || id === undefined) {
|
|
352
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling deleteEmailTemplate.');
|
|
353
|
+
}
|
|
354
|
+
const localVarPath = `/marketing/delete-email-template/{id}`
|
|
355
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
356
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
357
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
358
|
+
let baseOptions;
|
|
359
|
+
if (configuration) {
|
|
360
|
+
baseOptions = configuration.baseOptions;
|
|
361
|
+
}
|
|
362
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'DELETE', ...baseOptions, ...options};
|
|
363
|
+
const localVarHeaderParameter = {} as any;
|
|
364
|
+
const localVarQueryParameter = {} as any;
|
|
365
|
+
|
|
366
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
367
|
+
for (const key in localVarQueryParameter) {
|
|
368
|
+
query.set(key, localVarQueryParameter[key]);
|
|
369
|
+
}
|
|
370
|
+
for (const key in options.params) {
|
|
371
|
+
query.set(key, options.params[key]);
|
|
372
|
+
}
|
|
373
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
374
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
375
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
376
|
+
|
|
377
|
+
return {
|
|
378
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
379
|
+
options: localVarRequestOptions,
|
|
380
|
+
};
|
|
381
|
+
},
|
|
382
|
+
/**
|
|
383
|
+
* to retrieve aggregated open and click statistics, grouped by recipient country.
|
|
384
|
+
* @summary ***** Retrieve aggregated open and click statistics, grouped by recipient country
|
|
385
|
+
* @param {*} [options] Override http request option.
|
|
386
|
+
* @throws {RequiredError}
|
|
387
|
+
*/
|
|
388
|
+
getAggregatedOpenAndClickStatsGroupedByCountry: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
389
|
+
const localVarPath = `/marketing/get-aggregated-open-click-stats-grouped-by-country`;
|
|
390
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
391
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
392
|
+
let baseOptions;
|
|
393
|
+
if (configuration) {
|
|
394
|
+
baseOptions = configuration.baseOptions;
|
|
395
|
+
}
|
|
396
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
397
|
+
const localVarHeaderParameter = {} as any;
|
|
398
|
+
const localVarQueryParameter = {} as any;
|
|
399
|
+
|
|
400
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
401
|
+
for (const key in localVarQueryParameter) {
|
|
402
|
+
query.set(key, localVarQueryParameter[key]);
|
|
403
|
+
}
|
|
404
|
+
for (const key in options.params) {
|
|
405
|
+
query.set(key, options.params[key]);
|
|
406
|
+
}
|
|
407
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
408
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
409
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
410
|
+
|
|
411
|
+
return {
|
|
412
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
413
|
+
options: localVarRequestOptions,
|
|
414
|
+
};
|
|
415
|
+
},
|
|
416
|
+
/**
|
|
417
|
+
* to get aggregated statistics for all clicked links.
|
|
418
|
+
* @summary Get aggregated statistics for all clicked links
|
|
419
|
+
* @param {*} [options] Override http request option.
|
|
420
|
+
* @throws {RequiredError}
|
|
421
|
+
*/
|
|
422
|
+
getAggregatedStatsForAllClickedLinks: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
423
|
+
const localVarPath = `/marketing/get-aggregated-stats-for-all-clicked-links`;
|
|
424
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
425
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
426
|
+
let baseOptions;
|
|
427
|
+
if (configuration) {
|
|
428
|
+
baseOptions = configuration.baseOptions;
|
|
429
|
+
}
|
|
430
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
431
|
+
const localVarHeaderParameter = {} as any;
|
|
432
|
+
const localVarQueryParameter = {} as any;
|
|
433
|
+
|
|
434
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
435
|
+
for (const key in localVarQueryParameter) {
|
|
436
|
+
query.set(key, localVarQueryParameter[key]);
|
|
437
|
+
}
|
|
438
|
+
for (const key in options.params) {
|
|
439
|
+
query.set(key, options.params[key]);
|
|
440
|
+
}
|
|
441
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
442
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
443
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
444
|
+
|
|
445
|
+
return {
|
|
446
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
447
|
+
options: localVarRequestOptions,
|
|
448
|
+
};
|
|
449
|
+
},
|
|
450
|
+
/**
|
|
451
|
+
* to get aggregated statistics for all clicked links in a campaign by providing the ID of the campaign.
|
|
452
|
+
* @summary Get aggregated statistics for all clicked links in a campaign
|
|
453
|
+
* @param {string} id
|
|
454
|
+
* @param {*} [options] Override http request option.
|
|
455
|
+
* @throws {RequiredError}
|
|
456
|
+
*/
|
|
457
|
+
getAggregatedStatsForAllClickedLinksInCampaign: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
458
|
+
// verify required parameter 'id' is not null or undefined
|
|
459
|
+
if (id === null || id === undefined) {
|
|
460
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getAggregatedStatsForAllClickedLinksInCampaign.');
|
|
461
|
+
}
|
|
462
|
+
const localVarPath = `/marketing/get-aggregated-stats-for-all-clicked-links-in-campaign/{id}`
|
|
463
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
464
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
465
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
466
|
+
let baseOptions;
|
|
467
|
+
if (configuration) {
|
|
468
|
+
baseOptions = configuration.baseOptions;
|
|
469
|
+
}
|
|
470
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
471
|
+
const localVarHeaderParameter = {} as any;
|
|
472
|
+
const localVarQueryParameter = {} as any;
|
|
473
|
+
|
|
474
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
475
|
+
for (const key in localVarQueryParameter) {
|
|
476
|
+
query.set(key, localVarQueryParameter[key]);
|
|
477
|
+
}
|
|
478
|
+
for (const key in options.params) {
|
|
479
|
+
query.set(key, options.params[key]);
|
|
480
|
+
}
|
|
481
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
482
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
483
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
484
|
+
|
|
485
|
+
return {
|
|
486
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
487
|
+
options: localVarRequestOptions,
|
|
488
|
+
};
|
|
489
|
+
},
|
|
490
|
+
/**
|
|
491
|
+
* to get aggregated statistics for a specific contact by providing the ID of the contact.
|
|
492
|
+
* @summary Get aggregated statistics for a specific contact
|
|
493
|
+
* @param {string} id
|
|
494
|
+
* @param {*} [options] Override http request option.
|
|
495
|
+
* @throws {RequiredError}
|
|
496
|
+
*/
|
|
497
|
+
getAggregatedStatsForSpecificContact: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
498
|
+
// verify required parameter 'id' is not null or undefined
|
|
499
|
+
if (id === null || id === undefined) {
|
|
500
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getAggregatedStatsForSpecificContact.');
|
|
501
|
+
}
|
|
502
|
+
const localVarPath = `/marketing/get-aggregated-stats-for-specific-contact/{id}`
|
|
503
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
504
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
505
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
506
|
+
let baseOptions;
|
|
507
|
+
if (configuration) {
|
|
508
|
+
baseOptions = configuration.baseOptions;
|
|
509
|
+
}
|
|
510
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
511
|
+
const localVarHeaderParameter = {} as any;
|
|
512
|
+
const localVarQueryParameter = {} as any;
|
|
513
|
+
|
|
514
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
515
|
+
for (const key in localVarQueryParameter) {
|
|
516
|
+
query.set(key, localVarQueryParameter[key]);
|
|
517
|
+
}
|
|
518
|
+
for (const key in options.params) {
|
|
519
|
+
query.set(key, options.params[key]);
|
|
520
|
+
}
|
|
521
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
522
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
523
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
524
|
+
|
|
525
|
+
return {
|
|
526
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
527
|
+
options: localVarRequestOptions,
|
|
528
|
+
};
|
|
529
|
+
},
|
|
530
|
+
/**
|
|
531
|
+
* to get aggregated statistics for a specific list recipient by providing the ID of the list recipient.
|
|
532
|
+
* @summary Get aggregated statistics for a specific list recipient
|
|
533
|
+
* @param {string} id
|
|
534
|
+
* @param {*} [options] Override http request option.
|
|
535
|
+
* @throws {RequiredError}
|
|
536
|
+
*/
|
|
537
|
+
getAggregatedStatsForSpecificListRecipient: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
538
|
+
// verify required parameter 'id' is not null or undefined
|
|
539
|
+
if (id === null || id === undefined) {
|
|
540
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getAggregatedStatsForSpecificListRecipient.');
|
|
541
|
+
}
|
|
542
|
+
const localVarPath = `/marketing/get-aggregated-stats-for-specific-list-recipient/{id}`
|
|
543
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
544
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
545
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
546
|
+
let baseOptions;
|
|
547
|
+
if (configuration) {
|
|
548
|
+
baseOptions = configuration.baseOptions;
|
|
549
|
+
}
|
|
550
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
551
|
+
const localVarHeaderParameter = {} as any;
|
|
552
|
+
const localVarQueryParameter = {} as any;
|
|
553
|
+
|
|
554
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
555
|
+
for (const key in localVarQueryParameter) {
|
|
556
|
+
query.set(key, localVarQueryParameter[key]);
|
|
557
|
+
}
|
|
558
|
+
for (const key in options.params) {
|
|
559
|
+
query.set(key, options.params[key]);
|
|
560
|
+
}
|
|
561
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
562
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
563
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
564
|
+
|
|
565
|
+
return {
|
|
566
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
567
|
+
options: localVarRequestOptions,
|
|
568
|
+
};
|
|
569
|
+
},
|
|
570
|
+
/**
|
|
571
|
+
* to get aggregated statistics, grouped by contact.
|
|
572
|
+
* @summary Get aggregated statistics, grouped by contact
|
|
573
|
+
* @param {*} [options] Override http request option.
|
|
574
|
+
* @throws {RequiredError}
|
|
575
|
+
*/
|
|
576
|
+
getAggregatedStatsGroupedByContact: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
577
|
+
const localVarPath = `/marketing/get-aggregated-stats-grouped-by-contact`;
|
|
578
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
579
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
580
|
+
let baseOptions;
|
|
581
|
+
if (configuration) {
|
|
582
|
+
baseOptions = configuration.baseOptions;
|
|
583
|
+
}
|
|
584
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
585
|
+
const localVarHeaderParameter = {} as any;
|
|
586
|
+
const localVarQueryParameter = {} as any;
|
|
587
|
+
|
|
588
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
589
|
+
for (const key in localVarQueryParameter) {
|
|
590
|
+
query.set(key, localVarQueryParameter[key]);
|
|
591
|
+
}
|
|
592
|
+
for (const key in options.params) {
|
|
593
|
+
query.set(key, options.params[key]);
|
|
594
|
+
}
|
|
595
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
596
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
597
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
598
|
+
|
|
599
|
+
return {
|
|
600
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
601
|
+
options: localVarRequestOptions,
|
|
602
|
+
};
|
|
603
|
+
},
|
|
604
|
+
/**
|
|
605
|
+
* to get aggregated statistics, grouped by list recipient.
|
|
606
|
+
* @summary Get aggregated statistics, grouped by list recipient
|
|
607
|
+
* @param {*} [options] Override http request option.
|
|
608
|
+
* @throws {RequiredError}
|
|
609
|
+
*/
|
|
610
|
+
getAggregatedStatsGroupedByListRecipient: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
611
|
+
const localVarPath = `/marketing/get-aggregated-stats-grouped-by-list-recipient`;
|
|
612
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
613
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
614
|
+
let baseOptions;
|
|
615
|
+
if (configuration) {
|
|
616
|
+
baseOptions = configuration.baseOptions;
|
|
617
|
+
}
|
|
618
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
619
|
+
const localVarHeaderParameter = {} as any;
|
|
620
|
+
const localVarQueryParameter = {} as any;
|
|
621
|
+
|
|
622
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
623
|
+
for (const key in localVarQueryParameter) {
|
|
624
|
+
query.set(key, localVarQueryParameter[key]);
|
|
625
|
+
}
|
|
626
|
+
for (const key in options.params) {
|
|
627
|
+
query.set(key, options.params[key]);
|
|
628
|
+
}
|
|
629
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
630
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
631
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
632
|
+
|
|
633
|
+
return {
|
|
634
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
635
|
+
options: localVarRequestOptions,
|
|
636
|
+
};
|
|
637
|
+
},
|
|
638
|
+
/**
|
|
639
|
+
* to get all campaign drafts that have been created by the user.
|
|
640
|
+
* @summary Get all campaign drafts
|
|
641
|
+
* @param {*} [options] Override http request option.
|
|
642
|
+
* @throws {RequiredError}
|
|
643
|
+
*/
|
|
644
|
+
getAllCampaignDrafts: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
645
|
+
const localVarPath = `/marketing/get-all-campaign-drafts`;
|
|
646
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
647
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
648
|
+
let baseOptions;
|
|
649
|
+
if (configuration) {
|
|
650
|
+
baseOptions = configuration.baseOptions;
|
|
651
|
+
}
|
|
652
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
653
|
+
const localVarHeaderParameter = {} as any;
|
|
654
|
+
const localVarQueryParameter = {} as any;
|
|
655
|
+
|
|
656
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
657
|
+
for (const key in localVarQueryParameter) {
|
|
658
|
+
query.set(key, localVarQueryParameter[key]);
|
|
659
|
+
}
|
|
660
|
+
for (const key in options.params) {
|
|
661
|
+
query.set(key, options.params[key]);
|
|
662
|
+
}
|
|
663
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
664
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
665
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
666
|
+
|
|
667
|
+
return {
|
|
668
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
669
|
+
options: localVarRequestOptions,
|
|
670
|
+
};
|
|
671
|
+
},
|
|
672
|
+
/**
|
|
673
|
+
* to get all contact lists that have been created by the user.
|
|
674
|
+
* @summary Get all contact lists
|
|
675
|
+
* @param {*} [options] Override http request option.
|
|
676
|
+
* @throws {RequiredError}
|
|
677
|
+
*/
|
|
678
|
+
getAllContactLists: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
679
|
+
const localVarPath = `/marketing/get-all-contact-lists`;
|
|
680
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
681
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
682
|
+
let baseOptions;
|
|
683
|
+
if (configuration) {
|
|
684
|
+
baseOptions = configuration.baseOptions;
|
|
685
|
+
}
|
|
686
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
687
|
+
const localVarHeaderParameter = {} as any;
|
|
688
|
+
const localVarQueryParameter = {} as any;
|
|
689
|
+
|
|
690
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
691
|
+
for (const key in localVarQueryParameter) {
|
|
692
|
+
query.set(key, localVarQueryParameter[key]);
|
|
693
|
+
}
|
|
694
|
+
for (const key in options.params) {
|
|
695
|
+
query.set(key, options.params[key]);
|
|
696
|
+
}
|
|
697
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
698
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
699
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
700
|
+
|
|
701
|
+
return {
|
|
702
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
703
|
+
options: localVarRequestOptions,
|
|
704
|
+
};
|
|
705
|
+
},
|
|
706
|
+
/**
|
|
707
|
+
* to get all contact lists for a specific contact by providing the ID of the contact.
|
|
708
|
+
* @summary Get all contact lists for a specific contact
|
|
709
|
+
* @param {string} id
|
|
710
|
+
* @param {*} [options] Override http request option.
|
|
711
|
+
* @throws {RequiredError}
|
|
712
|
+
*/
|
|
713
|
+
getAllContactListsForContact: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
714
|
+
// verify required parameter 'id' is not null or undefined
|
|
715
|
+
if (id === null || id === undefined) {
|
|
716
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getAllContactListsForContact.');
|
|
717
|
+
}
|
|
718
|
+
const localVarPath = `/marketing/get-all-contact-lists-for-contact/{id}`
|
|
719
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
720
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
721
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
722
|
+
let baseOptions;
|
|
723
|
+
if (configuration) {
|
|
724
|
+
baseOptions = configuration.baseOptions;
|
|
725
|
+
}
|
|
726
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
727
|
+
const localVarHeaderParameter = {} as any;
|
|
728
|
+
const localVarQueryParameter = {} as any;
|
|
729
|
+
|
|
730
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
731
|
+
for (const key in localVarQueryParameter) {
|
|
732
|
+
query.set(key, localVarQueryParameter[key]);
|
|
733
|
+
}
|
|
734
|
+
for (const key in options.params) {
|
|
735
|
+
query.set(key, options.params[key]);
|
|
736
|
+
}
|
|
737
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
738
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
739
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
740
|
+
|
|
741
|
+
return {
|
|
742
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
743
|
+
options: localVarRequestOptions,
|
|
744
|
+
};
|
|
745
|
+
},
|
|
746
|
+
/**
|
|
747
|
+
* to get all contacts that have been created by the user.
|
|
748
|
+
* @summary Get all contacts
|
|
749
|
+
* @param {*} [options] Override http request option.
|
|
750
|
+
* @throws {RequiredError}
|
|
751
|
+
*/
|
|
752
|
+
getAllContacts: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
753
|
+
const localVarPath = `/marketing/get-all-contacts`;
|
|
754
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
755
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
756
|
+
let baseOptions;
|
|
757
|
+
if (configuration) {
|
|
758
|
+
baseOptions = configuration.baseOptions;
|
|
759
|
+
}
|
|
760
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
761
|
+
const localVarHeaderParameter = {} as any;
|
|
762
|
+
const localVarQueryParameter = {} as any;
|
|
763
|
+
|
|
764
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
765
|
+
for (const key in localVarQueryParameter) {
|
|
766
|
+
query.set(key, localVarQueryParameter[key]);
|
|
767
|
+
}
|
|
768
|
+
for (const key in options.params) {
|
|
769
|
+
query.set(key, options.params[key]);
|
|
770
|
+
}
|
|
771
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
772
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
773
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
774
|
+
|
|
775
|
+
return {
|
|
776
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
777
|
+
options: localVarRequestOptions,
|
|
778
|
+
};
|
|
779
|
+
},
|
|
780
|
+
/**
|
|
781
|
+
* to get all email templates that have been created by the user.
|
|
782
|
+
* @summary Get all email templates
|
|
783
|
+
* @param {*} [options] Override http request option.
|
|
784
|
+
* @throws {RequiredError}
|
|
785
|
+
*/
|
|
786
|
+
getAllEmailTemplates: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
787
|
+
const localVarPath = `/marketing/get-all-email-templates`;
|
|
788
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
789
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
790
|
+
let baseOptions;
|
|
791
|
+
if (configuration) {
|
|
792
|
+
baseOptions = configuration.baseOptions;
|
|
793
|
+
}
|
|
794
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
795
|
+
const localVarHeaderParameter = {} as any;
|
|
796
|
+
const localVarQueryParameter = {} as any;
|
|
797
|
+
|
|
798
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
799
|
+
for (const key in localVarQueryParameter) {
|
|
800
|
+
query.set(key, localVarQueryParameter[key]);
|
|
801
|
+
}
|
|
802
|
+
for (const key in options.params) {
|
|
803
|
+
query.set(key, options.params[key]);
|
|
804
|
+
}
|
|
805
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
806
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
807
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
808
|
+
|
|
809
|
+
return {
|
|
810
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
811
|
+
options: localVarRequestOptions,
|
|
812
|
+
};
|
|
813
|
+
},
|
|
814
|
+
/**
|
|
815
|
+
* to get a single campaign draft by providing the ID of the campaign draft.
|
|
816
|
+
* @summary Get a single campaign draft
|
|
817
|
+
* @param {string} id
|
|
818
|
+
* @param {*} [options] Override http request option.
|
|
819
|
+
* @throws {RequiredError}
|
|
820
|
+
*/
|
|
821
|
+
getCampaignDraft: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
822
|
+
// verify required parameter 'id' is not null or undefined
|
|
823
|
+
if (id === null || id === undefined) {
|
|
824
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getCampaignDraft.');
|
|
825
|
+
}
|
|
826
|
+
const localVarPath = `/marketing/get-campaign-draft/{id}`
|
|
827
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
828
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
829
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
830
|
+
let baseOptions;
|
|
831
|
+
if (configuration) {
|
|
832
|
+
baseOptions = configuration.baseOptions;
|
|
833
|
+
}
|
|
834
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
835
|
+
const localVarHeaderParameter = {} as any;
|
|
836
|
+
const localVarQueryParameter = {} as any;
|
|
837
|
+
|
|
838
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
839
|
+
for (const key in localVarQueryParameter) {
|
|
840
|
+
query.set(key, localVarQueryParameter[key]);
|
|
841
|
+
}
|
|
842
|
+
for (const key in options.params) {
|
|
843
|
+
query.set(key, options.params[key]);
|
|
844
|
+
}
|
|
845
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
846
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
847
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
848
|
+
|
|
849
|
+
return {
|
|
850
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
851
|
+
options: localVarRequestOptions,
|
|
852
|
+
};
|
|
853
|
+
},
|
|
854
|
+
/**
|
|
855
|
+
* to retrieve the content of a campaign draft email by providing the ID of the campaign draft.
|
|
856
|
+
* @summary Retrieve the content of a campaign draft email
|
|
857
|
+
* @param {string} id
|
|
858
|
+
* @param {*} [options] Override http request option.
|
|
859
|
+
* @throws {RequiredError}
|
|
860
|
+
*/
|
|
861
|
+
getCampaignDraftContent: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
862
|
+
// verify required parameter 'id' is not null or undefined
|
|
863
|
+
if (id === null || id === undefined) {
|
|
864
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getCampaignDraftContent.');
|
|
865
|
+
}
|
|
866
|
+
const localVarPath = `/marketing/get-campaign-draft-content/{id}`
|
|
867
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
868
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
869
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
870
|
+
let baseOptions;
|
|
871
|
+
if (configuration) {
|
|
872
|
+
baseOptions = configuration.baseOptions;
|
|
873
|
+
}
|
|
874
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
875
|
+
const localVarHeaderParameter = {} as any;
|
|
876
|
+
const localVarQueryParameter = {} as any;
|
|
877
|
+
|
|
878
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
879
|
+
for (const key in localVarQueryParameter) {
|
|
880
|
+
query.set(key, localVarQueryParameter[key]);
|
|
881
|
+
}
|
|
882
|
+
for (const key in options.params) {
|
|
883
|
+
query.set(key, options.params[key]);
|
|
884
|
+
}
|
|
885
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
886
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
887
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
888
|
+
|
|
889
|
+
return {
|
|
890
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
891
|
+
options: localVarRequestOptions,
|
|
892
|
+
};
|
|
893
|
+
},
|
|
894
|
+
/**
|
|
895
|
+
* to get a single contact by providing the ID of the contact.
|
|
896
|
+
* @summary Get a single contact
|
|
897
|
+
* @param {string} id
|
|
898
|
+
* @param {*} [options] Override http request option.
|
|
899
|
+
* @throws {RequiredError}
|
|
900
|
+
*/
|
|
901
|
+
getContact: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
902
|
+
// verify required parameter 'id' is not null or undefined
|
|
903
|
+
if (id === null || id === undefined) {
|
|
904
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getContact.');
|
|
905
|
+
}
|
|
906
|
+
const localVarPath = `/marketing/get-contact/{id}`
|
|
907
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
908
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
909
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
910
|
+
let baseOptions;
|
|
911
|
+
if (configuration) {
|
|
912
|
+
baseOptions = configuration.baseOptions;
|
|
913
|
+
}
|
|
914
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
915
|
+
const localVarHeaderParameter = {} as any;
|
|
916
|
+
const localVarQueryParameter = {} as any;
|
|
917
|
+
|
|
918
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
919
|
+
for (const key in localVarQueryParameter) {
|
|
920
|
+
query.set(key, localVarQueryParameter[key]);
|
|
921
|
+
}
|
|
922
|
+
for (const key in options.params) {
|
|
923
|
+
query.set(key, options.params[key]);
|
|
924
|
+
}
|
|
925
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
926
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
927
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
928
|
+
|
|
929
|
+
return {
|
|
930
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
931
|
+
options: localVarRequestOptions,
|
|
932
|
+
};
|
|
933
|
+
},
|
|
934
|
+
/**
|
|
935
|
+
* to get a single contact list by providing the ID of the contact list.
|
|
936
|
+
* @summary Get a single contact list
|
|
937
|
+
* @param {string} id
|
|
938
|
+
* @param {*} [options] Override http request option.
|
|
939
|
+
* @throws {RequiredError}
|
|
940
|
+
*/
|
|
941
|
+
getContactList: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
942
|
+
// verify required parameter 'id' is not null or undefined
|
|
943
|
+
if (id === null || id === undefined) {
|
|
944
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getContactList.');
|
|
945
|
+
}
|
|
946
|
+
const localVarPath = `/marketing/get-contact-list/{id}`
|
|
947
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
948
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
949
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
950
|
+
let baseOptions;
|
|
951
|
+
if (configuration) {
|
|
952
|
+
baseOptions = configuration.baseOptions;
|
|
953
|
+
}
|
|
954
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
955
|
+
const localVarHeaderParameter = {} as any;
|
|
956
|
+
const localVarQueryParameter = {} as any;
|
|
957
|
+
|
|
958
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
959
|
+
for (const key in localVarQueryParameter) {
|
|
960
|
+
query.set(key, localVarQueryParameter[key]);
|
|
961
|
+
}
|
|
962
|
+
for (const key in options.params) {
|
|
963
|
+
query.set(key, options.params[key]);
|
|
964
|
+
}
|
|
965
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
966
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
967
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
968
|
+
|
|
969
|
+
return {
|
|
970
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
971
|
+
options: localVarRequestOptions,
|
|
972
|
+
};
|
|
973
|
+
},
|
|
974
|
+
/**
|
|
975
|
+
* to get general details and stats for all drafts, AB Testing objects and/or sent campaigns.
|
|
976
|
+
* @summary Get general details and stats for all drafts, AB Testing objects and/or sent campaigns
|
|
977
|
+
* @param {*} [options] Override http request option.
|
|
978
|
+
* @throws {RequiredError}
|
|
979
|
+
*/
|
|
980
|
+
getGeneralDetailsAndStats: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
981
|
+
const localVarPath = `/marketing/get-general-stats`;
|
|
982
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
983
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
984
|
+
let baseOptions;
|
|
985
|
+
if (configuration) {
|
|
986
|
+
baseOptions = configuration.baseOptions;
|
|
987
|
+
}
|
|
988
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
989
|
+
const localVarHeaderParameter = {} as any;
|
|
990
|
+
const localVarQueryParameter = {} as any;
|
|
991
|
+
|
|
992
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
993
|
+
for (const key in localVarQueryParameter) {
|
|
994
|
+
query.set(key, localVarQueryParameter[key]);
|
|
995
|
+
}
|
|
996
|
+
for (const key in options.params) {
|
|
997
|
+
query.set(key, options.params[key]);
|
|
998
|
+
}
|
|
999
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1000
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1001
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1002
|
+
|
|
1003
|
+
return {
|
|
1004
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1005
|
+
options: localVarRequestOptions,
|
|
1006
|
+
};
|
|
1007
|
+
},
|
|
1008
|
+
/**
|
|
1009
|
+
* to get open or click counts, grouped by web browser / email client.
|
|
1010
|
+
* @summary Get open or click counts, grouped by web browser / email client
|
|
1011
|
+
* @param {*} [options] Override http request option.
|
|
1012
|
+
* @throws {RequiredError}
|
|
1013
|
+
*/
|
|
1014
|
+
getOpenOrClickCountsGroupedByBrowser: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1015
|
+
const localVarPath = `/marketing/get-open-or-click-counts-grouped-by-browser`;
|
|
1016
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1017
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1018
|
+
let baseOptions;
|
|
1019
|
+
if (configuration) {
|
|
1020
|
+
baseOptions = configuration.baseOptions;
|
|
1021
|
+
}
|
|
1022
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
1023
|
+
const localVarHeaderParameter = {} as any;
|
|
1024
|
+
const localVarQueryParameter = {} as any;
|
|
1025
|
+
|
|
1026
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1027
|
+
for (const key in localVarQueryParameter) {
|
|
1028
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1029
|
+
}
|
|
1030
|
+
for (const key in options.params) {
|
|
1031
|
+
query.set(key, options.params[key]);
|
|
1032
|
+
}
|
|
1033
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1034
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1035
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1036
|
+
|
|
1037
|
+
return {
|
|
1038
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1039
|
+
options: localVarRequestOptions,
|
|
1040
|
+
};
|
|
1041
|
+
},
|
|
1042
|
+
/**
|
|
1043
|
+
* to get information about a specific draft, AB Testing object or sent campaign by providing the ID of the campaign
|
|
1044
|
+
* @summary Get information about a specific draft, AB Testing object or sent campaign
|
|
1045
|
+
* @param {string} id
|
|
1046
|
+
* @param {*} [options] Override http request option.
|
|
1047
|
+
* @throws {RequiredError}
|
|
1048
|
+
*/
|
|
1049
|
+
getSpecificStats: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1050
|
+
// verify required parameter 'id' is not null or undefined
|
|
1051
|
+
if (id === null || id === undefined) {
|
|
1052
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getSpecificStats.');
|
|
1053
|
+
}
|
|
1054
|
+
const localVarPath = `/marketing/get-specific-stats/{id}`
|
|
1055
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1056
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1057
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1058
|
+
let baseOptions;
|
|
1059
|
+
if (configuration) {
|
|
1060
|
+
baseOptions = configuration.baseOptions;
|
|
1061
|
+
}
|
|
1062
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
1063
|
+
const localVarHeaderParameter = {} as any;
|
|
1064
|
+
const localVarQueryParameter = {} as any;
|
|
1065
|
+
|
|
1066
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1067
|
+
for (const key in localVarQueryParameter) {
|
|
1068
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1069
|
+
}
|
|
1070
|
+
for (const key in options.params) {
|
|
1071
|
+
query.set(key, options.params[key]);
|
|
1072
|
+
}
|
|
1073
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1074
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1075
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1076
|
+
|
|
1077
|
+
return {
|
|
1078
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1079
|
+
options: localVarRequestOptions,
|
|
1080
|
+
};
|
|
1081
|
+
},
|
|
1082
|
+
/**
|
|
1083
|
+
* to retrieve statistics, aggregated by recipient's Email Service Provider (ESP).
|
|
1084
|
+
* @summary Retrieve statistics, aggregated by recipient's Email Service Provider (ESP)
|
|
1085
|
+
* @param {string} id
|
|
1086
|
+
* @param {*} [options] Override http request option.
|
|
1087
|
+
* @throws {RequiredError}
|
|
1088
|
+
*/
|
|
1089
|
+
getStatsAggregatedByRecipientESP: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1090
|
+
// verify required parameter 'id' is not null or undefined
|
|
1091
|
+
if (id === null || id === undefined) {
|
|
1092
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling getStatsAggregatedByRecipientESP.');
|
|
1093
|
+
}
|
|
1094
|
+
const localVarPath = `/marketing/get-stats-aggregated-by-recipient-esp/{id}`
|
|
1095
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1096
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1097
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1098
|
+
let baseOptions;
|
|
1099
|
+
if (configuration) {
|
|
1100
|
+
baseOptions = configuration.baseOptions;
|
|
1101
|
+
}
|
|
1102
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
1103
|
+
const localVarHeaderParameter = {} as any;
|
|
1104
|
+
const localVarQueryParameter = {} as any;
|
|
1105
|
+
|
|
1106
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1107
|
+
for (const key in localVarQueryParameter) {
|
|
1108
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1109
|
+
}
|
|
1110
|
+
for (const key in options.params) {
|
|
1111
|
+
query.set(key, options.params[key]);
|
|
1112
|
+
}
|
|
1113
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1114
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1115
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1116
|
+
|
|
1117
|
+
return {
|
|
1118
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1119
|
+
options: localVarRequestOptions,
|
|
1120
|
+
};
|
|
1121
|
+
},
|
|
1122
|
+
/**
|
|
1123
|
+
* to remove a contact from a list. The user must provide the ID of the contact and the ID of the list.
|
|
1124
|
+
* @summary Remove a contact from a list
|
|
1125
|
+
* @param {AddContactToListDTO} body
|
|
1126
|
+
* @param {*} [options] Override http request option.
|
|
1127
|
+
* @throws {RequiredError}
|
|
1128
|
+
*/
|
|
1129
|
+
removeContactFromList: async (body: AddContactToListDTO, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1130
|
+
// verify required parameter 'body' is not null or undefined
|
|
1131
|
+
if (body === null || body === undefined) {
|
|
1132
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling removeContactFromList.');
|
|
1133
|
+
}
|
|
1134
|
+
const localVarPath = `/marketing/remove-contact-from-list`;
|
|
1135
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1136
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1137
|
+
let baseOptions;
|
|
1138
|
+
if (configuration) {
|
|
1139
|
+
baseOptions = configuration.baseOptions;
|
|
1140
|
+
}
|
|
1141
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
|
|
1142
|
+
const localVarHeaderParameter = {} as any;
|
|
1143
|
+
const localVarQueryParameter = {} as any;
|
|
1144
|
+
|
|
1145
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1146
|
+
|
|
1147
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1148
|
+
for (const key in localVarQueryParameter) {
|
|
1149
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1150
|
+
}
|
|
1151
|
+
for (const key in options.params) {
|
|
1152
|
+
query.set(key, options.params[key]);
|
|
1153
|
+
}
|
|
1154
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1155
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1156
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1157
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
1158
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
1159
|
+
|
|
1160
|
+
return {
|
|
1161
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1162
|
+
options: localVarRequestOptions,
|
|
1163
|
+
};
|
|
1164
|
+
},
|
|
1165
|
+
/**
|
|
1166
|
+
* to retrieve the sending schedule of a campaign draft by providing the ID of the campaign draft.
|
|
1167
|
+
* @summary Retrieve the sending schedule of a campaign draft
|
|
1168
|
+
* @param {string} id
|
|
1169
|
+
* @param {*} [options] Override http request option.
|
|
1170
|
+
* @throws {RequiredError}
|
|
1171
|
+
*/
|
|
1172
|
+
retrieveSendingScheduleOfCampaignDraft: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1173
|
+
// verify required parameter 'id' is not null or undefined
|
|
1174
|
+
if (id === null || id === undefined) {
|
|
1175
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling retrieveSendingScheduleOfCampaignDraft.');
|
|
1176
|
+
}
|
|
1177
|
+
const localVarPath = `/marketing/get-sending-schedule-of-camp/{id}`
|
|
1178
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1179
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1180
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1181
|
+
let baseOptions;
|
|
1182
|
+
if (configuration) {
|
|
1183
|
+
baseOptions = configuration.baseOptions;
|
|
1184
|
+
}
|
|
1185
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
1186
|
+
const localVarHeaderParameter = {} as any;
|
|
1187
|
+
const localVarQueryParameter = {} as any;
|
|
1188
|
+
|
|
1189
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1190
|
+
for (const key in localVarQueryParameter) {
|
|
1191
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1192
|
+
}
|
|
1193
|
+
for (const key in options.params) {
|
|
1194
|
+
query.set(key, options.params[key]);
|
|
1195
|
+
}
|
|
1196
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1197
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1198
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1199
|
+
|
|
1200
|
+
return {
|
|
1201
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1202
|
+
options: localVarRequestOptions,
|
|
1203
|
+
};
|
|
1204
|
+
},
|
|
1205
|
+
/**
|
|
1206
|
+
* to schedule a campaign draft by providing the ID of the campaign draft and the date of the schedule.
|
|
1207
|
+
* @summary Schedule a campaign draft
|
|
1208
|
+
* @param {ScheduleCampaignDraftDTO} body
|
|
1209
|
+
* @param {string} id
|
|
1210
|
+
* @param {*} [options] Override http request option.
|
|
1211
|
+
* @throws {RequiredError}
|
|
1212
|
+
*/
|
|
1213
|
+
scheduleCampaignDraft: async (body: ScheduleCampaignDraftDTO, id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1214
|
+
// verify required parameter 'body' is not null or undefined
|
|
1215
|
+
if (body === null || body === undefined) {
|
|
1216
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling scheduleCampaignDraft.');
|
|
1217
|
+
}
|
|
1218
|
+
// verify required parameter 'id' is not null or undefined
|
|
1219
|
+
if (id === null || id === undefined) {
|
|
1220
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling scheduleCampaignDraft.');
|
|
1221
|
+
}
|
|
1222
|
+
const localVarPath = `/marketing/schedule-campaign-draft/{id}`
|
|
1223
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1224
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1225
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1226
|
+
let baseOptions;
|
|
1227
|
+
if (configuration) {
|
|
1228
|
+
baseOptions = configuration.baseOptions;
|
|
1229
|
+
}
|
|
1230
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
|
|
1231
|
+
const localVarHeaderParameter = {} as any;
|
|
1232
|
+
const localVarQueryParameter = {} as any;
|
|
1233
|
+
|
|
1234
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1235
|
+
|
|
1236
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1237
|
+
for (const key in localVarQueryParameter) {
|
|
1238
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1239
|
+
}
|
|
1240
|
+
for (const key in options.params) {
|
|
1241
|
+
query.set(key, options.params[key]);
|
|
1242
|
+
}
|
|
1243
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1244
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1245
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1246
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
1247
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
1248
|
+
|
|
1249
|
+
return {
|
|
1250
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1251
|
+
options: localVarRequestOptions,
|
|
1252
|
+
};
|
|
1253
|
+
},
|
|
1254
|
+
/**
|
|
1255
|
+
* to send a campaign draft immediately by providing the ID of the campaign draft.
|
|
1256
|
+
* @summary Send a campaign draft immediately
|
|
1257
|
+
* @param {string} id
|
|
1258
|
+
* @param {*} [options] Override http request option.
|
|
1259
|
+
* @throws {RequiredError}
|
|
1260
|
+
*/
|
|
1261
|
+
sendCampaignDraftImmediately: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1262
|
+
// verify required parameter 'id' is not null or undefined
|
|
1263
|
+
if (id === null || id === undefined) {
|
|
1264
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling sendCampaignDraftImmediately.');
|
|
1265
|
+
}
|
|
1266
|
+
const localVarPath = `/marketing/send-campaign-draft-immediately/{id}`
|
|
1267
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1268
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1269
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1270
|
+
let baseOptions;
|
|
1271
|
+
if (configuration) {
|
|
1272
|
+
baseOptions = configuration.baseOptions;
|
|
1273
|
+
}
|
|
1274
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
|
|
1275
|
+
const localVarHeaderParameter = {} as any;
|
|
1276
|
+
const localVarQueryParameter = {} as any;
|
|
1277
|
+
|
|
1278
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1279
|
+
for (const key in localVarQueryParameter) {
|
|
1280
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1281
|
+
}
|
|
1282
|
+
for (const key in options.params) {
|
|
1283
|
+
query.set(key, options.params[key]);
|
|
1284
|
+
}
|
|
1285
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1286
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1287
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1288
|
+
|
|
1289
|
+
return {
|
|
1290
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1291
|
+
options: localVarRequestOptions,
|
|
1292
|
+
};
|
|
1293
|
+
},
|
|
1294
|
+
/**
|
|
1295
|
+
* to send a test email for a specified campaign draft by providing the ID of the campaign draft and the recipients of the test email.
|
|
1296
|
+
* @summary Send a test email for a specified campaign draft
|
|
1297
|
+
* @param {SendTestEmailDTO} body
|
|
1298
|
+
* @param {string} id
|
|
1299
|
+
* @param {*} [options] Override http request option.
|
|
1300
|
+
* @throws {RequiredError}
|
|
1301
|
+
*/
|
|
1302
|
+
sendTestEmail: async (body: SendTestEmailDTO, id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1303
|
+
// verify required parameter 'body' is not null or undefined
|
|
1304
|
+
if (body === null || body === undefined) {
|
|
1305
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling sendTestEmail.');
|
|
1306
|
+
}
|
|
1307
|
+
// verify required parameter 'id' is not null or undefined
|
|
1308
|
+
if (id === null || id === undefined) {
|
|
1309
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling sendTestEmail.');
|
|
1310
|
+
}
|
|
1311
|
+
const localVarPath = `/marketing/send-test-email/{id}`
|
|
1312
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1313
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1314
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1315
|
+
let baseOptions;
|
|
1316
|
+
if (configuration) {
|
|
1317
|
+
baseOptions = configuration.baseOptions;
|
|
1318
|
+
}
|
|
1319
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
|
|
1320
|
+
const localVarHeaderParameter = {} as any;
|
|
1321
|
+
const localVarQueryParameter = {} as any;
|
|
1322
|
+
|
|
1323
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1324
|
+
|
|
1325
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1326
|
+
for (const key in localVarQueryParameter) {
|
|
1327
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1328
|
+
}
|
|
1329
|
+
for (const key in options.params) {
|
|
1330
|
+
query.set(key, options.params[key]);
|
|
1331
|
+
}
|
|
1332
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1333
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1334
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1335
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
1336
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
1337
|
+
|
|
1338
|
+
return {
|
|
1339
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1340
|
+
options: localVarRequestOptions,
|
|
1341
|
+
};
|
|
1342
|
+
},
|
|
1343
|
+
/**
|
|
1344
|
+
* to update a campaign draft. The user can change the title, subject, contactsListId, senderEmail, senderName, senderId and locale of the campaign draft.
|
|
1345
|
+
* @summary Update a campaign draft
|
|
1346
|
+
* @param {UpdateMarketingCampDraftDto} body
|
|
1347
|
+
* @param {string} id
|
|
1348
|
+
* @param {*} [options] Override http request option.
|
|
1349
|
+
* @throws {RequiredError}
|
|
1350
|
+
*/
|
|
1351
|
+
updateCampaignDraft: async (body: UpdateMarketingCampDraftDto, id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1352
|
+
// verify required parameter 'body' is not null or undefined
|
|
1353
|
+
if (body === null || body === undefined) {
|
|
1354
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling updateCampaignDraft.');
|
|
1355
|
+
}
|
|
1356
|
+
// verify required parameter 'id' is not null or undefined
|
|
1357
|
+
if (id === null || id === undefined) {
|
|
1358
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling updateCampaignDraft.');
|
|
1359
|
+
}
|
|
1360
|
+
const localVarPath = `/marketing/update-campaign-draft/{id}`
|
|
1361
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1362
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1363
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1364
|
+
let baseOptions;
|
|
1365
|
+
if (configuration) {
|
|
1366
|
+
baseOptions = configuration.baseOptions;
|
|
1367
|
+
}
|
|
1368
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options};
|
|
1369
|
+
const localVarHeaderParameter = {} as any;
|
|
1370
|
+
const localVarQueryParameter = {} as any;
|
|
1371
|
+
|
|
1372
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1373
|
+
|
|
1374
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1375
|
+
for (const key in localVarQueryParameter) {
|
|
1376
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1377
|
+
}
|
|
1378
|
+
for (const key in options.params) {
|
|
1379
|
+
query.set(key, options.params[key]);
|
|
1380
|
+
}
|
|
1381
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1382
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1383
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1384
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
1385
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
1386
|
+
|
|
1387
|
+
return {
|
|
1388
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1389
|
+
options: localVarRequestOptions,
|
|
1390
|
+
};
|
|
1391
|
+
},
|
|
1392
|
+
/**
|
|
1393
|
+
* to update the content of a campaign draft. The user must provide the ID of the campaign draft and the html content.
|
|
1394
|
+
* @summary Update the content of a campaign draft
|
|
1395
|
+
* @param {UpdateCampaignDraftContentDto} body
|
|
1396
|
+
* @param {string} id
|
|
1397
|
+
* @param {*} [options] Override http request option.
|
|
1398
|
+
* @throws {RequiredError}
|
|
1399
|
+
*/
|
|
1400
|
+
updateCampaignDraftContent: async (body: UpdateCampaignDraftContentDto, id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1401
|
+
// verify required parameter 'body' is not null or undefined
|
|
1402
|
+
if (body === null || body === undefined) {
|
|
1403
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling updateCampaignDraftContent.');
|
|
1404
|
+
}
|
|
1405
|
+
// verify required parameter 'id' is not null or undefined
|
|
1406
|
+
if (id === null || id === undefined) {
|
|
1407
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling updateCampaignDraftContent.');
|
|
1408
|
+
}
|
|
1409
|
+
const localVarPath = `/marketing/update-campaign-draft-content/{id}`
|
|
1410
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1411
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1412
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1413
|
+
let baseOptions;
|
|
1414
|
+
if (configuration) {
|
|
1415
|
+
baseOptions = configuration.baseOptions;
|
|
1416
|
+
}
|
|
1417
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options};
|
|
1418
|
+
const localVarHeaderParameter = {} as any;
|
|
1419
|
+
const localVarQueryParameter = {} as any;
|
|
1420
|
+
|
|
1421
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1422
|
+
|
|
1423
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1424
|
+
for (const key in localVarQueryParameter) {
|
|
1425
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1426
|
+
}
|
|
1427
|
+
for (const key in options.params) {
|
|
1428
|
+
query.set(key, options.params[key]);
|
|
1429
|
+
}
|
|
1430
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1431
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1432
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1433
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
1434
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
1435
|
+
|
|
1436
|
+
return {
|
|
1437
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1438
|
+
options: localVarRequestOptions,
|
|
1439
|
+
};
|
|
1440
|
+
},
|
|
1441
|
+
/**
|
|
1442
|
+
* to update a contact. The user can exclude the contact from campaigns by setting the isExcludedFromCampaigns parameter to true.
|
|
1443
|
+
* @summary Update a contact
|
|
1444
|
+
* @param {string} id
|
|
1445
|
+
* @param {boolean} isExcludedFromCampaigns
|
|
1446
|
+
* @param {*} [options] Override http request option.
|
|
1447
|
+
* @throws {RequiredError}
|
|
1448
|
+
*/
|
|
1449
|
+
updateContact: async (id: string, isExcludedFromCampaigns: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1450
|
+
// verify required parameter 'id' is not null or undefined
|
|
1451
|
+
if (id === null || id === undefined) {
|
|
1452
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling updateContact.');
|
|
1453
|
+
}
|
|
1454
|
+
// verify required parameter 'isExcludedFromCampaigns' is not null or undefined
|
|
1455
|
+
if (isExcludedFromCampaigns === null || isExcludedFromCampaigns === undefined) {
|
|
1456
|
+
throw new RequiredError('isExcludedFromCampaigns','Required parameter isExcludedFromCampaigns was null or undefined when calling updateContact.');
|
|
1457
|
+
}
|
|
1458
|
+
const localVarPath = `/marketing/update-contact/{id}`
|
|
1459
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1460
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1461
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1462
|
+
let baseOptions;
|
|
1463
|
+
if (configuration) {
|
|
1464
|
+
baseOptions = configuration.baseOptions;
|
|
1465
|
+
}
|
|
1466
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options};
|
|
1467
|
+
const localVarHeaderParameter = {} as any;
|
|
1468
|
+
const localVarQueryParameter = {} as any;
|
|
1469
|
+
|
|
1470
|
+
if (isExcludedFromCampaigns !== undefined) {
|
|
1471
|
+
localVarQueryParameter['isExcludedFromCampaigns'] = isExcludedFromCampaigns;
|
|
1472
|
+
}
|
|
1473
|
+
|
|
1474
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1475
|
+
for (const key in localVarQueryParameter) {
|
|
1476
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1477
|
+
}
|
|
1478
|
+
for (const key in options.params) {
|
|
1479
|
+
query.set(key, options.params[key]);
|
|
1480
|
+
}
|
|
1481
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1482
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1483
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1484
|
+
|
|
1485
|
+
return {
|
|
1486
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1487
|
+
options: localVarRequestOptions,
|
|
1488
|
+
};
|
|
1489
|
+
},
|
|
1490
|
+
/**
|
|
1491
|
+
* to update a contact list. The user can change the name of the contact list.
|
|
1492
|
+
* @summary Update a contact list
|
|
1493
|
+
* @param {CreateContactListDTO} body
|
|
1494
|
+
* @param {string} id
|
|
1495
|
+
* @param {*} [options] Override http request option.
|
|
1496
|
+
* @throws {RequiredError}
|
|
1497
|
+
*/
|
|
1498
|
+
updateContactList: async (body: CreateContactListDTO, id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1499
|
+
// verify required parameter 'body' is not null or undefined
|
|
1500
|
+
if (body === null || body === undefined) {
|
|
1501
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling updateContactList.');
|
|
1502
|
+
}
|
|
1503
|
+
// verify required parameter 'id' is not null or undefined
|
|
1504
|
+
if (id === null || id === undefined) {
|
|
1505
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling updateContactList.');
|
|
1506
|
+
}
|
|
1507
|
+
const localVarPath = `/marketing/update-contact-list/{id}`
|
|
1508
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1509
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1510
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1511
|
+
let baseOptions;
|
|
1512
|
+
if (configuration) {
|
|
1513
|
+
baseOptions = configuration.baseOptions;
|
|
1514
|
+
}
|
|
1515
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options};
|
|
1516
|
+
const localVarHeaderParameter = {} as any;
|
|
1517
|
+
const localVarQueryParameter = {} as any;
|
|
1518
|
+
|
|
1519
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1520
|
+
|
|
1521
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1522
|
+
for (const key in localVarQueryParameter) {
|
|
1523
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1524
|
+
}
|
|
1525
|
+
for (const key in options.params) {
|
|
1526
|
+
query.set(key, options.params[key]);
|
|
1527
|
+
}
|
|
1528
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1529
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1530
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1531
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
1532
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
1533
|
+
|
|
1534
|
+
return {
|
|
1535
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1536
|
+
options: localVarRequestOptions,
|
|
1537
|
+
};
|
|
1538
|
+
},
|
|
1539
|
+
/**
|
|
1540
|
+
* to update an existing email template. The user must provide the ID of the email template and the name, html content, text content, subject and description.
|
|
1541
|
+
* @summary Update an existing email template
|
|
1542
|
+
* @param {CreateEmailTemplateDTO} body
|
|
1543
|
+
* @param {string} id
|
|
1544
|
+
* @param {*} [options] Override http request option.
|
|
1545
|
+
* @throws {RequiredError}
|
|
1546
|
+
*/
|
|
1547
|
+
updateEmailTemplate: async (body: CreateEmailTemplateDTO, id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1548
|
+
// verify required parameter 'body' is not null or undefined
|
|
1549
|
+
if (body === null || body === undefined) {
|
|
1550
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling updateEmailTemplate.');
|
|
1551
|
+
}
|
|
1552
|
+
// verify required parameter 'id' is not null or undefined
|
|
1553
|
+
if (id === null || id === undefined) {
|
|
1554
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling updateEmailTemplate.');
|
|
1555
|
+
}
|
|
1556
|
+
const localVarPath = `/marketing/update-email-template/{id}`
|
|
1557
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1558
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1559
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1560
|
+
let baseOptions;
|
|
1561
|
+
if (configuration) {
|
|
1562
|
+
baseOptions = configuration.baseOptions;
|
|
1563
|
+
}
|
|
1564
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options};
|
|
1565
|
+
const localVarHeaderParameter = {} as any;
|
|
1566
|
+
const localVarQueryParameter = {} as any;
|
|
1567
|
+
|
|
1568
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1569
|
+
|
|
1570
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1571
|
+
for (const key in localVarQueryParameter) {
|
|
1572
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1573
|
+
}
|
|
1574
|
+
for (const key in options.params) {
|
|
1575
|
+
query.set(key, options.params[key]);
|
|
1576
|
+
}
|
|
1577
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1578
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1579
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1580
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
1581
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
1582
|
+
|
|
1583
|
+
return {
|
|
1584
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1585
|
+
options: localVarRequestOptions,
|
|
1586
|
+
};
|
|
1587
|
+
},
|
|
1588
|
+
/**
|
|
1589
|
+
* to update the sending schedule of a campaign draft by providing the ID of the campaign draft and the date of the schedule.
|
|
1590
|
+
* @summary Update the sending schedule of a campaign draft
|
|
1591
|
+
* @param {ScheduleCampaignDraftDTO} body
|
|
1592
|
+
* @param {string} id
|
|
1593
|
+
* @param {*} [options] Override http request option.
|
|
1594
|
+
* @throws {RequiredError}
|
|
1595
|
+
*/
|
|
1596
|
+
updateSendingScheduleOfCampaignDraft: async (body: ScheduleCampaignDraftDTO, id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1597
|
+
// verify required parameter 'body' is not null or undefined
|
|
1598
|
+
if (body === null || body === undefined) {
|
|
1599
|
+
throw new RequiredError('body','Required parameter body was null or undefined when calling updateSendingScheduleOfCampaignDraft.');
|
|
1600
|
+
}
|
|
1601
|
+
// verify required parameter 'id' is not null or undefined
|
|
1602
|
+
if (id === null || id === undefined) {
|
|
1603
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling updateSendingScheduleOfCampaignDraft.');
|
|
1604
|
+
}
|
|
1605
|
+
const localVarPath = `/marketing/update-sending-schedule-of-camp/{id}`
|
|
1606
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1607
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1608
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1609
|
+
let baseOptions;
|
|
1610
|
+
if (configuration) {
|
|
1611
|
+
baseOptions = configuration.baseOptions;
|
|
1612
|
+
}
|
|
1613
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options};
|
|
1614
|
+
const localVarHeaderParameter = {} as any;
|
|
1615
|
+
const localVarQueryParameter = {} as any;
|
|
1616
|
+
|
|
1617
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1618
|
+
|
|
1619
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1620
|
+
for (const key in localVarQueryParameter) {
|
|
1621
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1622
|
+
}
|
|
1623
|
+
for (const key in options.params) {
|
|
1624
|
+
query.set(key, options.params[key]);
|
|
1625
|
+
}
|
|
1626
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1627
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1628
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1629
|
+
const needsSerialization = (typeof body !== "string") || (localVarRequestOptions.headers ||= {})['Content-Type'] === 'application/json';
|
|
1630
|
+
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
|
|
1631
|
+
|
|
1632
|
+
return {
|
|
1633
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1634
|
+
options: localVarRequestOptions,
|
|
1635
|
+
};
|
|
1636
|
+
},
|
|
1637
|
+
/**
|
|
1638
|
+
* to view the sending status of a campaign draft by providing the ID of the campaign draft.
|
|
1639
|
+
* @summary View the sending status of a campaign draft
|
|
1640
|
+
* @param {string} id
|
|
1641
|
+
* @param {*} [options] Override http request option.
|
|
1642
|
+
* @throws {RequiredError}
|
|
1643
|
+
*/
|
|
1644
|
+
viewSendingStatusOfCampaignDraft: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1645
|
+
// verify required parameter 'id' is not null or undefined
|
|
1646
|
+
if (id === null || id === undefined) {
|
|
1647
|
+
throw new RequiredError('id','Required parameter id was null or undefined when calling viewSendingStatusOfCampaignDraft.');
|
|
1648
|
+
}
|
|
1649
|
+
const localVarPath = `/marketing/get-sending-status-of-camp/{id}`
|
|
1650
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1651
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1652
|
+
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
|
|
1653
|
+
let baseOptions;
|
|
1654
|
+
if (configuration) {
|
|
1655
|
+
baseOptions = configuration.baseOptions;
|
|
1656
|
+
}
|
|
1657
|
+
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
|
|
1658
|
+
const localVarHeaderParameter = {} as any;
|
|
1659
|
+
const localVarQueryParameter = {} as any;
|
|
1660
|
+
|
|
1661
|
+
const query = new URLSearchParams(localVarUrlObj.search);
|
|
1662
|
+
for (const key in localVarQueryParameter) {
|
|
1663
|
+
query.set(key, localVarQueryParameter[key]);
|
|
1664
|
+
}
|
|
1665
|
+
for (const key in options.params) {
|
|
1666
|
+
query.set(key, options.params[key]);
|
|
1667
|
+
}
|
|
1668
|
+
localVarUrlObj.search = (new URLSearchParams(query)).toString();
|
|
1669
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1670
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1671
|
+
|
|
1672
|
+
return {
|
|
1673
|
+
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
|
|
1674
|
+
options: localVarRequestOptions,
|
|
1675
|
+
};
|
|
1676
|
+
},
|
|
1677
|
+
}
|
|
1678
|
+
};
|
|
1679
|
+
|
|
1680
|
+
/**
|
|
1681
|
+
* MarketingApi - functional programming interface
|
|
1682
|
+
* @export
|
|
1683
|
+
*/
|
|
1684
|
+
export const MarketingApiFp = function(configuration?: Configuration) {
|
|
1685
|
+
return {
|
|
1686
|
+
/**
|
|
1687
|
+
* to add a contact to a list. The user must provide the ID of the contact and the ID of the list.
|
|
1688
|
+
* @summary Add a contact to a list
|
|
1689
|
+
* @param {AddContactToListDTO} body
|
|
1690
|
+
* @param {*} [options] Override http request option.
|
|
1691
|
+
* @throws {RequiredError}
|
|
1692
|
+
*/
|
|
1693
|
+
async addContactToList(body: AddContactToListDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
|
|
1694
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).addContactToList(body, options);
|
|
1695
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1696
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1697
|
+
return axios.request(axiosRequestArgs);
|
|
1698
|
+
};
|
|
1699
|
+
},
|
|
1700
|
+
/**
|
|
1701
|
+
* to cancel the scheduled sending of a campaign draft by providing the ID of the campaign draft.
|
|
1702
|
+
* @summary Cancel the scheduled sending of a campaign draft
|
|
1703
|
+
* @param {string} id
|
|
1704
|
+
* @param {*} [options] Override http request option.
|
|
1705
|
+
* @throws {RequiredError}
|
|
1706
|
+
*/
|
|
1707
|
+
async cancelScheduledSendingOfCampaignDraft(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
|
|
1708
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).cancelScheduledSendingOfCampaignDraft(id, options);
|
|
1709
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1710
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1711
|
+
return axios.request(axiosRequestArgs);
|
|
1712
|
+
};
|
|
1713
|
+
},
|
|
1714
|
+
/**
|
|
1715
|
+
* to create a new campaign draft. The user must provide a title, subject, contactsListId, senderEmail, senderName, senderId and locale.
|
|
1716
|
+
* @summary Create a new campaign draft
|
|
1717
|
+
* @param {CreateMarketingCampaignDTO} body
|
|
1718
|
+
* @param {*} [options] Override http request option.
|
|
1719
|
+
* @throws {RequiredError}
|
|
1720
|
+
*/
|
|
1721
|
+
async createCampaignDraft(body: CreateMarketingCampaignDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignDraftResponseDTO>>> {
|
|
1722
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).createCampaignDraft(body, options);
|
|
1723
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1724
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1725
|
+
return axios.request(axiosRequestArgs);
|
|
1726
|
+
};
|
|
1727
|
+
},
|
|
1728
|
+
/**
|
|
1729
|
+
* to create a new contact. The user must provide a name, email and isExcludedFromCampaigns parameter.
|
|
1730
|
+
* @summary Create a new contact
|
|
1731
|
+
* @param {CreateContactDTO} body
|
|
1732
|
+
* @param {*} [options] Override http request option.
|
|
1733
|
+
* @throws {RequiredError}
|
|
1734
|
+
*/
|
|
1735
|
+
async createContact(body: CreateContactDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactFullResponseDTO>>> {
|
|
1736
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).createContact(body, options);
|
|
1737
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1738
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1739
|
+
return axios.request(axiosRequestArgs);
|
|
1740
|
+
};
|
|
1741
|
+
},
|
|
1742
|
+
/**
|
|
1743
|
+
* to create a new contact list. The user must provide a name for the contact list.
|
|
1744
|
+
* @summary Create a new contact list
|
|
1745
|
+
* @param {CreateContactListDTO} body
|
|
1746
|
+
* @param {*} [options] Override http request option.
|
|
1747
|
+
* @throws {RequiredError}
|
|
1748
|
+
*/
|
|
1749
|
+
async createContactList(body: CreateContactListDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactListsResponseDTO>>> {
|
|
1750
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).createContactList(body, options);
|
|
1751
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1752
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1753
|
+
return axios.request(axiosRequestArgs);
|
|
1754
|
+
};
|
|
1755
|
+
},
|
|
1756
|
+
/**
|
|
1757
|
+
* to create a new email template. The user must provide a name, html content, text content, subject and description.
|
|
1758
|
+
* @summary Create a new email template
|
|
1759
|
+
* @param {CreateEmailTemplateDTO} body
|
|
1760
|
+
* @param {*} [options] Override http request option.
|
|
1761
|
+
* @throws {RequiredError}
|
|
1762
|
+
*/
|
|
1763
|
+
async createEmailTemplate(body: CreateEmailTemplateDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<EmailTemplateResponseDTO>>>> {
|
|
1764
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).createEmailTemplate(body, options);
|
|
1765
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1766
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1767
|
+
return axios.request(axiosRequestArgs);
|
|
1768
|
+
};
|
|
1769
|
+
},
|
|
1770
|
+
/**
|
|
1771
|
+
* to delete a contact list by providing the ID of the contact list.
|
|
1772
|
+
* @summary Delete a contact list
|
|
1773
|
+
* @param {string} id
|
|
1774
|
+
* @param {*} [options] Override http request option.
|
|
1775
|
+
* @throws {RequiredError}
|
|
1776
|
+
*/
|
|
1777
|
+
async deleteContactList(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
|
|
1778
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).deleteContactList(id, options);
|
|
1779
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1780
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1781
|
+
return axios.request(axiosRequestArgs);
|
|
1782
|
+
};
|
|
1783
|
+
},
|
|
1784
|
+
/**
|
|
1785
|
+
* to delete an existing email template. The user must provide the ID of the email template.
|
|
1786
|
+
* @summary Delete an existing email template
|
|
1787
|
+
* @param {string} id
|
|
1788
|
+
* @param {*} [options] Override http request option.
|
|
1789
|
+
* @throws {RequiredError}
|
|
1790
|
+
*/
|
|
1791
|
+
async deleteEmailTemplate(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
|
|
1792
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).deleteEmailTemplate(id, options);
|
|
1793
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1794
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1795
|
+
return axios.request(axiosRequestArgs);
|
|
1796
|
+
};
|
|
1797
|
+
},
|
|
1798
|
+
/**
|
|
1799
|
+
* to retrieve aggregated open and click statistics, grouped by recipient country.
|
|
1800
|
+
* @summary ***** Retrieve aggregated open and click statistics, grouped by recipient country
|
|
1801
|
+
* @param {*} [options] Override http request option.
|
|
1802
|
+
* @throws {RequiredError}
|
|
1803
|
+
*/
|
|
1804
|
+
async getAggregatedOpenAndClickStatsGroupedByCountry(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CountryStatsResponseDTO>>> {
|
|
1805
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAggregatedOpenAndClickStatsGroupedByCountry(options);
|
|
1806
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1807
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1808
|
+
return axios.request(axiosRequestArgs);
|
|
1809
|
+
};
|
|
1810
|
+
},
|
|
1811
|
+
/**
|
|
1812
|
+
* to get aggregated statistics for all clicked links.
|
|
1813
|
+
* @summary Get aggregated statistics for all clicked links
|
|
1814
|
+
* @param {*} [options] Override http request option.
|
|
1815
|
+
* @throws {RequiredError}
|
|
1816
|
+
*/
|
|
1817
|
+
async getAggregatedStatsForAllClickedLinks(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<LinkStatsResponseDTO>>> {
|
|
1818
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAggregatedStatsForAllClickedLinks(options);
|
|
1819
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1820
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1821
|
+
return axios.request(axiosRequestArgs);
|
|
1822
|
+
};
|
|
1823
|
+
},
|
|
1824
|
+
/**
|
|
1825
|
+
* to get aggregated statistics for all clicked links in a campaign by providing the ID of the campaign.
|
|
1826
|
+
* @summary Get aggregated statistics for all clicked links in a campaign
|
|
1827
|
+
* @param {string} id
|
|
1828
|
+
* @param {*} [options] Override http request option.
|
|
1829
|
+
* @throws {RequiredError}
|
|
1830
|
+
*/
|
|
1831
|
+
async getAggregatedStatsForAllClickedLinksInCampaign(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
|
|
1832
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAggregatedStatsForAllClickedLinksInCampaign(id, options);
|
|
1833
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1834
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1835
|
+
return axios.request(axiosRequestArgs);
|
|
1836
|
+
};
|
|
1837
|
+
},
|
|
1838
|
+
/**
|
|
1839
|
+
* to get aggregated statistics for a specific contact by providing the ID of the contact.
|
|
1840
|
+
* @summary Get aggregated statistics for a specific contact
|
|
1841
|
+
* @param {string} id
|
|
1842
|
+
* @param {*} [options] Override http request option.
|
|
1843
|
+
* @throws {RequiredError}
|
|
1844
|
+
*/
|
|
1845
|
+
async getAggregatedStatsForSpecificContact(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactAggregatedStatsResponseDTO>>> {
|
|
1846
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAggregatedStatsForSpecificContact(id, options);
|
|
1847
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1848
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1849
|
+
return axios.request(axiosRequestArgs);
|
|
1850
|
+
};
|
|
1851
|
+
},
|
|
1852
|
+
/**
|
|
1853
|
+
* to get aggregated statistics for a specific list recipient by providing the ID of the list recipient.
|
|
1854
|
+
* @summary Get aggregated statistics for a specific list recipient
|
|
1855
|
+
* @param {string} id
|
|
1856
|
+
* @param {*} [options] Override http request option.
|
|
1857
|
+
* @throws {RequiredError}
|
|
1858
|
+
*/
|
|
1859
|
+
async getAggregatedStatsForSpecificListRecipient(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactListStatsResponseDTO>>> {
|
|
1860
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAggregatedStatsForSpecificListRecipient(id, options);
|
|
1861
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1862
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1863
|
+
return axios.request(axiosRequestArgs);
|
|
1864
|
+
};
|
|
1865
|
+
},
|
|
1866
|
+
/**
|
|
1867
|
+
* to get aggregated statistics, grouped by contact.
|
|
1868
|
+
* @summary Get aggregated statistics, grouped by contact
|
|
1869
|
+
* @param {*} [options] Override http request option.
|
|
1870
|
+
* @throws {RequiredError}
|
|
1871
|
+
*/
|
|
1872
|
+
async getAggregatedStatsGroupedByContact(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactAggregatedStatsResponseDTO>>> {
|
|
1873
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAggregatedStatsGroupedByContact(options);
|
|
1874
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1875
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1876
|
+
return axios.request(axiosRequestArgs);
|
|
1877
|
+
};
|
|
1878
|
+
},
|
|
1879
|
+
/**
|
|
1880
|
+
* to get aggregated statistics, grouped by list recipient.
|
|
1881
|
+
* @summary Get aggregated statistics, grouped by list recipient
|
|
1882
|
+
* @param {*} [options] Override http request option.
|
|
1883
|
+
* @throws {RequiredError}
|
|
1884
|
+
*/
|
|
1885
|
+
async getAggregatedStatsGroupedByListRecipient(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactListStatsResponseDTO>>> {
|
|
1886
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAggregatedStatsGroupedByListRecipient(options);
|
|
1887
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1888
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1889
|
+
return axios.request(axiosRequestArgs);
|
|
1890
|
+
};
|
|
1891
|
+
},
|
|
1892
|
+
/**
|
|
1893
|
+
* to get all campaign drafts that have been created by the user.
|
|
1894
|
+
* @summary Get all campaign drafts
|
|
1895
|
+
* @param {*} [options] Override http request option.
|
|
1896
|
+
* @throws {RequiredError}
|
|
1897
|
+
*/
|
|
1898
|
+
async getAllCampaignDrafts(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignDraftResponseDTO>>> {
|
|
1899
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAllCampaignDrafts(options);
|
|
1900
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1901
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1902
|
+
return axios.request(axiosRequestArgs);
|
|
1903
|
+
};
|
|
1904
|
+
},
|
|
1905
|
+
/**
|
|
1906
|
+
* to get all contact lists that have been created by the user.
|
|
1907
|
+
* @summary Get all contact lists
|
|
1908
|
+
* @param {*} [options] Override http request option.
|
|
1909
|
+
* @throws {RequiredError}
|
|
1910
|
+
*/
|
|
1911
|
+
async getAllContactLists(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactListsResponseDTO>>> {
|
|
1912
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAllContactLists(options);
|
|
1913
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1914
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1915
|
+
return axios.request(axiosRequestArgs);
|
|
1916
|
+
};
|
|
1917
|
+
},
|
|
1918
|
+
/**
|
|
1919
|
+
* to get all contact lists for a specific contact by providing the ID of the contact.
|
|
1920
|
+
* @summary Get all contact lists for a specific contact
|
|
1921
|
+
* @param {string} id
|
|
1922
|
+
* @param {*} [options] Override http request option.
|
|
1923
|
+
* @throws {RequiredError}
|
|
1924
|
+
*/
|
|
1925
|
+
async getAllContactListsForContact(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactListsResponseDTO>>> {
|
|
1926
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAllContactListsForContact(id, options);
|
|
1927
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1928
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1929
|
+
return axios.request(axiosRequestArgs);
|
|
1930
|
+
};
|
|
1931
|
+
},
|
|
1932
|
+
/**
|
|
1933
|
+
* to get all contacts that have been created by the user.
|
|
1934
|
+
* @summary Get all contacts
|
|
1935
|
+
* @param {*} [options] Override http request option.
|
|
1936
|
+
* @throws {RequiredError}
|
|
1937
|
+
*/
|
|
1938
|
+
async getAllContacts(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactFullResponseDTO>>> {
|
|
1939
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAllContacts(options);
|
|
1940
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1941
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1942
|
+
return axios.request(axiosRequestArgs);
|
|
1943
|
+
};
|
|
1944
|
+
},
|
|
1945
|
+
/**
|
|
1946
|
+
* to get all email templates that have been created by the user.
|
|
1947
|
+
* @summary Get all email templates
|
|
1948
|
+
* @param {*} [options] Override http request option.
|
|
1949
|
+
* @throws {RequiredError}
|
|
1950
|
+
*/
|
|
1951
|
+
async getAllEmailTemplates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<EmailTemplateResponseDTO>>>> {
|
|
1952
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getAllEmailTemplates(options);
|
|
1953
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1954
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1955
|
+
return axios.request(axiosRequestArgs);
|
|
1956
|
+
};
|
|
1957
|
+
},
|
|
1958
|
+
/**
|
|
1959
|
+
* to get a single campaign draft by providing the ID of the campaign draft.
|
|
1960
|
+
* @summary Get a single campaign draft
|
|
1961
|
+
* @param {string} id
|
|
1962
|
+
* @param {*} [options] Override http request option.
|
|
1963
|
+
* @throws {RequiredError}
|
|
1964
|
+
*/
|
|
1965
|
+
async getCampaignDraft(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignDraftResponseDTO>>> {
|
|
1966
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getCampaignDraft(id, options);
|
|
1967
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1968
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1969
|
+
return axios.request(axiosRequestArgs);
|
|
1970
|
+
};
|
|
1971
|
+
},
|
|
1972
|
+
/**
|
|
1973
|
+
* to retrieve the content of a campaign draft email by providing the ID of the campaign draft.
|
|
1974
|
+
* @summary Retrieve the content of a campaign draft email
|
|
1975
|
+
* @param {string} id
|
|
1976
|
+
* @param {*} [options] Override http request option.
|
|
1977
|
+
* @throws {RequiredError}
|
|
1978
|
+
*/
|
|
1979
|
+
async getCampaignDraftContent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignContentResponseDTO>>> {
|
|
1980
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getCampaignDraftContent(id, options);
|
|
1981
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1982
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1983
|
+
return axios.request(axiosRequestArgs);
|
|
1984
|
+
};
|
|
1985
|
+
},
|
|
1986
|
+
/**
|
|
1987
|
+
* to get a single contact by providing the ID of the contact.
|
|
1988
|
+
* @summary Get a single contact
|
|
1989
|
+
* @param {string} id
|
|
1990
|
+
* @param {*} [options] Override http request option.
|
|
1991
|
+
* @throws {RequiredError}
|
|
1992
|
+
*/
|
|
1993
|
+
async getContact(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactFullResponseDTO>>> {
|
|
1994
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getContact(id, options);
|
|
1995
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
1996
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
1997
|
+
return axios.request(axiosRequestArgs);
|
|
1998
|
+
};
|
|
1999
|
+
},
|
|
2000
|
+
/**
|
|
2001
|
+
* to get a single contact list by providing the ID of the contact list.
|
|
2002
|
+
* @summary Get a single contact list
|
|
2003
|
+
* @param {string} id
|
|
2004
|
+
* @param {*} [options] Override http request option.
|
|
2005
|
+
* @throws {RequiredError}
|
|
2006
|
+
*/
|
|
2007
|
+
async getContactList(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactListsResponseDTO>>> {
|
|
2008
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getContactList(id, options);
|
|
2009
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2010
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2011
|
+
return axios.request(axiosRequestArgs);
|
|
2012
|
+
};
|
|
2013
|
+
},
|
|
2014
|
+
/**
|
|
2015
|
+
* to get general details and stats for all drafts, AB Testing objects and/or sent campaigns.
|
|
2016
|
+
* @summary Get general details and stats for all drafts, AB Testing objects and/or sent campaigns
|
|
2017
|
+
* @param {*} [options] Override http request option.
|
|
2018
|
+
* @throws {RequiredError}
|
|
2019
|
+
*/
|
|
2020
|
+
async getGeneralDetailsAndStats(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<GeneralStatsResponseDTO>>> {
|
|
2021
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getGeneralDetailsAndStats(options);
|
|
2022
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2023
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2024
|
+
return axios.request(axiosRequestArgs);
|
|
2025
|
+
};
|
|
2026
|
+
},
|
|
2027
|
+
/**
|
|
2028
|
+
* to get open or click counts, grouped by web browser / email client.
|
|
2029
|
+
* @summary Get open or click counts, grouped by web browser / email client
|
|
2030
|
+
* @param {*} [options] Override http request option.
|
|
2031
|
+
* @throws {RequiredError}
|
|
2032
|
+
*/
|
|
2033
|
+
async getOpenOrClickCountsGroupedByBrowser(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrowserStatsResponseDTO>>> {
|
|
2034
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getOpenOrClickCountsGroupedByBrowser(options);
|
|
2035
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2036
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2037
|
+
return axios.request(axiosRequestArgs);
|
|
2038
|
+
};
|
|
2039
|
+
},
|
|
2040
|
+
/**
|
|
2041
|
+
* to get information about a specific draft, AB Testing object or sent campaign by providing the ID of the campaign
|
|
2042
|
+
* @summary Get information about a specific draft, AB Testing object or sent campaign
|
|
2043
|
+
* @param {string} id
|
|
2044
|
+
* @param {*} [options] Override http request option.
|
|
2045
|
+
* @throws {RequiredError}
|
|
2046
|
+
*/
|
|
2047
|
+
async getSpecificStats(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<GeneralStatsResponseDTO>>> {
|
|
2048
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getSpecificStats(id, options);
|
|
2049
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2050
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2051
|
+
return axios.request(axiosRequestArgs);
|
|
2052
|
+
};
|
|
2053
|
+
},
|
|
2054
|
+
/**
|
|
2055
|
+
* to retrieve statistics, aggregated by recipient's Email Service Provider (ESP).
|
|
2056
|
+
* @summary Retrieve statistics, aggregated by recipient's Email Service Provider (ESP)
|
|
2057
|
+
* @param {string} id
|
|
2058
|
+
* @param {*} [options] Override http request option.
|
|
2059
|
+
* @throws {RequiredError}
|
|
2060
|
+
*/
|
|
2061
|
+
async getStatsAggregatedByRecipientESP(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
|
|
2062
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).getStatsAggregatedByRecipientESP(id, options);
|
|
2063
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2064
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2065
|
+
return axios.request(axiosRequestArgs);
|
|
2066
|
+
};
|
|
2067
|
+
},
|
|
2068
|
+
/**
|
|
2069
|
+
* to remove a contact from a list. The user must provide the ID of the contact and the ID of the list.
|
|
2070
|
+
* @summary Remove a contact from a list
|
|
2071
|
+
* @param {AddContactToListDTO} body
|
|
2072
|
+
* @param {*} [options] Override http request option.
|
|
2073
|
+
* @throws {RequiredError}
|
|
2074
|
+
*/
|
|
2075
|
+
async removeContactFromList(body: AddContactToListDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
|
|
2076
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).removeContactFromList(body, options);
|
|
2077
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2078
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2079
|
+
return axios.request(axiosRequestArgs);
|
|
2080
|
+
};
|
|
2081
|
+
},
|
|
2082
|
+
/**
|
|
2083
|
+
* to retrieve the sending schedule of a campaign draft by providing the ID of the campaign draft.
|
|
2084
|
+
* @summary Retrieve the sending schedule of a campaign draft
|
|
2085
|
+
* @param {string} id
|
|
2086
|
+
* @param {*} [options] Override http request option.
|
|
2087
|
+
* @throws {RequiredError}
|
|
2088
|
+
*/
|
|
2089
|
+
async retrieveSendingScheduleOfCampaignDraft(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignDraftScheduleResponseDTO>>> {
|
|
2090
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).retrieveSendingScheduleOfCampaignDraft(id, options);
|
|
2091
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2092
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2093
|
+
return axios.request(axiosRequestArgs);
|
|
2094
|
+
};
|
|
2095
|
+
},
|
|
2096
|
+
/**
|
|
2097
|
+
* to schedule a campaign draft by providing the ID of the campaign draft and the date of the schedule.
|
|
2098
|
+
* @summary Schedule a campaign draft
|
|
2099
|
+
* @param {ScheduleCampaignDraftDTO} body
|
|
2100
|
+
* @param {string} id
|
|
2101
|
+
* @param {*} [options] Override http request option.
|
|
2102
|
+
* @throws {RequiredError}
|
|
2103
|
+
*/
|
|
2104
|
+
async scheduleCampaignDraft(body: ScheduleCampaignDraftDTO, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignDraftScheduleResponseDTO>>> {
|
|
2105
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).scheduleCampaignDraft(body, id, options);
|
|
2106
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2107
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2108
|
+
return axios.request(axiosRequestArgs);
|
|
2109
|
+
};
|
|
2110
|
+
},
|
|
2111
|
+
/**
|
|
2112
|
+
* to send a campaign draft immediately by providing the ID of the campaign draft.
|
|
2113
|
+
* @summary Send a campaign draft immediately
|
|
2114
|
+
* @param {string} id
|
|
2115
|
+
* @param {*} [options] Override http request option.
|
|
2116
|
+
* @throws {RequiredError}
|
|
2117
|
+
*/
|
|
2118
|
+
async sendCampaignDraftImmediately(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignDraftSendingResponseDTO>>> {
|
|
2119
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).sendCampaignDraftImmediately(id, options);
|
|
2120
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2121
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2122
|
+
return axios.request(axiosRequestArgs);
|
|
2123
|
+
};
|
|
2124
|
+
},
|
|
2125
|
+
/**
|
|
2126
|
+
* to send a test email for a specified campaign draft by providing the ID of the campaign draft and the recipients of the test email.
|
|
2127
|
+
* @summary Send a test email for a specified campaign draft
|
|
2128
|
+
* @param {SendTestEmailDTO} body
|
|
2129
|
+
* @param {string} id
|
|
2130
|
+
* @param {*} [options] Override http request option.
|
|
2131
|
+
* @throws {RequiredError}
|
|
2132
|
+
*/
|
|
2133
|
+
async sendTestEmail(body: SendTestEmailDTO, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignDraftSendingResponseDTO>>> {
|
|
2134
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).sendTestEmail(body, id, options);
|
|
2135
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2136
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2137
|
+
return axios.request(axiosRequestArgs);
|
|
2138
|
+
};
|
|
2139
|
+
},
|
|
2140
|
+
/**
|
|
2141
|
+
* to update a campaign draft. The user can change the title, subject, contactsListId, senderEmail, senderName, senderId and locale of the campaign draft.
|
|
2142
|
+
* @summary Update a campaign draft
|
|
2143
|
+
* @param {UpdateMarketingCampDraftDto} body
|
|
2144
|
+
* @param {string} id
|
|
2145
|
+
* @param {*} [options] Override http request option.
|
|
2146
|
+
* @throws {RequiredError}
|
|
2147
|
+
*/
|
|
2148
|
+
async updateCampaignDraft(body: UpdateMarketingCampDraftDto, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignDraftResponseDTO>>> {
|
|
2149
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).updateCampaignDraft(body, id, options);
|
|
2150
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2151
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2152
|
+
return axios.request(axiosRequestArgs);
|
|
2153
|
+
};
|
|
2154
|
+
},
|
|
2155
|
+
/**
|
|
2156
|
+
* to update the content of a campaign draft. The user must provide the ID of the campaign draft and the html content.
|
|
2157
|
+
* @summary Update the content of a campaign draft
|
|
2158
|
+
* @param {UpdateCampaignDraftContentDto} body
|
|
2159
|
+
* @param {string} id
|
|
2160
|
+
* @param {*} [options] Override http request option.
|
|
2161
|
+
* @throws {RequiredError}
|
|
2162
|
+
*/
|
|
2163
|
+
async updateCampaignDraftContent(body: UpdateCampaignDraftContentDto, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignContentResponseDTO>>> {
|
|
2164
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).updateCampaignDraftContent(body, id, options);
|
|
2165
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2166
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2167
|
+
return axios.request(axiosRequestArgs);
|
|
2168
|
+
};
|
|
2169
|
+
},
|
|
2170
|
+
/**
|
|
2171
|
+
* to update a contact. The user can exclude the contact from campaigns by setting the isExcludedFromCampaigns parameter to true.
|
|
2172
|
+
* @summary Update a contact
|
|
2173
|
+
* @param {string} id
|
|
2174
|
+
* @param {boolean} isExcludedFromCampaigns
|
|
2175
|
+
* @param {*} [options] Override http request option.
|
|
2176
|
+
* @throws {RequiredError}
|
|
2177
|
+
*/
|
|
2178
|
+
async updateContact(id: string, isExcludedFromCampaigns: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactFullResponseDTO>>> {
|
|
2179
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).updateContact(id, isExcludedFromCampaigns, options);
|
|
2180
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2181
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2182
|
+
return axios.request(axiosRequestArgs);
|
|
2183
|
+
};
|
|
2184
|
+
},
|
|
2185
|
+
/**
|
|
2186
|
+
* to update a contact list. The user can change the name of the contact list.
|
|
2187
|
+
* @summary Update a contact list
|
|
2188
|
+
* @param {CreateContactListDTO} body
|
|
2189
|
+
* @param {string} id
|
|
2190
|
+
* @param {*} [options] Override http request option.
|
|
2191
|
+
* @throws {RequiredError}
|
|
2192
|
+
*/
|
|
2193
|
+
async updateContactList(body: CreateContactListDTO, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ContactListsResponseDTO>>> {
|
|
2194
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).updateContactList(body, id, options);
|
|
2195
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2196
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2197
|
+
return axios.request(axiosRequestArgs);
|
|
2198
|
+
};
|
|
2199
|
+
},
|
|
2200
|
+
/**
|
|
2201
|
+
* to update an existing email template. The user must provide the ID of the email template and the name, html content, text content, subject and description.
|
|
2202
|
+
* @summary Update an existing email template
|
|
2203
|
+
* @param {CreateEmailTemplateDTO} body
|
|
2204
|
+
* @param {string} id
|
|
2205
|
+
* @param {*} [options] Override http request option.
|
|
2206
|
+
* @throws {RequiredError}
|
|
2207
|
+
*/
|
|
2208
|
+
async updateEmailTemplate(body: CreateEmailTemplateDTO, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<EmailTemplateResponseDTO>>>> {
|
|
2209
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).updateEmailTemplate(body, id, options);
|
|
2210
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2211
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2212
|
+
return axios.request(axiosRequestArgs);
|
|
2213
|
+
};
|
|
2214
|
+
},
|
|
2215
|
+
/**
|
|
2216
|
+
* to update the sending schedule of a campaign draft by providing the ID of the campaign draft and the date of the schedule.
|
|
2217
|
+
* @summary Update the sending schedule of a campaign draft
|
|
2218
|
+
* @param {ScheduleCampaignDraftDTO} body
|
|
2219
|
+
* @param {string} id
|
|
2220
|
+
* @param {*} [options] Override http request option.
|
|
2221
|
+
* @throws {RequiredError}
|
|
2222
|
+
*/
|
|
2223
|
+
async updateSendingScheduleOfCampaignDraft(body: ScheduleCampaignDraftDTO, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
|
|
2224
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).updateSendingScheduleOfCampaignDraft(body, id, options);
|
|
2225
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2226
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2227
|
+
return axios.request(axiosRequestArgs);
|
|
2228
|
+
};
|
|
2229
|
+
},
|
|
2230
|
+
/**
|
|
2231
|
+
* to view the sending status of a campaign draft by providing the ID of the campaign draft.
|
|
2232
|
+
* @summary View the sending status of a campaign draft
|
|
2233
|
+
* @param {string} id
|
|
2234
|
+
* @param {*} [options] Override http request option.
|
|
2235
|
+
* @throws {RequiredError}
|
|
2236
|
+
*/
|
|
2237
|
+
async viewSendingStatusOfCampaignDraft(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CampaignDraftSendingResponseDTO>>> {
|
|
2238
|
+
const localVarAxiosArgs = await MarketingApiAxiosParamCreator(configuration).viewSendingStatusOfCampaignDraft(id, options);
|
|
2239
|
+
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
|
|
2240
|
+
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
|
|
2241
|
+
return axios.request(axiosRequestArgs);
|
|
2242
|
+
};
|
|
2243
|
+
},
|
|
2244
|
+
}
|
|
2245
|
+
};
|
|
2246
|
+
|
|
2247
|
+
/**
|
|
2248
|
+
* MarketingApi - factory interface
|
|
2249
|
+
* @export
|
|
2250
|
+
*/
|
|
2251
|
+
export const MarketingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
2252
|
+
return {
|
|
2253
|
+
/**
|
|
2254
|
+
* to add a contact to a list. The user must provide the ID of the contact and the ID of the list.
|
|
2255
|
+
* @summary Add a contact to a list
|
|
2256
|
+
* @param {AddContactToListDTO} body
|
|
2257
|
+
* @param {*} [options] Override http request option.
|
|
2258
|
+
* @throws {RequiredError}
|
|
2259
|
+
*/
|
|
2260
|
+
async addContactToList(body: AddContactToListDTO, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
|
|
2261
|
+
return MarketingApiFp(configuration).addContactToList(body, options).then((request) => request(axios, basePath));
|
|
2262
|
+
},
|
|
2263
|
+
/**
|
|
2264
|
+
* to cancel the scheduled sending of a campaign draft by providing the ID of the campaign draft.
|
|
2265
|
+
* @summary Cancel the scheduled sending of a campaign draft
|
|
2266
|
+
* @param {string} id
|
|
2267
|
+
* @param {*} [options] Override http request option.
|
|
2268
|
+
* @throws {RequiredError}
|
|
2269
|
+
*/
|
|
2270
|
+
async cancelScheduledSendingOfCampaignDraft(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
|
|
2271
|
+
return MarketingApiFp(configuration).cancelScheduledSendingOfCampaignDraft(id, options).then((request) => request(axios, basePath));
|
|
2272
|
+
},
|
|
2273
|
+
/**
|
|
2274
|
+
* to create a new campaign draft. The user must provide a title, subject, contactsListId, senderEmail, senderName, senderId and locale.
|
|
2275
|
+
* @summary Create a new campaign draft
|
|
2276
|
+
* @param {CreateMarketingCampaignDTO} body
|
|
2277
|
+
* @param {*} [options] Override http request option.
|
|
2278
|
+
* @throws {RequiredError}
|
|
2279
|
+
*/
|
|
2280
|
+
async createCampaignDraft(body: CreateMarketingCampaignDTO, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignDraftResponseDTO>> {
|
|
2281
|
+
return MarketingApiFp(configuration).createCampaignDraft(body, options).then((request) => request(axios, basePath));
|
|
2282
|
+
},
|
|
2283
|
+
/**
|
|
2284
|
+
* to create a new contact. The user must provide a name, email and isExcludedFromCampaigns parameter.
|
|
2285
|
+
* @summary Create a new contact
|
|
2286
|
+
* @param {CreateContactDTO} body
|
|
2287
|
+
* @param {*} [options] Override http request option.
|
|
2288
|
+
* @throws {RequiredError}
|
|
2289
|
+
*/
|
|
2290
|
+
async createContact(body: CreateContactDTO, options?: AxiosRequestConfig): Promise<AxiosResponse<ContactFullResponseDTO>> {
|
|
2291
|
+
return MarketingApiFp(configuration).createContact(body, options).then((request) => request(axios, basePath));
|
|
2292
|
+
},
|
|
2293
|
+
/**
|
|
2294
|
+
* to create a new contact list. The user must provide a name for the contact list.
|
|
2295
|
+
* @summary Create a new contact list
|
|
2296
|
+
* @param {CreateContactListDTO} body
|
|
2297
|
+
* @param {*} [options] Override http request option.
|
|
2298
|
+
* @throws {RequiredError}
|
|
2299
|
+
*/
|
|
2300
|
+
async createContactList(body: CreateContactListDTO, options?: AxiosRequestConfig): Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
2301
|
+
return MarketingApiFp(configuration).createContactList(body, options).then((request) => request(axios, basePath));
|
|
2302
|
+
},
|
|
2303
|
+
/**
|
|
2304
|
+
* to create a new email template. The user must provide a name, html content, text content, subject and description.
|
|
2305
|
+
* @summary Create a new email template
|
|
2306
|
+
* @param {CreateEmailTemplateDTO} body
|
|
2307
|
+
* @param {*} [options] Override http request option.
|
|
2308
|
+
* @throws {RequiredError}
|
|
2309
|
+
*/
|
|
2310
|
+
async createEmailTemplate(body: CreateEmailTemplateDTO, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<EmailTemplateResponseDTO>>> {
|
|
2311
|
+
return MarketingApiFp(configuration).createEmailTemplate(body, options).then((request) => request(axios, basePath));
|
|
2312
|
+
},
|
|
2313
|
+
/**
|
|
2314
|
+
* to delete a contact list by providing the ID of the contact list.
|
|
2315
|
+
* @summary Delete a contact list
|
|
2316
|
+
* @param {string} id
|
|
2317
|
+
* @param {*} [options] Override http request option.
|
|
2318
|
+
* @throws {RequiredError}
|
|
2319
|
+
*/
|
|
2320
|
+
async deleteContactList(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
|
|
2321
|
+
return MarketingApiFp(configuration).deleteContactList(id, options).then((request) => request(axios, basePath));
|
|
2322
|
+
},
|
|
2323
|
+
/**
|
|
2324
|
+
* to delete an existing email template. The user must provide the ID of the email template.
|
|
2325
|
+
* @summary Delete an existing email template
|
|
2326
|
+
* @param {string} id
|
|
2327
|
+
* @param {*} [options] Override http request option.
|
|
2328
|
+
* @throws {RequiredError}
|
|
2329
|
+
*/
|
|
2330
|
+
async deleteEmailTemplate(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
|
|
2331
|
+
return MarketingApiFp(configuration).deleteEmailTemplate(id, options).then((request) => request(axios, basePath));
|
|
2332
|
+
},
|
|
2333
|
+
/**
|
|
2334
|
+
* to retrieve aggregated open and click statistics, grouped by recipient country.
|
|
2335
|
+
* @summary ***** Retrieve aggregated open and click statistics, grouped by recipient country
|
|
2336
|
+
* @param {*} [options] Override http request option.
|
|
2337
|
+
* @throws {RequiredError}
|
|
2338
|
+
*/
|
|
2339
|
+
async getAggregatedOpenAndClickStatsGroupedByCountry(options?: AxiosRequestConfig): Promise<AxiosResponse<CountryStatsResponseDTO>> {
|
|
2340
|
+
return MarketingApiFp(configuration).getAggregatedOpenAndClickStatsGroupedByCountry(options).then((request) => request(axios, basePath));
|
|
2341
|
+
},
|
|
2342
|
+
/**
|
|
2343
|
+
* to get aggregated statistics for all clicked links.
|
|
2344
|
+
* @summary Get aggregated statistics for all clicked links
|
|
2345
|
+
* @param {*} [options] Override http request option.
|
|
2346
|
+
* @throws {RequiredError}
|
|
2347
|
+
*/
|
|
2348
|
+
async getAggregatedStatsForAllClickedLinks(options?: AxiosRequestConfig): Promise<AxiosResponse<LinkStatsResponseDTO>> {
|
|
2349
|
+
return MarketingApiFp(configuration).getAggregatedStatsForAllClickedLinks(options).then((request) => request(axios, basePath));
|
|
2350
|
+
},
|
|
2351
|
+
/**
|
|
2352
|
+
* to get aggregated statistics for all clicked links in a campaign by providing the ID of the campaign.
|
|
2353
|
+
* @summary Get aggregated statistics for all clicked links in a campaign
|
|
2354
|
+
* @param {string} id
|
|
2355
|
+
* @param {*} [options] Override http request option.
|
|
2356
|
+
* @throws {RequiredError}
|
|
2357
|
+
*/
|
|
2358
|
+
async getAggregatedStatsForAllClickedLinksInCampaign(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
|
|
2359
|
+
return MarketingApiFp(configuration).getAggregatedStatsForAllClickedLinksInCampaign(id, options).then((request) => request(axios, basePath));
|
|
2360
|
+
},
|
|
2361
|
+
/**
|
|
2362
|
+
* to get aggregated statistics for a specific contact by providing the ID of the contact.
|
|
2363
|
+
* @summary Get aggregated statistics for a specific contact
|
|
2364
|
+
* @param {string} id
|
|
2365
|
+
* @param {*} [options] Override http request option.
|
|
2366
|
+
* @throws {RequiredError}
|
|
2367
|
+
*/
|
|
2368
|
+
async getAggregatedStatsForSpecificContact(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ContactAggregatedStatsResponseDTO>> {
|
|
2369
|
+
return MarketingApiFp(configuration).getAggregatedStatsForSpecificContact(id, options).then((request) => request(axios, basePath));
|
|
2370
|
+
},
|
|
2371
|
+
/**
|
|
2372
|
+
* to get aggregated statistics for a specific list recipient by providing the ID of the list recipient.
|
|
2373
|
+
* @summary Get aggregated statistics for a specific list recipient
|
|
2374
|
+
* @param {string} id
|
|
2375
|
+
* @param {*} [options] Override http request option.
|
|
2376
|
+
* @throws {RequiredError}
|
|
2377
|
+
*/
|
|
2378
|
+
async getAggregatedStatsForSpecificListRecipient(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ContactListStatsResponseDTO>> {
|
|
2379
|
+
return MarketingApiFp(configuration).getAggregatedStatsForSpecificListRecipient(id, options).then((request) => request(axios, basePath));
|
|
2380
|
+
},
|
|
2381
|
+
/**
|
|
2382
|
+
* to get aggregated statistics, grouped by contact.
|
|
2383
|
+
* @summary Get aggregated statistics, grouped by contact
|
|
2384
|
+
* @param {*} [options] Override http request option.
|
|
2385
|
+
* @throws {RequiredError}
|
|
2386
|
+
*/
|
|
2387
|
+
async getAggregatedStatsGroupedByContact(options?: AxiosRequestConfig): Promise<AxiosResponse<ContactAggregatedStatsResponseDTO>> {
|
|
2388
|
+
return MarketingApiFp(configuration).getAggregatedStatsGroupedByContact(options).then((request) => request(axios, basePath));
|
|
2389
|
+
},
|
|
2390
|
+
/**
|
|
2391
|
+
* to get aggregated statistics, grouped by list recipient.
|
|
2392
|
+
* @summary Get aggregated statistics, grouped by list recipient
|
|
2393
|
+
* @param {*} [options] Override http request option.
|
|
2394
|
+
* @throws {RequiredError}
|
|
2395
|
+
*/
|
|
2396
|
+
async getAggregatedStatsGroupedByListRecipient(options?: AxiosRequestConfig): Promise<AxiosResponse<ContactListStatsResponseDTO>> {
|
|
2397
|
+
return MarketingApiFp(configuration).getAggregatedStatsGroupedByListRecipient(options).then((request) => request(axios, basePath));
|
|
2398
|
+
},
|
|
2399
|
+
/**
|
|
2400
|
+
* to get all campaign drafts that have been created by the user.
|
|
2401
|
+
* @summary Get all campaign drafts
|
|
2402
|
+
* @param {*} [options] Override http request option.
|
|
2403
|
+
* @throws {RequiredError}
|
|
2404
|
+
*/
|
|
2405
|
+
async getAllCampaignDrafts(options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignDraftResponseDTO>> {
|
|
2406
|
+
return MarketingApiFp(configuration).getAllCampaignDrafts(options).then((request) => request(axios, basePath));
|
|
2407
|
+
},
|
|
2408
|
+
/**
|
|
2409
|
+
* to get all contact lists that have been created by the user.
|
|
2410
|
+
* @summary Get all contact lists
|
|
2411
|
+
* @param {*} [options] Override http request option.
|
|
2412
|
+
* @throws {RequiredError}
|
|
2413
|
+
*/
|
|
2414
|
+
async getAllContactLists(options?: AxiosRequestConfig): Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
2415
|
+
return MarketingApiFp(configuration).getAllContactLists(options).then((request) => request(axios, basePath));
|
|
2416
|
+
},
|
|
2417
|
+
/**
|
|
2418
|
+
* to get all contact lists for a specific contact by providing the ID of the contact.
|
|
2419
|
+
* @summary Get all contact lists for a specific contact
|
|
2420
|
+
* @param {string} id
|
|
2421
|
+
* @param {*} [options] Override http request option.
|
|
2422
|
+
* @throws {RequiredError}
|
|
2423
|
+
*/
|
|
2424
|
+
async getAllContactListsForContact(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
2425
|
+
return MarketingApiFp(configuration).getAllContactListsForContact(id, options).then((request) => request(axios, basePath));
|
|
2426
|
+
},
|
|
2427
|
+
/**
|
|
2428
|
+
* to get all contacts that have been created by the user.
|
|
2429
|
+
* @summary Get all contacts
|
|
2430
|
+
* @param {*} [options] Override http request option.
|
|
2431
|
+
* @throws {RequiredError}
|
|
2432
|
+
*/
|
|
2433
|
+
async getAllContacts(options?: AxiosRequestConfig): Promise<AxiosResponse<ContactFullResponseDTO>> {
|
|
2434
|
+
return MarketingApiFp(configuration).getAllContacts(options).then((request) => request(axios, basePath));
|
|
2435
|
+
},
|
|
2436
|
+
/**
|
|
2437
|
+
* to get all email templates that have been created by the user.
|
|
2438
|
+
* @summary Get all email templates
|
|
2439
|
+
* @param {*} [options] Override http request option.
|
|
2440
|
+
* @throws {RequiredError}
|
|
2441
|
+
*/
|
|
2442
|
+
async getAllEmailTemplates(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<EmailTemplateResponseDTO>>> {
|
|
2443
|
+
return MarketingApiFp(configuration).getAllEmailTemplates(options).then((request) => request(axios, basePath));
|
|
2444
|
+
},
|
|
2445
|
+
/**
|
|
2446
|
+
* to get a single campaign draft by providing the ID of the campaign draft.
|
|
2447
|
+
* @summary Get a single campaign draft
|
|
2448
|
+
* @param {string} id
|
|
2449
|
+
* @param {*} [options] Override http request option.
|
|
2450
|
+
* @throws {RequiredError}
|
|
2451
|
+
*/
|
|
2452
|
+
async getCampaignDraft(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignDraftResponseDTO>> {
|
|
2453
|
+
return MarketingApiFp(configuration).getCampaignDraft(id, options).then((request) => request(axios, basePath));
|
|
2454
|
+
},
|
|
2455
|
+
/**
|
|
2456
|
+
* to retrieve the content of a campaign draft email by providing the ID of the campaign draft.
|
|
2457
|
+
* @summary Retrieve the content of a campaign draft email
|
|
2458
|
+
* @param {string} id
|
|
2459
|
+
* @param {*} [options] Override http request option.
|
|
2460
|
+
* @throws {RequiredError}
|
|
2461
|
+
*/
|
|
2462
|
+
async getCampaignDraftContent(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignContentResponseDTO>> {
|
|
2463
|
+
return MarketingApiFp(configuration).getCampaignDraftContent(id, options).then((request) => request(axios, basePath));
|
|
2464
|
+
},
|
|
2465
|
+
/**
|
|
2466
|
+
* to get a single contact by providing the ID of the contact.
|
|
2467
|
+
* @summary Get a single contact
|
|
2468
|
+
* @param {string} id
|
|
2469
|
+
* @param {*} [options] Override http request option.
|
|
2470
|
+
* @throws {RequiredError}
|
|
2471
|
+
*/
|
|
2472
|
+
async getContact(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ContactFullResponseDTO>> {
|
|
2473
|
+
return MarketingApiFp(configuration).getContact(id, options).then((request) => request(axios, basePath));
|
|
2474
|
+
},
|
|
2475
|
+
/**
|
|
2476
|
+
* to get a single contact list by providing the ID of the contact list.
|
|
2477
|
+
* @summary Get a single contact list
|
|
2478
|
+
* @param {string} id
|
|
2479
|
+
* @param {*} [options] Override http request option.
|
|
2480
|
+
* @throws {RequiredError}
|
|
2481
|
+
*/
|
|
2482
|
+
async getContactList(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
2483
|
+
return MarketingApiFp(configuration).getContactList(id, options).then((request) => request(axios, basePath));
|
|
2484
|
+
},
|
|
2485
|
+
/**
|
|
2486
|
+
* to get general details and stats for all drafts, AB Testing objects and/or sent campaigns.
|
|
2487
|
+
* @summary Get general details and stats for all drafts, AB Testing objects and/or sent campaigns
|
|
2488
|
+
* @param {*} [options] Override http request option.
|
|
2489
|
+
* @throws {RequiredError}
|
|
2490
|
+
*/
|
|
2491
|
+
async getGeneralDetailsAndStats(options?: AxiosRequestConfig): Promise<AxiosResponse<GeneralStatsResponseDTO>> {
|
|
2492
|
+
return MarketingApiFp(configuration).getGeneralDetailsAndStats(options).then((request) => request(axios, basePath));
|
|
2493
|
+
},
|
|
2494
|
+
/**
|
|
2495
|
+
* to get open or click counts, grouped by web browser / email client.
|
|
2496
|
+
* @summary Get open or click counts, grouped by web browser / email client
|
|
2497
|
+
* @param {*} [options] Override http request option.
|
|
2498
|
+
* @throws {RequiredError}
|
|
2499
|
+
*/
|
|
2500
|
+
async getOpenOrClickCountsGroupedByBrowser(options?: AxiosRequestConfig): Promise<AxiosResponse<BrowserStatsResponseDTO>> {
|
|
2501
|
+
return MarketingApiFp(configuration).getOpenOrClickCountsGroupedByBrowser(options).then((request) => request(axios, basePath));
|
|
2502
|
+
},
|
|
2503
|
+
/**
|
|
2504
|
+
* to get information about a specific draft, AB Testing object or sent campaign by providing the ID of the campaign
|
|
2505
|
+
* @summary Get information about a specific draft, AB Testing object or sent campaign
|
|
2506
|
+
* @param {string} id
|
|
2507
|
+
* @param {*} [options] Override http request option.
|
|
2508
|
+
* @throws {RequiredError}
|
|
2509
|
+
*/
|
|
2510
|
+
async getSpecificStats(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<GeneralStatsResponseDTO>> {
|
|
2511
|
+
return MarketingApiFp(configuration).getSpecificStats(id, options).then((request) => request(axios, basePath));
|
|
2512
|
+
},
|
|
2513
|
+
/**
|
|
2514
|
+
* to retrieve statistics, aggregated by recipient's Email Service Provider (ESP).
|
|
2515
|
+
* @summary Retrieve statistics, aggregated by recipient's Email Service Provider (ESP)
|
|
2516
|
+
* @param {string} id
|
|
2517
|
+
* @param {*} [options] Override http request option.
|
|
2518
|
+
* @throws {RequiredError}
|
|
2519
|
+
*/
|
|
2520
|
+
async getStatsAggregatedByRecipientESP(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
|
|
2521
|
+
return MarketingApiFp(configuration).getStatsAggregatedByRecipientESP(id, options).then((request) => request(axios, basePath));
|
|
2522
|
+
},
|
|
2523
|
+
/**
|
|
2524
|
+
* to remove a contact from a list. The user must provide the ID of the contact and the ID of the list.
|
|
2525
|
+
* @summary Remove a contact from a list
|
|
2526
|
+
* @param {AddContactToListDTO} body
|
|
2527
|
+
* @param {*} [options] Override http request option.
|
|
2528
|
+
* @throws {RequiredError}
|
|
2529
|
+
*/
|
|
2530
|
+
async removeContactFromList(body: AddContactToListDTO, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
|
|
2531
|
+
return MarketingApiFp(configuration).removeContactFromList(body, options).then((request) => request(axios, basePath));
|
|
2532
|
+
},
|
|
2533
|
+
/**
|
|
2534
|
+
* to retrieve the sending schedule of a campaign draft by providing the ID of the campaign draft.
|
|
2535
|
+
* @summary Retrieve the sending schedule of a campaign draft
|
|
2536
|
+
* @param {string} id
|
|
2537
|
+
* @param {*} [options] Override http request option.
|
|
2538
|
+
* @throws {RequiredError}
|
|
2539
|
+
*/
|
|
2540
|
+
async retrieveSendingScheduleOfCampaignDraft(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignDraftScheduleResponseDTO>> {
|
|
2541
|
+
return MarketingApiFp(configuration).retrieveSendingScheduleOfCampaignDraft(id, options).then((request) => request(axios, basePath));
|
|
2542
|
+
},
|
|
2543
|
+
/**
|
|
2544
|
+
* to schedule a campaign draft by providing the ID of the campaign draft and the date of the schedule.
|
|
2545
|
+
* @summary Schedule a campaign draft
|
|
2546
|
+
* @param {ScheduleCampaignDraftDTO} body
|
|
2547
|
+
* @param {string} id
|
|
2548
|
+
* @param {*} [options] Override http request option.
|
|
2549
|
+
* @throws {RequiredError}
|
|
2550
|
+
*/
|
|
2551
|
+
async scheduleCampaignDraft(body: ScheduleCampaignDraftDTO, id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignDraftScheduleResponseDTO>> {
|
|
2552
|
+
return MarketingApiFp(configuration).scheduleCampaignDraft(body, id, options).then((request) => request(axios, basePath));
|
|
2553
|
+
},
|
|
2554
|
+
/**
|
|
2555
|
+
* to send a campaign draft immediately by providing the ID of the campaign draft.
|
|
2556
|
+
* @summary Send a campaign draft immediately
|
|
2557
|
+
* @param {string} id
|
|
2558
|
+
* @param {*} [options] Override http request option.
|
|
2559
|
+
* @throws {RequiredError}
|
|
2560
|
+
*/
|
|
2561
|
+
async sendCampaignDraftImmediately(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignDraftSendingResponseDTO>> {
|
|
2562
|
+
return MarketingApiFp(configuration).sendCampaignDraftImmediately(id, options).then((request) => request(axios, basePath));
|
|
2563
|
+
},
|
|
2564
|
+
/**
|
|
2565
|
+
* to send a test email for a specified campaign draft by providing the ID of the campaign draft and the recipients of the test email.
|
|
2566
|
+
* @summary Send a test email for a specified campaign draft
|
|
2567
|
+
* @param {SendTestEmailDTO} body
|
|
2568
|
+
* @param {string} id
|
|
2569
|
+
* @param {*} [options] Override http request option.
|
|
2570
|
+
* @throws {RequiredError}
|
|
2571
|
+
*/
|
|
2572
|
+
async sendTestEmail(body: SendTestEmailDTO, id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignDraftSendingResponseDTO>> {
|
|
2573
|
+
return MarketingApiFp(configuration).sendTestEmail(body, id, options).then((request) => request(axios, basePath));
|
|
2574
|
+
},
|
|
2575
|
+
/**
|
|
2576
|
+
* to update a campaign draft. The user can change the title, subject, contactsListId, senderEmail, senderName, senderId and locale of the campaign draft.
|
|
2577
|
+
* @summary Update a campaign draft
|
|
2578
|
+
* @param {UpdateMarketingCampDraftDto} body
|
|
2579
|
+
* @param {string} id
|
|
2580
|
+
* @param {*} [options] Override http request option.
|
|
2581
|
+
* @throws {RequiredError}
|
|
2582
|
+
*/
|
|
2583
|
+
async updateCampaignDraft(body: UpdateMarketingCampDraftDto, id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignDraftResponseDTO>> {
|
|
2584
|
+
return MarketingApiFp(configuration).updateCampaignDraft(body, id, options).then((request) => request(axios, basePath));
|
|
2585
|
+
},
|
|
2586
|
+
/**
|
|
2587
|
+
* to update the content of a campaign draft. The user must provide the ID of the campaign draft and the html content.
|
|
2588
|
+
* @summary Update the content of a campaign draft
|
|
2589
|
+
* @param {UpdateCampaignDraftContentDto} body
|
|
2590
|
+
* @param {string} id
|
|
2591
|
+
* @param {*} [options] Override http request option.
|
|
2592
|
+
* @throws {RequiredError}
|
|
2593
|
+
*/
|
|
2594
|
+
async updateCampaignDraftContent(body: UpdateCampaignDraftContentDto, id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignContentResponseDTO>> {
|
|
2595
|
+
return MarketingApiFp(configuration).updateCampaignDraftContent(body, id, options).then((request) => request(axios, basePath));
|
|
2596
|
+
},
|
|
2597
|
+
/**
|
|
2598
|
+
* to update a contact. The user can exclude the contact from campaigns by setting the isExcludedFromCampaigns parameter to true.
|
|
2599
|
+
* @summary Update a contact
|
|
2600
|
+
* @param {string} id
|
|
2601
|
+
* @param {boolean} isExcludedFromCampaigns
|
|
2602
|
+
* @param {*} [options] Override http request option.
|
|
2603
|
+
* @throws {RequiredError}
|
|
2604
|
+
*/
|
|
2605
|
+
async updateContact(id: string, isExcludedFromCampaigns: boolean, options?: AxiosRequestConfig): Promise<AxiosResponse<ContactFullResponseDTO>> {
|
|
2606
|
+
return MarketingApiFp(configuration).updateContact(id, isExcludedFromCampaigns, options).then((request) => request(axios, basePath));
|
|
2607
|
+
},
|
|
2608
|
+
/**
|
|
2609
|
+
* to update a contact list. The user can change the name of the contact list.
|
|
2610
|
+
* @summary Update a contact list
|
|
2611
|
+
* @param {CreateContactListDTO} body
|
|
2612
|
+
* @param {string} id
|
|
2613
|
+
* @param {*} [options] Override http request option.
|
|
2614
|
+
* @throws {RequiredError}
|
|
2615
|
+
*/
|
|
2616
|
+
async updateContactList(body: CreateContactListDTO, id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
2617
|
+
return MarketingApiFp(configuration).updateContactList(body, id, options).then((request) => request(axios, basePath));
|
|
2618
|
+
},
|
|
2619
|
+
/**
|
|
2620
|
+
* to update an existing email template. The user must provide the ID of the email template and the name, html content, text content, subject and description.
|
|
2621
|
+
* @summary Update an existing email template
|
|
2622
|
+
* @param {CreateEmailTemplateDTO} body
|
|
2623
|
+
* @param {string} id
|
|
2624
|
+
* @param {*} [options] Override http request option.
|
|
2625
|
+
* @throws {RequiredError}
|
|
2626
|
+
*/
|
|
2627
|
+
async updateEmailTemplate(body: CreateEmailTemplateDTO, id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<EmailTemplateResponseDTO>>> {
|
|
2628
|
+
return MarketingApiFp(configuration).updateEmailTemplate(body, id, options).then((request) => request(axios, basePath));
|
|
2629
|
+
},
|
|
2630
|
+
/**
|
|
2631
|
+
* to update the sending schedule of a campaign draft by providing the ID of the campaign draft and the date of the schedule.
|
|
2632
|
+
* @summary Update the sending schedule of a campaign draft
|
|
2633
|
+
* @param {ScheduleCampaignDraftDTO} body
|
|
2634
|
+
* @param {string} id
|
|
2635
|
+
* @param {*} [options] Override http request option.
|
|
2636
|
+
* @throws {RequiredError}
|
|
2637
|
+
*/
|
|
2638
|
+
async updateSendingScheduleOfCampaignDraft(body: ScheduleCampaignDraftDTO, id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
|
|
2639
|
+
return MarketingApiFp(configuration).updateSendingScheduleOfCampaignDraft(body, id, options).then((request) => request(axios, basePath));
|
|
2640
|
+
},
|
|
2641
|
+
/**
|
|
2642
|
+
* to view the sending status of a campaign draft by providing the ID of the campaign draft.
|
|
2643
|
+
* @summary View the sending status of a campaign draft
|
|
2644
|
+
* @param {string} id
|
|
2645
|
+
* @param {*} [options] Override http request option.
|
|
2646
|
+
* @throws {RequiredError}
|
|
2647
|
+
*/
|
|
2648
|
+
async viewSendingStatusOfCampaignDraft(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CampaignDraftSendingResponseDTO>> {
|
|
2649
|
+
return MarketingApiFp(configuration).viewSendingStatusOfCampaignDraft(id, options).then((request) => request(axios, basePath));
|
|
2650
|
+
},
|
|
2651
|
+
};
|
|
2652
|
+
};
|
|
2653
|
+
|
|
2654
|
+
/**
|
|
2655
|
+
* MarketingApi - object-oriented interface
|
|
2656
|
+
* @export
|
|
2657
|
+
* @class MarketingApi
|
|
2658
|
+
* @extends {BaseAPI}
|
|
2659
|
+
*/
|
|
2660
|
+
export class MarketingApi extends BaseAPI {
|
|
2661
|
+
/**
|
|
2662
|
+
* to add a contact to a list. The user must provide the ID of the contact and the ID of the list.
|
|
2663
|
+
* @summary Add a contact to a list
|
|
2664
|
+
* @param {AddContactToListDTO} body
|
|
2665
|
+
* @param {*} [options] Override http request option.
|
|
2666
|
+
* @throws {RequiredError}
|
|
2667
|
+
* @memberof MarketingApi
|
|
2668
|
+
*/
|
|
2669
|
+
public async addContactToList(body: AddContactToListDTO, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
|
|
2670
|
+
return MarketingApiFp(this.configuration).addContactToList(body, options).then((request) => request(this.axios, this.basePath));
|
|
2671
|
+
}
|
|
2672
|
+
/**
|
|
2673
|
+
* to cancel the scheduled sending of a campaign draft by providing the ID of the campaign draft.
|
|
2674
|
+
* @summary Cancel the scheduled sending of a campaign draft
|
|
2675
|
+
* @param {string} id
|
|
2676
|
+
* @param {*} [options] Override http request option.
|
|
2677
|
+
* @throws {RequiredError}
|
|
2678
|
+
* @memberof MarketingApi
|
|
2679
|
+
*/
|
|
2680
|
+
public async cancelScheduledSendingOfCampaignDraft(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
|
|
2681
|
+
return MarketingApiFp(this.configuration).cancelScheduledSendingOfCampaignDraft(id, options).then((request) => request(this.axios, this.basePath));
|
|
2682
|
+
}
|
|
2683
|
+
/**
|
|
2684
|
+
* to create a new campaign draft. The user must provide a title, subject, contactsListId, senderEmail, senderName, senderId and locale.
|
|
2685
|
+
* @summary Create a new campaign draft
|
|
2686
|
+
* @param {CreateMarketingCampaignDTO} body
|
|
2687
|
+
* @param {*} [options] Override http request option.
|
|
2688
|
+
* @throws {RequiredError}
|
|
2689
|
+
* @memberof MarketingApi
|
|
2690
|
+
*/
|
|
2691
|
+
public async createCampaignDraft(body: CreateMarketingCampaignDTO, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignDraftResponseDTO>> {
|
|
2692
|
+
return MarketingApiFp(this.configuration).createCampaignDraft(body, options).then((request) => request(this.axios, this.basePath));
|
|
2693
|
+
}
|
|
2694
|
+
/**
|
|
2695
|
+
* to create a new contact. The user must provide a name, email and isExcludedFromCampaigns parameter.
|
|
2696
|
+
* @summary Create a new contact
|
|
2697
|
+
* @param {CreateContactDTO} body
|
|
2698
|
+
* @param {*} [options] Override http request option.
|
|
2699
|
+
* @throws {RequiredError}
|
|
2700
|
+
* @memberof MarketingApi
|
|
2701
|
+
*/
|
|
2702
|
+
public async createContact(body: CreateContactDTO, options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactFullResponseDTO>> {
|
|
2703
|
+
return MarketingApiFp(this.configuration).createContact(body, options).then((request) => request(this.axios, this.basePath));
|
|
2704
|
+
}
|
|
2705
|
+
/**
|
|
2706
|
+
* to create a new contact list. The user must provide a name for the contact list.
|
|
2707
|
+
* @summary Create a new contact list
|
|
2708
|
+
* @param {CreateContactListDTO} body
|
|
2709
|
+
* @param {*} [options] Override http request option.
|
|
2710
|
+
* @throws {RequiredError}
|
|
2711
|
+
* @memberof MarketingApi
|
|
2712
|
+
*/
|
|
2713
|
+
public async createContactList(body: CreateContactListDTO, options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
2714
|
+
return MarketingApiFp(this.configuration).createContactList(body, options).then((request) => request(this.axios, this.basePath));
|
|
2715
|
+
}
|
|
2716
|
+
/**
|
|
2717
|
+
* to create a new email template. The user must provide a name, html content, text content, subject and description.
|
|
2718
|
+
* @summary Create a new email template
|
|
2719
|
+
* @param {CreateEmailTemplateDTO} body
|
|
2720
|
+
* @param {*} [options] Override http request option.
|
|
2721
|
+
* @throws {RequiredError}
|
|
2722
|
+
* @memberof MarketingApi
|
|
2723
|
+
*/
|
|
2724
|
+
public async createEmailTemplate(body: CreateEmailTemplateDTO, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<EmailTemplateResponseDTO>>> {
|
|
2725
|
+
return MarketingApiFp(this.configuration).createEmailTemplate(body, options).then((request) => request(this.axios, this.basePath));
|
|
2726
|
+
}
|
|
2727
|
+
/**
|
|
2728
|
+
* to delete a contact list by providing the ID of the contact list.
|
|
2729
|
+
* @summary Delete a contact list
|
|
2730
|
+
* @param {string} id
|
|
2731
|
+
* @param {*} [options] Override http request option.
|
|
2732
|
+
* @throws {RequiredError}
|
|
2733
|
+
* @memberof MarketingApi
|
|
2734
|
+
*/
|
|
2735
|
+
public async deleteContactList(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
|
|
2736
|
+
return MarketingApiFp(this.configuration).deleteContactList(id, options).then((request) => request(this.axios, this.basePath));
|
|
2737
|
+
}
|
|
2738
|
+
/**
|
|
2739
|
+
* to delete an existing email template. The user must provide the ID of the email template.
|
|
2740
|
+
* @summary Delete an existing email template
|
|
2741
|
+
* @param {string} id
|
|
2742
|
+
* @param {*} [options] Override http request option.
|
|
2743
|
+
* @throws {RequiredError}
|
|
2744
|
+
* @memberof MarketingApi
|
|
2745
|
+
*/
|
|
2746
|
+
public async deleteEmailTemplate(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
|
|
2747
|
+
return MarketingApiFp(this.configuration).deleteEmailTemplate(id, options).then((request) => request(this.axios, this.basePath));
|
|
2748
|
+
}
|
|
2749
|
+
/**
|
|
2750
|
+
* to retrieve aggregated open and click statistics, grouped by recipient country.
|
|
2751
|
+
* @summary ***** Retrieve aggregated open and click statistics, grouped by recipient country
|
|
2752
|
+
* @param {*} [options] Override http request option.
|
|
2753
|
+
* @throws {RequiredError}
|
|
2754
|
+
* @memberof MarketingApi
|
|
2755
|
+
*/
|
|
2756
|
+
public async getAggregatedOpenAndClickStatsGroupedByCountry(options?: AxiosRequestConfig) : Promise<AxiosResponse<CountryStatsResponseDTO>> {
|
|
2757
|
+
return MarketingApiFp(this.configuration).getAggregatedOpenAndClickStatsGroupedByCountry(options).then((request) => request(this.axios, this.basePath));
|
|
2758
|
+
}
|
|
2759
|
+
/**
|
|
2760
|
+
* to get aggregated statistics for all clicked links.
|
|
2761
|
+
* @summary Get aggregated statistics for all clicked links
|
|
2762
|
+
* @param {*} [options] Override http request option.
|
|
2763
|
+
* @throws {RequiredError}
|
|
2764
|
+
* @memberof MarketingApi
|
|
2765
|
+
*/
|
|
2766
|
+
public async getAggregatedStatsForAllClickedLinks(options?: AxiosRequestConfig) : Promise<AxiosResponse<LinkStatsResponseDTO>> {
|
|
2767
|
+
return MarketingApiFp(this.configuration).getAggregatedStatsForAllClickedLinks(options).then((request) => request(this.axios, this.basePath));
|
|
2768
|
+
}
|
|
2769
|
+
/**
|
|
2770
|
+
* to get aggregated statistics for all clicked links in a campaign by providing the ID of the campaign.
|
|
2771
|
+
* @summary Get aggregated statistics for all clicked links in a campaign
|
|
2772
|
+
* @param {string} id
|
|
2773
|
+
* @param {*} [options] Override http request option.
|
|
2774
|
+
* @throws {RequiredError}
|
|
2775
|
+
* @memberof MarketingApi
|
|
2776
|
+
*/
|
|
2777
|
+
public async getAggregatedStatsForAllClickedLinksInCampaign(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
|
|
2778
|
+
return MarketingApiFp(this.configuration).getAggregatedStatsForAllClickedLinksInCampaign(id, options).then((request) => request(this.axios, this.basePath));
|
|
2779
|
+
}
|
|
2780
|
+
/**
|
|
2781
|
+
* to get aggregated statistics for a specific contact by providing the ID of the contact.
|
|
2782
|
+
* @summary Get aggregated statistics for a specific contact
|
|
2783
|
+
* @param {string} id
|
|
2784
|
+
* @param {*} [options] Override http request option.
|
|
2785
|
+
* @throws {RequiredError}
|
|
2786
|
+
* @memberof MarketingApi
|
|
2787
|
+
*/
|
|
2788
|
+
public async getAggregatedStatsForSpecificContact(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactAggregatedStatsResponseDTO>> {
|
|
2789
|
+
return MarketingApiFp(this.configuration).getAggregatedStatsForSpecificContact(id, options).then((request) => request(this.axios, this.basePath));
|
|
2790
|
+
}
|
|
2791
|
+
/**
|
|
2792
|
+
* to get aggregated statistics for a specific list recipient by providing the ID of the list recipient.
|
|
2793
|
+
* @summary Get aggregated statistics for a specific list recipient
|
|
2794
|
+
* @param {string} id
|
|
2795
|
+
* @param {*} [options] Override http request option.
|
|
2796
|
+
* @throws {RequiredError}
|
|
2797
|
+
* @memberof MarketingApi
|
|
2798
|
+
*/
|
|
2799
|
+
public async getAggregatedStatsForSpecificListRecipient(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactListStatsResponseDTO>> {
|
|
2800
|
+
return MarketingApiFp(this.configuration).getAggregatedStatsForSpecificListRecipient(id, options).then((request) => request(this.axios, this.basePath));
|
|
2801
|
+
}
|
|
2802
|
+
/**
|
|
2803
|
+
* to get aggregated statistics, grouped by contact.
|
|
2804
|
+
* @summary Get aggregated statistics, grouped by contact
|
|
2805
|
+
* @param {*} [options] Override http request option.
|
|
2806
|
+
* @throws {RequiredError}
|
|
2807
|
+
* @memberof MarketingApi
|
|
2808
|
+
*/
|
|
2809
|
+
public async getAggregatedStatsGroupedByContact(options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactAggregatedStatsResponseDTO>> {
|
|
2810
|
+
return MarketingApiFp(this.configuration).getAggregatedStatsGroupedByContact(options).then((request) => request(this.axios, this.basePath));
|
|
2811
|
+
}
|
|
2812
|
+
/**
|
|
2813
|
+
* to get aggregated statistics, grouped by list recipient.
|
|
2814
|
+
* @summary Get aggregated statistics, grouped by list recipient
|
|
2815
|
+
* @param {*} [options] Override http request option.
|
|
2816
|
+
* @throws {RequiredError}
|
|
2817
|
+
* @memberof MarketingApi
|
|
2818
|
+
*/
|
|
2819
|
+
public async getAggregatedStatsGroupedByListRecipient(options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactListStatsResponseDTO>> {
|
|
2820
|
+
return MarketingApiFp(this.configuration).getAggregatedStatsGroupedByListRecipient(options).then((request) => request(this.axios, this.basePath));
|
|
2821
|
+
}
|
|
2822
|
+
/**
|
|
2823
|
+
* to get all campaign drafts that have been created by the user.
|
|
2824
|
+
* @summary Get all campaign drafts
|
|
2825
|
+
* @param {*} [options] Override http request option.
|
|
2826
|
+
* @throws {RequiredError}
|
|
2827
|
+
* @memberof MarketingApi
|
|
2828
|
+
*/
|
|
2829
|
+
public async getAllCampaignDrafts(options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignDraftResponseDTO>> {
|
|
2830
|
+
return MarketingApiFp(this.configuration).getAllCampaignDrafts(options).then((request) => request(this.axios, this.basePath));
|
|
2831
|
+
}
|
|
2832
|
+
/**
|
|
2833
|
+
* to get all contact lists that have been created by the user.
|
|
2834
|
+
* @summary Get all contact lists
|
|
2835
|
+
* @param {*} [options] Override http request option.
|
|
2836
|
+
* @throws {RequiredError}
|
|
2837
|
+
* @memberof MarketingApi
|
|
2838
|
+
*/
|
|
2839
|
+
public async getAllContactLists(options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
2840
|
+
return MarketingApiFp(this.configuration).getAllContactLists(options).then((request) => request(this.axios, this.basePath));
|
|
2841
|
+
}
|
|
2842
|
+
/**
|
|
2843
|
+
* to get all contact lists for a specific contact by providing the ID of the contact.
|
|
2844
|
+
* @summary Get all contact lists for a specific contact
|
|
2845
|
+
* @param {string} id
|
|
2846
|
+
* @param {*} [options] Override http request option.
|
|
2847
|
+
* @throws {RequiredError}
|
|
2848
|
+
* @memberof MarketingApi
|
|
2849
|
+
*/
|
|
2850
|
+
public async getAllContactListsForContact(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
2851
|
+
return MarketingApiFp(this.configuration).getAllContactListsForContact(id, options).then((request) => request(this.axios, this.basePath));
|
|
2852
|
+
}
|
|
2853
|
+
/**
|
|
2854
|
+
* to get all contacts that have been created by the user.
|
|
2855
|
+
* @summary Get all contacts
|
|
2856
|
+
* @param {*} [options] Override http request option.
|
|
2857
|
+
* @throws {RequiredError}
|
|
2858
|
+
* @memberof MarketingApi
|
|
2859
|
+
*/
|
|
2860
|
+
public async getAllContacts(options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactFullResponseDTO>> {
|
|
2861
|
+
return MarketingApiFp(this.configuration).getAllContacts(options).then((request) => request(this.axios, this.basePath));
|
|
2862
|
+
}
|
|
2863
|
+
/**
|
|
2864
|
+
* to get all email templates that have been created by the user.
|
|
2865
|
+
* @summary Get all email templates
|
|
2866
|
+
* @param {*} [options] Override http request option.
|
|
2867
|
+
* @throws {RequiredError}
|
|
2868
|
+
* @memberof MarketingApi
|
|
2869
|
+
*/
|
|
2870
|
+
public async getAllEmailTemplates(options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<EmailTemplateResponseDTO>>> {
|
|
2871
|
+
return MarketingApiFp(this.configuration).getAllEmailTemplates(options).then((request) => request(this.axios, this.basePath));
|
|
2872
|
+
}
|
|
2873
|
+
/**
|
|
2874
|
+
* to get a single campaign draft by providing the ID of the campaign draft.
|
|
2875
|
+
* @summary Get a single campaign draft
|
|
2876
|
+
* @param {string} id
|
|
2877
|
+
* @param {*} [options] Override http request option.
|
|
2878
|
+
* @throws {RequiredError}
|
|
2879
|
+
* @memberof MarketingApi
|
|
2880
|
+
*/
|
|
2881
|
+
public async getCampaignDraft(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignDraftResponseDTO>> {
|
|
2882
|
+
return MarketingApiFp(this.configuration).getCampaignDraft(id, options).then((request) => request(this.axios, this.basePath));
|
|
2883
|
+
}
|
|
2884
|
+
/**
|
|
2885
|
+
* to retrieve the content of a campaign draft email by providing the ID of the campaign draft.
|
|
2886
|
+
* @summary Retrieve the content of a campaign draft email
|
|
2887
|
+
* @param {string} id
|
|
2888
|
+
* @param {*} [options] Override http request option.
|
|
2889
|
+
* @throws {RequiredError}
|
|
2890
|
+
* @memberof MarketingApi
|
|
2891
|
+
*/
|
|
2892
|
+
public async getCampaignDraftContent(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignContentResponseDTO>> {
|
|
2893
|
+
return MarketingApiFp(this.configuration).getCampaignDraftContent(id, options).then((request) => request(this.axios, this.basePath));
|
|
2894
|
+
}
|
|
2895
|
+
/**
|
|
2896
|
+
* to get a single contact by providing the ID of the contact.
|
|
2897
|
+
* @summary Get a single contact
|
|
2898
|
+
* @param {string} id
|
|
2899
|
+
* @param {*} [options] Override http request option.
|
|
2900
|
+
* @throws {RequiredError}
|
|
2901
|
+
* @memberof MarketingApi
|
|
2902
|
+
*/
|
|
2903
|
+
public async getContact(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactFullResponseDTO>> {
|
|
2904
|
+
return MarketingApiFp(this.configuration).getContact(id, options).then((request) => request(this.axios, this.basePath));
|
|
2905
|
+
}
|
|
2906
|
+
/**
|
|
2907
|
+
* to get a single contact list by providing the ID of the contact list.
|
|
2908
|
+
* @summary Get a single contact list
|
|
2909
|
+
* @param {string} id
|
|
2910
|
+
* @param {*} [options] Override http request option.
|
|
2911
|
+
* @throws {RequiredError}
|
|
2912
|
+
* @memberof MarketingApi
|
|
2913
|
+
*/
|
|
2914
|
+
public async getContactList(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
2915
|
+
return MarketingApiFp(this.configuration).getContactList(id, options).then((request) => request(this.axios, this.basePath));
|
|
2916
|
+
}
|
|
2917
|
+
/**
|
|
2918
|
+
* to get general details and stats for all drafts, AB Testing objects and/or sent campaigns.
|
|
2919
|
+
* @summary Get general details and stats for all drafts, AB Testing objects and/or sent campaigns
|
|
2920
|
+
* @param {*} [options] Override http request option.
|
|
2921
|
+
* @throws {RequiredError}
|
|
2922
|
+
* @memberof MarketingApi
|
|
2923
|
+
*/
|
|
2924
|
+
public async getGeneralDetailsAndStats(options?: AxiosRequestConfig) : Promise<AxiosResponse<GeneralStatsResponseDTO>> {
|
|
2925
|
+
return MarketingApiFp(this.configuration).getGeneralDetailsAndStats(options).then((request) => request(this.axios, this.basePath));
|
|
2926
|
+
}
|
|
2927
|
+
/**
|
|
2928
|
+
* to get open or click counts, grouped by web browser / email client.
|
|
2929
|
+
* @summary Get open or click counts, grouped by web browser / email client
|
|
2930
|
+
* @param {*} [options] Override http request option.
|
|
2931
|
+
* @throws {RequiredError}
|
|
2932
|
+
* @memberof MarketingApi
|
|
2933
|
+
*/
|
|
2934
|
+
public async getOpenOrClickCountsGroupedByBrowser(options?: AxiosRequestConfig) : Promise<AxiosResponse<BrowserStatsResponseDTO>> {
|
|
2935
|
+
return MarketingApiFp(this.configuration).getOpenOrClickCountsGroupedByBrowser(options).then((request) => request(this.axios, this.basePath));
|
|
2936
|
+
}
|
|
2937
|
+
/**
|
|
2938
|
+
* to get information about a specific draft, AB Testing object or sent campaign by providing the ID of the campaign
|
|
2939
|
+
* @summary Get information about a specific draft, AB Testing object or sent campaign
|
|
2940
|
+
* @param {string} id
|
|
2941
|
+
* @param {*} [options] Override http request option.
|
|
2942
|
+
* @throws {RequiredError}
|
|
2943
|
+
* @memberof MarketingApi
|
|
2944
|
+
*/
|
|
2945
|
+
public async getSpecificStats(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<GeneralStatsResponseDTO>> {
|
|
2946
|
+
return MarketingApiFp(this.configuration).getSpecificStats(id, options).then((request) => request(this.axios, this.basePath));
|
|
2947
|
+
}
|
|
2948
|
+
/**
|
|
2949
|
+
* to retrieve statistics, aggregated by recipient's Email Service Provider (ESP).
|
|
2950
|
+
* @summary Retrieve statistics, aggregated by recipient's Email Service Provider (ESP)
|
|
2951
|
+
* @param {string} id
|
|
2952
|
+
* @param {*} [options] Override http request option.
|
|
2953
|
+
* @throws {RequiredError}
|
|
2954
|
+
* @memberof MarketingApi
|
|
2955
|
+
*/
|
|
2956
|
+
public async getStatsAggregatedByRecipientESP(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
|
|
2957
|
+
return MarketingApiFp(this.configuration).getStatsAggregatedByRecipientESP(id, options).then((request) => request(this.axios, this.basePath));
|
|
2958
|
+
}
|
|
2959
|
+
/**
|
|
2960
|
+
* to remove a contact from a list. The user must provide the ID of the contact and the ID of the list.
|
|
2961
|
+
* @summary Remove a contact from a list
|
|
2962
|
+
* @param {AddContactToListDTO} body
|
|
2963
|
+
* @param {*} [options] Override http request option.
|
|
2964
|
+
* @throws {RequiredError}
|
|
2965
|
+
* @memberof MarketingApi
|
|
2966
|
+
*/
|
|
2967
|
+
public async removeContactFromList(body: AddContactToListDTO, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
|
|
2968
|
+
return MarketingApiFp(this.configuration).removeContactFromList(body, options).then((request) => request(this.axios, this.basePath));
|
|
2969
|
+
}
|
|
2970
|
+
/**
|
|
2971
|
+
* to retrieve the sending schedule of a campaign draft by providing the ID of the campaign draft.
|
|
2972
|
+
* @summary Retrieve the sending schedule of a campaign draft
|
|
2973
|
+
* @param {string} id
|
|
2974
|
+
* @param {*} [options] Override http request option.
|
|
2975
|
+
* @throws {RequiredError}
|
|
2976
|
+
* @memberof MarketingApi
|
|
2977
|
+
*/
|
|
2978
|
+
public async retrieveSendingScheduleOfCampaignDraft(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignDraftScheduleResponseDTO>> {
|
|
2979
|
+
return MarketingApiFp(this.configuration).retrieveSendingScheduleOfCampaignDraft(id, options).then((request) => request(this.axios, this.basePath));
|
|
2980
|
+
}
|
|
2981
|
+
/**
|
|
2982
|
+
* to schedule a campaign draft by providing the ID of the campaign draft and the date of the schedule.
|
|
2983
|
+
* @summary Schedule a campaign draft
|
|
2984
|
+
* @param {ScheduleCampaignDraftDTO} body
|
|
2985
|
+
* @param {string} id
|
|
2986
|
+
* @param {*} [options] Override http request option.
|
|
2987
|
+
* @throws {RequiredError}
|
|
2988
|
+
* @memberof MarketingApi
|
|
2989
|
+
*/
|
|
2990
|
+
public async scheduleCampaignDraft(body: ScheduleCampaignDraftDTO, id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignDraftScheduleResponseDTO>> {
|
|
2991
|
+
return MarketingApiFp(this.configuration).scheduleCampaignDraft(body, id, options).then((request) => request(this.axios, this.basePath));
|
|
2992
|
+
}
|
|
2993
|
+
/**
|
|
2994
|
+
* to send a campaign draft immediately by providing the ID of the campaign draft.
|
|
2995
|
+
* @summary Send a campaign draft immediately
|
|
2996
|
+
* @param {string} id
|
|
2997
|
+
* @param {*} [options] Override http request option.
|
|
2998
|
+
* @throws {RequiredError}
|
|
2999
|
+
* @memberof MarketingApi
|
|
3000
|
+
*/
|
|
3001
|
+
public async sendCampaignDraftImmediately(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignDraftSendingResponseDTO>> {
|
|
3002
|
+
return MarketingApiFp(this.configuration).sendCampaignDraftImmediately(id, options).then((request) => request(this.axios, this.basePath));
|
|
3003
|
+
}
|
|
3004
|
+
/**
|
|
3005
|
+
* to send a test email for a specified campaign draft by providing the ID of the campaign draft and the recipients of the test email.
|
|
3006
|
+
* @summary Send a test email for a specified campaign draft
|
|
3007
|
+
* @param {SendTestEmailDTO} body
|
|
3008
|
+
* @param {string} id
|
|
3009
|
+
* @param {*} [options] Override http request option.
|
|
3010
|
+
* @throws {RequiredError}
|
|
3011
|
+
* @memberof MarketingApi
|
|
3012
|
+
*/
|
|
3013
|
+
public async sendTestEmail(body: SendTestEmailDTO, id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignDraftSendingResponseDTO>> {
|
|
3014
|
+
return MarketingApiFp(this.configuration).sendTestEmail(body, id, options).then((request) => request(this.axios, this.basePath));
|
|
3015
|
+
}
|
|
3016
|
+
/**
|
|
3017
|
+
* to update a campaign draft. The user can change the title, subject, contactsListId, senderEmail, senderName, senderId and locale of the campaign draft.
|
|
3018
|
+
* @summary Update a campaign draft
|
|
3019
|
+
* @param {UpdateMarketingCampDraftDto} body
|
|
3020
|
+
* @param {string} id
|
|
3021
|
+
* @param {*} [options] Override http request option.
|
|
3022
|
+
* @throws {RequiredError}
|
|
3023
|
+
* @memberof MarketingApi
|
|
3024
|
+
*/
|
|
3025
|
+
public async updateCampaignDraft(body: UpdateMarketingCampDraftDto, id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignDraftResponseDTO>> {
|
|
3026
|
+
return MarketingApiFp(this.configuration).updateCampaignDraft(body, id, options).then((request) => request(this.axios, this.basePath));
|
|
3027
|
+
}
|
|
3028
|
+
/**
|
|
3029
|
+
* to update the content of a campaign draft. The user must provide the ID of the campaign draft and the html content.
|
|
3030
|
+
* @summary Update the content of a campaign draft
|
|
3031
|
+
* @param {UpdateCampaignDraftContentDto} body
|
|
3032
|
+
* @param {string} id
|
|
3033
|
+
* @param {*} [options] Override http request option.
|
|
3034
|
+
* @throws {RequiredError}
|
|
3035
|
+
* @memberof MarketingApi
|
|
3036
|
+
*/
|
|
3037
|
+
public async updateCampaignDraftContent(body: UpdateCampaignDraftContentDto, id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignContentResponseDTO>> {
|
|
3038
|
+
return MarketingApiFp(this.configuration).updateCampaignDraftContent(body, id, options).then((request) => request(this.axios, this.basePath));
|
|
3039
|
+
}
|
|
3040
|
+
/**
|
|
3041
|
+
* to update a contact. The user can exclude the contact from campaigns by setting the isExcludedFromCampaigns parameter to true.
|
|
3042
|
+
* @summary Update a contact
|
|
3043
|
+
* @param {string} id
|
|
3044
|
+
* @param {boolean} isExcludedFromCampaigns
|
|
3045
|
+
* @param {*} [options] Override http request option.
|
|
3046
|
+
* @throws {RequiredError}
|
|
3047
|
+
* @memberof MarketingApi
|
|
3048
|
+
*/
|
|
3049
|
+
public async updateContact(id: string, isExcludedFromCampaigns: boolean, options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactFullResponseDTO>> {
|
|
3050
|
+
return MarketingApiFp(this.configuration).updateContact(id, isExcludedFromCampaigns, options).then((request) => request(this.axios, this.basePath));
|
|
3051
|
+
}
|
|
3052
|
+
/**
|
|
3053
|
+
* to update a contact list. The user can change the name of the contact list.
|
|
3054
|
+
* @summary Update a contact list
|
|
3055
|
+
* @param {CreateContactListDTO} body
|
|
3056
|
+
* @param {string} id
|
|
3057
|
+
* @param {*} [options] Override http request option.
|
|
3058
|
+
* @throws {RequiredError}
|
|
3059
|
+
* @memberof MarketingApi
|
|
3060
|
+
*/
|
|
3061
|
+
public async updateContactList(body: CreateContactListDTO, id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<ContactListsResponseDTO>> {
|
|
3062
|
+
return MarketingApiFp(this.configuration).updateContactList(body, id, options).then((request) => request(this.axios, this.basePath));
|
|
3063
|
+
}
|
|
3064
|
+
/**
|
|
3065
|
+
* to update an existing email template. The user must provide the ID of the email template and the name, html content, text content, subject and description.
|
|
3066
|
+
* @summary Update an existing email template
|
|
3067
|
+
* @param {CreateEmailTemplateDTO} body
|
|
3068
|
+
* @param {string} id
|
|
3069
|
+
* @param {*} [options] Override http request option.
|
|
3070
|
+
* @throws {RequiredError}
|
|
3071
|
+
* @memberof MarketingApi
|
|
3072
|
+
*/
|
|
3073
|
+
public async updateEmailTemplate(body: CreateEmailTemplateDTO, id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<EmailTemplateResponseDTO>>> {
|
|
3074
|
+
return MarketingApiFp(this.configuration).updateEmailTemplate(body, id, options).then((request) => request(this.axios, this.basePath));
|
|
3075
|
+
}
|
|
3076
|
+
/**
|
|
3077
|
+
* to update the sending schedule of a campaign draft by providing the ID of the campaign draft and the date of the schedule.
|
|
3078
|
+
* @summary Update the sending schedule of a campaign draft
|
|
3079
|
+
* @param {ScheduleCampaignDraftDTO} body
|
|
3080
|
+
* @param {string} id
|
|
3081
|
+
* @param {*} [options] Override http request option.
|
|
3082
|
+
* @throws {RequiredError}
|
|
3083
|
+
* @memberof MarketingApi
|
|
3084
|
+
*/
|
|
3085
|
+
public async updateSendingScheduleOfCampaignDraft(body: ScheduleCampaignDraftDTO, id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
|
|
3086
|
+
return MarketingApiFp(this.configuration).updateSendingScheduleOfCampaignDraft(body, id, options).then((request) => request(this.axios, this.basePath));
|
|
3087
|
+
}
|
|
3088
|
+
/**
|
|
3089
|
+
* to view the sending status of a campaign draft by providing the ID of the campaign draft.
|
|
3090
|
+
* @summary View the sending status of a campaign draft
|
|
3091
|
+
* @param {string} id
|
|
3092
|
+
* @param {*} [options] Override http request option.
|
|
3093
|
+
* @throws {RequiredError}
|
|
3094
|
+
* @memberof MarketingApi
|
|
3095
|
+
*/
|
|
3096
|
+
public async viewSendingStatusOfCampaignDraft(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CampaignDraftSendingResponseDTO>> {
|
|
3097
|
+
return MarketingApiFp(this.configuration).viewSendingStatusOfCampaignDraft(id, options).then((request) => request(this.axios, this.basePath));
|
|
3098
|
+
}
|
|
3099
|
+
}
|