Skip to content

Commit c506f75

Browse files
sibrookesibrooke
authored
Merge branch 'master' into article-fixes
2 parents 3a49ee1 + 5ec6d62 commit c506f75

File tree

13 files changed

+10068
-0
lines changed

13 files changed

+10068
-0
lines changed

‎guides/release-notes.md

+19
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,25 @@ We love hearing your feedback! You can help us improve the docs by reporting any
88

99
---
1010

11+
### New Developer Preview API: Wix Email Marketing v2
12+
13+
`wix-email-marketing.v2`
14+
15+
The new [Wix Email Marketing API](/wix-email-marketing-v2) provides functionality
16+
for managing your email marketing campaigns.
17+
18+
Functionalities include:
19+
20+
+ [Getting](/wix-email-marketing-v2/accountdetails/getaccountdetails) your email marketing account details.
21+
+ Getting a [list](/wix-email-marketing-v2/campaigns/listcampaigns) of your email campaigns.
22+
+ [Pausing](/wix-email-marketing-v2/campaigns/pausescheduling) a scheduled campaign.
23+
+ [Sending](/wix-email-marketing-v2/campaigns/sendtest) a test email for preview purposes.
24+
+ Getting a [list](/wix-email-marketing-v2/campaigns/liststatistics) of statistics for up to 100 selected campaigns.
25+
26+
**Note:** This module is in [Developer Preview](./developer-preview.md).
27+
28+
(February 5, 2023)
29+
1130
### New APIs: Wix eCommerce Checkout
1231

1332
`wix-ecom-backend`

‎wix-email-marketing-v2/wix-email-marketing-v2.service.json

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"name": "wix-email-marketing-v2",
3+
"displayName": "wix-email-marketing.v2",
4+
"mixes": [],
5+
"callbacks": [],
6+
"extra": {},
7+
"clientId": "wix-email-marketing.v2",
8+
"docs": {},
9+
"relatedGuides": [],
10+
"properties": [
11+
{
12+
"name": "accountDetails",
13+
"type": [
14+
{
15+
"referenceType": "wix-email-marketing-v2.AccountDetails"
16+
}
17+
],
18+
"docs": {
19+
"summary": "",
20+
"links": [],
21+
"examples": [],
22+
"extra": {}
23+
},
24+
"hidden": true
25+
},
26+
{
27+
"name": "campaigns",
28+
"type": [
29+
{
30+
"referenceType": "wix-email-marketing-v2.Campaigns"
31+
}
32+
],
33+
"docs": {
34+
"summary": "",
35+
"links": [],
36+
"examples": [],
37+
"extra": {}
38+
},
39+
"hidden": true
40+
}
41+
],
42+
"operations": [],
43+
"messages": []
44+
}

‎wix-email-marketing-v2/wix-email-marketing-v2/AccountDetails.service.json

+246
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,246 @@
1+
{
2+
"name": "AccountDetails",
3+
"memberOf": "wix-email-marketing-v2",
4+
"mixes": [],
5+
"callbacks": [],
6+
"extra": {},
7+
"clientId": "wix-email-marketing.v2-account_details",
8+
"docs": {},
9+
"relatedGuides": [],
10+
"properties": [],
11+
"operations": [
12+
{
13+
"name": "getAccountDetails",
14+
"params": [],
15+
"requiredFields": [],
16+
"ret": {
17+
"type": [
18+
{
19+
"complexType": {
20+
"nativeType": "Promise",
21+
"typeParams": [
22+
{
23+
"referenceType": "wix-email-marketing-v2.AccountDetails.GetAccountDetailsResponse"
24+
}
25+
]
26+
}
27+
}
28+
],
29+
"doc": null
30+
},
31+
"docs": {
32+
"summary": "Retrieves email marketing account details.",
33+
"description": [
34+
">**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function."
35+
],
36+
"examples": [
37+
{
38+
"title": "GetAccountDetails example",
39+
"body": [
40+
"import { accountDetails } from 'wix-email-marketing.v2';",
41+
" ",
42+
" async function getAccountDetails() {",
43+
" try {",
44+
" const result = await accountDetails.getAccountDetails();",
45+
"",
46+
" return result;",
47+
" } catch (error) {",
48+
" console.error(error);",
49+
" // Handle the error",
50+
" }",
51+
" }",
52+
" "
53+
]
54+
}
55+
]
56+
},
57+
"isVeloEvent": false,
58+
"customLabels": [
59+
{
60+
"id": "maturity-beta"
61+
}
62+
]
63+
}
64+
],
65+
"messages": [
66+
{
67+
"name": "AccountDetails",
68+
"members": [
69+
{
70+
"name": "package",
71+
"optional": true,
72+
"type": [
73+
{
74+
"referenceType": "wix-email-marketing-v2.AccountDetails.Package"
75+
}
76+
],
77+
"doc": "Current premium package information."
78+
},
79+
{
80+
"name": "quotaPeriod",
81+
"optional": true,
82+
"type": [
83+
{
84+
"referenceType": "wix-email-marketing-v2.AccountDetails.QuotaPeriod"
85+
}
86+
],
87+
"doc": "Quota period and usage."
88+
},
89+
{
90+
"name": "status",
91+
"optional": true,
92+
"type": [
93+
{
94+
"nativeType": "string"
95+
}
96+
],
97+
"doc": "Account status. One of:\n+ `'ACTIVE'`\n+ `'WARNED'`\n+ `'SUSPENDED'`\n+ `'BANNED'`"
98+
}
99+
],
100+
"docs": {
101+
"description": [
102+
"An account can be active or in some state of suspension (warned/suspended/banned).\nIf a user is in a state of suspension they must visit their email marketing account in the Wix business manager and follow the instructions."
103+
]
104+
}
105+
},
106+
{
107+
"name": "GetAccountDetailsRequest",
108+
"members": [],
109+
"docs": {
110+
"description": [
111+
""
112+
]
113+
}
114+
},
115+
{
116+
"name": "GetAccountDetailsResponse",
117+
"members": [
118+
{
119+
"name": "accountDetails",
120+
"optional": true,
121+
"type": [
122+
{
123+
"referenceType": "wix-email-marketing-v2.AccountDetails.AccountDetails"
124+
}
125+
],
126+
"doc": "Current account details."
127+
}
128+
],
129+
"docs": {
130+
"description": [
131+
""
132+
]
133+
}
134+
},
135+
{
136+
"name": "Package",
137+
"members": [
138+
{
139+
"name": "_id",
140+
"optional": true,
141+
"type": [
142+
{
143+
"nativeType": "string"
144+
}
145+
],
146+
"doc": "Package ID."
147+
},
148+
{
149+
"name": "group",
150+
"optional": true,
151+
"type": [
152+
{
153+
"nativeType": "string"
154+
}
155+
],
156+
"doc": "Package group."
157+
},
158+
{
159+
"name": "monthlyQuotaAllocation",
160+
"optional": true,
161+
"type": [
162+
{
163+
"referenceType": "wix-email-marketing-v2.AccountDetails.Quota"
164+
}
165+
],
166+
"doc": "Allocated quota per month."
167+
}
168+
],
169+
"docs": {
170+
"description": [
171+
""
172+
]
173+
}
174+
},
175+
{
176+
"name": "Quota",
177+
"members": [
178+
{
179+
"name": "campaigns",
180+
"optional": true,
181+
"type": [
182+
{
183+
"nativeType": "number"
184+
}
185+
],
186+
"doc": "Number of allocated marketing campaigns per month (-1 means unlimited)."
187+
},
188+
{
189+
"name": "emails",
190+
"optional": true,
191+
"type": [
192+
{
193+
"nativeType": "number"
194+
}
195+
],
196+
"doc": "Number of allocated individual emails per month."
197+
}
198+
],
199+
"docs": {
200+
"description": [
201+
""
202+
]
203+
}
204+
},
205+
{
206+
"name": "QuotaPeriod",
207+
"members": [
208+
{
209+
"name": "dateFrom",
210+
"optional": true,
211+
"type": [
212+
{
213+
"nativeType": "Date"
214+
}
215+
],
216+
"doc": "Current quota period start date."
217+
},
218+
{
219+
"name": "dateTo",
220+
"optional": true,
221+
"type": [
222+
{
223+
"nativeType": "Date"
224+
}
225+
],
226+
"doc": "Current quota period end date - after which quota will roll over."
227+
},
228+
{
229+
"name": "quotaUsage",
230+
"optional": true,
231+
"type": [
232+
{
233+
"referenceType": "wix-email-marketing-v2.AccountDetails.Quota"
234+
}
235+
],
236+
"doc": "Information about allocated quota already used in this period."
237+
}
238+
],
239+
"docs": {
240+
"description": [
241+
""
242+
]
243+
}
244+
}
245+
]
246+
}

‎wix-email-marketing-v2/wix-email-marketing-v2/AccountDetails/guides/account-details-intro.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Introduction
3+
---
4+
5+
# Introduction
6+
7+
<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
8+
<b>Developer Preview</b>
9+
<br/>
10+
<span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:[email protected]">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
11+
</div>
12+
13+
14+
&nbsp;
15+
> **Note:** This module is [universal](/api-overview/api-versions#universal-modules). Functions in this module can run on both the backend and frontend, unless specified otherwise.
16+
17+
18+
The Account Details API provides functionality for managing your email marketing account information. Use the API to [get your current account details](/getaccountdetails).
19+
20+
21+
To use the Account Details API, import `accountDetails` from the `wix-email-marketing.v2` module:
22+
23+
```js
24+
import { accountDetails } from 'wix-email-marketing.v2';
25+
```

‎wix-email-marketing-v2/wix-email-marketing-v2/AccountDetails/summary.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The Account Details API contains information about your Wix email marketing account.

0 commit comments

Comments
 (0)