90
90
91
91
## Documentation for API Endpoints
92
92
93
- All URIs are relative to * https ://my.yoast.test*
93
+ All URIs are relative to * http ://my.yoast.test:3000 *
94
94
95
95
Class | Method | HTTP request | Description
96
96
------------ | ------------- | ------------- | -------------
@@ -159,7 +159,6 @@ Class | Method | HTTP request | Description
159
159
* CustomerApi* | [ ** getMany_3** ] ( docs/Api/CustomerApi.md#getmany_3 ) | ** GET** /api/Customers/{id}/roles |
160
160
* CustomerApi* | [ ** getMany_4** ] ( docs/Api/CustomerApi.md#getmany_4 ) | ** GET** /api/Customers/{customerId}/identities | Get user identities
161
161
* CustomerApi* | [ ** getMany_5** ] ( docs/Api/CustomerApi.md#getmany_5 ) | ** GET** /api/Customers | Get customers
162
- * CustomerApi* | [ ** getMany_6** ] ( docs/Api/CustomerApi.md#getmany_6 ) | ** GET** /api/Customers/{customerId}/licenses | Get licenses
163
162
* CustomerApi* | [ ** getOne** ] ( docs/Api/CustomerApi.md#getone ) | ** GET** /api/Customers/{customerId}/composerTokens/{id} | Get a composer token
164
163
* CustomerApi* | [ ** getOne_0** ] ( docs/Api/CustomerApi.md#getone_0 ) | ** GET** /api/Customers/{customerId}/subscriptions/{id} | Get a subscriptions
165
164
* CustomerApi* | [ ** getOne_1** ] ( docs/Api/CustomerApi.md#getone_1 ) | ** GET** /api/Customers/{customerId}/sites/{id} | Get a site
@@ -171,7 +170,12 @@ Class | Method | HTTP request | Description
171
170
* CustomerApi* | [ ** resetPassword** ] ( docs/Api/CustomerApi.md#resetpassword ) | ** PATCH** /api/Customers/resetPassword | Reset the user' ; s password.
172
171
* CustomerApi* | [ ** sendResetPasswordEmail** ] ( docs/Api/CustomerApi.md#sendresetpasswordemail ) | ** POST** /api/Customers/sendResetPasswordEmail | Send a reset password email to the user.
173
172
* CustomerApi* | [ ** signup** ] ( docs/Api/CustomerApi.md#signup ) | ** POST** /api/Customers/signup | Signup a customer on yoast.com following the normal signup flow.
173
+ * CustomerApi* | [ ** status** ] ( docs/Api/CustomerApi.md#status ) | ** GET** /api/Customers/{customerId}/newsletter | Newsletter subscription status
174
+ * CustomerApi* | [ ** subscribe** ] ( docs/Api/CustomerApi.md#subscribe ) | ** POST** /api/Customers/{customerId}/newsletter | Subscribe to the newsletter
175
+ * CustomerApi* | [ ** subscribeByEmail** ] ( docs/Api/CustomerApi.md#subscribebyemail ) | ** POST** /api/Customers/newsletter/{list}/subscribe | Subscribes a user to a newsletter
176
+ * CustomerApi* | [ ** unsubscribe** ] ( docs/Api/CustomerApi.md#unsubscribe ) | ** DELETE** /api/Customers/{customerId}/newsletter | Unsubscribe from the newsletter
174
177
* CustomerApi* | [ ** updateOne** ] ( docs/Api/CustomerApi.md#updateone ) | ** PATCH** /api/Customers/{id} |
178
+ * CustomerApi* | [ ** uploadAvatar** ] ( docs/Api/CustomerApi.md#uploadavatar ) | ** POST** /api/Customers/{id}/avatar | Upload a new UserAvatar to WordPress
175
179
* CustomerNoteApi* | [ ** createOne** ] ( docs/Api/CustomerNoteApi.md#createone ) | ** POST** /api/CustomerNotes |
176
180
* CustomerNoteApi* | [ ** deleteOne** ] ( docs/Api/CustomerNoteApi.md#deleteone ) | ** DELETE** /api/CustomerNotes/{id} |
177
181
* CustomerNoteApi* | [ ** getMany** ] ( docs/Api/CustomerNoteApi.md#getmany ) | ** GET** /api/CustomerNotes | Get customer notes
@@ -190,10 +194,6 @@ Class | Method | HTTP request | Description
190
194
* FromWooCommerceApi* | [ ** productGroupFromWooCommerce** ] ( docs/Api/FromWooCommerceApi.md#productgroupfromwoocommerce ) | ** PUT** /api/ProductGroups/fromWooCommerce | Sync products to MyYoast.
191
195
* GDPRApi* | [ ** deleteCustomer** ] ( docs/Api/GDPRApi.md#deletecustomer ) | ** DELETE** /api/Customers/{id}/gdpr-delete | Performs a \& quot;GDPR forget me\& quot; request.
192
196
* HelpscoutApi* | [ ** helpscout** ] ( docs/Api/HelpscoutApi.md#helpscout ) | ** POST** /helpscout | Get information about a customer
193
- * LicensingApi* | [ ** getMany** ] ( docs/Api/LicensingApi.md#getmany ) | ** GET** /api/licenses | Gets licenses
194
- * LicensingApi* | [ ** getManyPaged** ] ( docs/Api/LicensingApi.md#getmanypaged ) | ** GET** /api/licenses/paged | Gets licenses
195
- * LicensingApi* | [ ** getValidity** ] ( docs/Api/LicensingApi.md#getvalidity ) | ** GET** /api/licenses/{id}/validity | Gets the current status of a license
196
- * LicensingApi* | [ ** processEvent** ] ( docs/Api/LicensingApi.md#processevent ) | ** POST** /api/licensing/events |
197
197
* MailingListApi* | [ ** checkGetRoute** ] ( docs/Api/MailingListApi.md#checkgetroute ) | ** GET** /api/Mailing-list/newsletter/tZhjyjwsYFUMPzNNhJaVADZZIrixRSbXOFgptZJyyK |
198
198
* MailingListApi* | [ ** getStatus** ] ( docs/Api/MailingListApi.md#getstatus ) | ** GET** /api/Mailing-list/status | Get the subscription status.
199
199
* MailingListApi* | [ ** isSubscribedToNewsletter** ] ( docs/Api/MailingListApi.md#issubscribedtonewsletter ) | ** GET** /api/Mailing-list/isSubscribedToNewsletter | Get the subscription status.
@@ -225,11 +225,8 @@ Class | Method | HTTP request | Description
225
225
* ProductApi* | [ ** pluginVersionDetails** ] ( docs/Api/ProductApi.md#pluginversiondetails ) | ** GET** /api/Products/wordpressPluginVersionDetails |
226
226
* ProductGroupApi* | [ ** getMany** ] ( docs/Api/ProductGroupApi.md#getmany ) | ** GET** /api/ProductGroups | Get productgroups
227
227
* ProductGroupApi* | [ ** updateDownload** ] ( docs/Api/ProductGroupApi.md#updatedownload ) | ** PATCH** /api/ProductGroups/updateDownload | Update the download
228
- * ProductSwitchApi* | [ ** getManyPaged** ] ( docs/Api/ProductSwitchApi.md#getmanypaged ) | ** GET** /api/ProductSwitches/paged | Get product switches
229
- * ProductSwitchApi* | [ ** invoice** ] ( docs/Api/ProductSwitchApi.md#invoice ) | ** GET** /api/ProductSwitches/{id}/invoice | Create invoice
230
- * ProductSwitchApi* | [ ** invoice_0** ] ( docs/Api/ProductSwitchApi.md#invoice_0 ) | ** GET** /api/ProductSwitch/{id}/invoice | Create invoice
231
- * ProductSwitchApi* | [ ** revert** ] ( docs/Api/ProductSwitchApi.md#revert ) | ** GET** /api/ProductSwitches/{id}/revert | Create invoice
232
- * ProductSwitchApi* | [ ** revert_0** ] ( docs/Api/ProductSwitchApi.md#revert_0 ) | ** GET** /api/ProductSwitch/{id}/revert | Create invoice
228
+ * ProductSwitchApi* | [ ** invoice** ] ( docs/Api/ProductSwitchApi.md#invoice ) | ** GET** /api/ProductSwitch/{id}/invoice | Create invoice
229
+ * ProductSwitchApi* | [ ** revert** ] ( docs/Api/ProductSwitchApi.md#revert ) | ** GET** /api/ProductSwitch/{id}/revert | Create invoice
233
230
* ProvisionerApi* | [ ** getMany** ] ( docs/Api/ProvisionerApi.md#getmany ) | ** GET** /api/ProvisionerData | Get provisioner data
234
231
* ProvisionerApi* | [ ** getOne** ] ( docs/Api/ProvisionerApi.md#getone ) | ** GET** /api/ProvisionerData/{id} | Get provisioner data
235
232
* ProvisioningAccountApi* | [ ** setSiteForSubscription** ] ( docs/Api/ProvisioningAccountApi.md#setsiteforsubscription ) | ** POST** /api/provisioning/account/regenerate-token | Generate a new auth token
@@ -248,6 +245,7 @@ Class | Method | HTTP request | Description
248
245
* SiteApi* | [ ** getMany** ] ( docs/Api/SiteApi.md#getmany ) | ** GET** /api/Sites | Get sites
249
246
* SiteApi* | [ ** getManyPaged** ] ( docs/Api/SiteApi.md#getmanypaged ) | ** GET** /api/Sites/paged | Get sites
250
247
* SiteApi* | [ ** getOne** ] ( docs/Api/SiteApi.md#getone ) | ** GET** /api/Sites/{id} | Get a site
248
+ * SiteApi* | [ ** getSiteStatus** ] ( docs/Api/SiteApi.md#getsitestatus ) | ** GET** /api/Sites/getSiteStatus | Get a urls HTTP status
251
249
* SiteApi* | [ ** index** ] ( docs/Api/SiteApi.md#index ) | ** POST** /api/Sites/index |
252
250
* SiteApi* | [ ** removeSubscription** ] ( docs/Api/SiteApi.md#removesubscription ) | ** DELETE** /api/Sites/{id}/subscriptions/{subscriptionId} | Removes a subscription from a site
253
251
* SiteApi* | [ ** switchSubscription** ] ( docs/Api/SiteApi.md#switchsubscription ) | ** POST** /api/Sites/switchSubscription | Switches the subscription for a number of times.
@@ -267,7 +265,6 @@ Class | Method | HTTP request | Description
267
265
* SubscriptionApi* | [ ** linkSite** ] ( docs/Api/SubscriptionApi.md#linksite ) | ** POST** /api/Subscriptions/link-site | Link a subscription to provided site URL
268
266
* SubscriptionApi* | [ ** recalculateSubscriptionCount** ] ( docs/Api/SubscriptionApi.md#recalculatesubscriptioncount ) | ** POST** /api/Subscriptions/{id}/recalculateSubscriptionCount | Recalculate SubscriptionCount.
269
267
* SubscriptionApi* | [ ** renew** ] ( docs/Api/SubscriptionApi.md#renew ) | ** GET** /api/Subscriptions/renew/{subscriptionNumber}/{secretKey} | Renew subscriptions
270
- * SubscriptionApi* | [ ** runScript** ] ( docs/Api/SubscriptionApi.md#runscript ) | ** GET** /api/Subscriptions/runscript |
271
268
* SubscriptionApi* | [ ** setExpiryDate** ] ( docs/Api/SubscriptionApi.md#setexpirydate ) | ** POST** /api/Subscriptions/setExpiryDate | Set Date.
272
269
* SubscriptionApi* | [ ** switchPaymentMethod** ] ( docs/Api/SubscriptionApi.md#switchpaymentmethod ) | ** GET** /api/Subscriptions/switchPaymentMethod/{id}/{subscriptionNumber} |
273
270
* SubscriptionApi* | [ ** switchProduct** ] ( docs/Api/SubscriptionApi.md#switchproduct ) | ** POST** /api/Subscriptions/{id}/switch-product | Switch to another product
@@ -323,7 +320,6 @@ Class | Method | HTTP request | Description
323
320
- [ CustomerFromWooDto] ( docs/Model/CustomerFromWooDto.md )
324
321
- [ CustomerNote] ( docs/Model/CustomerNote.md )
325
322
- [ EddDTO] ( docs/Model/EddDTO.md )
326
- - [ EventDto] ( docs/Model/EventDto.md )
327
323
- [ ExtraCourseDataDto] ( docs/Model/ExtraCourseDataDto.md )
328
324
- [ ExtraOrderData] ( docs/Model/ExtraOrderData.md )
329
325
- [ ExtraProductData] ( docs/Model/ExtraProductData.md )
@@ -335,8 +331,6 @@ Class | Method | HTTP request | Description
335
331
- [ InviteDto] ( docs/Model/InviteDto.md )
336
332
- [ JSZip] ( docs/Model/JSZip.md )
337
333
- [ JobOptionsDto] ( docs/Model/JobOptionsDto.md )
338
- - [ License] ( docs/Model/License.md )
339
- - [ LicenseDTO] ( docs/Model/LicenseDTO.md )
340
334
- [ LineItemDto] ( docs/Model/LineItemDto.md )
341
335
- [ LineItemTax] ( docs/Model/LineItemTax.md )
342
336
- [ LinkSiteDto] ( docs/Model/LinkSiteDto.md )
@@ -376,10 +370,12 @@ Class | Method | HTTP request | Description
376
370
- [ ShippingDto] ( docs/Model/ShippingDto.md )
377
371
- [ SignupAccountDto] ( docs/Model/SignupAccountDto.md )
378
372
- [ Site] ( docs/Model/Site.md )
373
+ - [ SubscribeByEmailBodyDto] ( docs/Model/SubscribeByEmailBodyDto.md )
379
374
- [ SubscribeDto] ( docs/Model/SubscribeDto.md )
380
375
- [ Subscription] ( docs/Model/Subscription.md )
381
376
- [ SubscriptionMutation] ( docs/Model/SubscriptionMutation.md )
382
377
- [ SubscriptionProvisioningResponseDto] ( docs/Model/SubscriptionProvisioningResponseDto.md )
378
+ - [ SubscriptionStatusDto] ( docs/Model/SubscriptionStatusDto.md )
383
379
- [ SwitchSubscriptionNumberOfTimesDto] ( docs/Model/SwitchSubscriptionNumberOfTimesDto.md )
384
380
- [ TOTPTwoFactorConfigDto] ( docs/Model/TOTPTwoFactorConfigDto.md )
385
381
- [ TagDto] ( docs/Model/TagDto.md )
0 commit comments