90
90
91
91
## Documentation for API Endpoints
92
92
93
- All URIs are relative to * http ://my.yoast.test:3000 *
93
+ All URIs are relative to * https ://my.yoast.test*
94
94
95
95
Class | Method | HTTP request | Description
96
96
------------ | ------------- | ------------- | -------------
@@ -159,6 +159,7 @@ 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
162
163
* CustomerApi* | [ ** getOne** ] ( docs/Api/CustomerApi.md#getone ) | ** GET** /api/Customers/{customerId}/composerTokens/{id} | Get a composer token
163
164
* CustomerApi* | [ ** getOne_0** ] ( docs/Api/CustomerApi.md#getone_0 ) | ** GET** /api/Customers/{customerId}/subscriptions/{id} | Get a subscriptions
164
165
* CustomerApi* | [ ** getOne_1** ] ( docs/Api/CustomerApi.md#getone_1 ) | ** GET** /api/Customers/{customerId}/sites/{id} | Get a site
@@ -170,12 +171,7 @@ Class | Method | HTTP request | Description
170
171
* CustomerApi* | [ ** resetPassword** ] ( docs/Api/CustomerApi.md#resetpassword ) | ** PATCH** /api/Customers/resetPassword | Reset the user' ; s password.
171
172
* CustomerApi* | [ ** sendResetPasswordEmail** ] ( docs/Api/CustomerApi.md#sendresetpasswordemail ) | ** POST** /api/Customers/sendResetPasswordEmail | Send a reset password email to the user.
172
173
* 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
177
174
* 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
179
175
* CustomerNoteApi* | [ ** createOne** ] ( docs/Api/CustomerNoteApi.md#createone ) | ** POST** /api/CustomerNotes |
180
176
* CustomerNoteApi* | [ ** deleteOne** ] ( docs/Api/CustomerNoteApi.md#deleteone ) | ** DELETE** /api/CustomerNotes/{id} |
181
177
* CustomerNoteApi* | [ ** getMany** ] ( docs/Api/CustomerNoteApi.md#getmany ) | ** GET** /api/CustomerNotes | Get customer notes
@@ -194,6 +190,10 @@ Class | Method | HTTP request | Description
194
190
* FromWooCommerceApi* | [ ** productGroupFromWooCommerce** ] ( docs/Api/FromWooCommerceApi.md#productgroupfromwoocommerce ) | ** PUT** /api/ProductGroups/fromWooCommerce | Sync products to MyYoast.
195
191
* GDPRApi* | [ ** deleteCustomer** ] ( docs/Api/GDPRApi.md#deletecustomer ) | ** DELETE** /api/Customers/{id}/gdpr-delete | Performs a \& quot;GDPR forget me\& quot; request.
196
192
* 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.
@@ -224,9 +224,13 @@ Class | Method | HTTP request | Description
224
224
* ProductApi* | [ ** getOne** ] ( docs/Api/ProductApi.md#getone ) | ** GET** /api/Products/{id} | Get a product
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
+ * ProductGroupApi* | [ ** getReleaseDetails** ] ( docs/Api/ProductGroupApi.md#getreleasedetails ) | ** GET** /api/ProductGroups/releaseDetails |
227
228
* ProductGroupApi* | [ ** updateDownload** ] ( docs/Api/ProductGroupApi.md#updatedownload ) | ** PATCH** /api/ProductGroups/updateDownload | Update the download
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
229
+ * ProductSwitchApi* | [ ** getManyPaged** ] ( docs/Api/ProductSwitchApi.md#getmanypaged ) | ** GET** /api/ProductSwitches/paged | Get product switches
230
+ * ProductSwitchApi* | [ ** invoice** ] ( docs/Api/ProductSwitchApi.md#invoice ) | ** GET** /api/ProductSwitches/{id}/invoice | Create invoice
231
+ * ProductSwitchApi* | [ ** invoice_0** ] ( docs/Api/ProductSwitchApi.md#invoice_0 ) | ** GET** /api/ProductSwitch/{id}/invoice | Create invoice
232
+ * ProductSwitchApi* | [ ** revert** ] ( docs/Api/ProductSwitchApi.md#revert ) | ** GET** /api/ProductSwitches/{id}/revert | Create invoice
233
+ * ProductSwitchApi* | [ ** revert_0** ] ( docs/Api/ProductSwitchApi.md#revert_0 ) | ** GET** /api/ProductSwitch/{id}/revert | Create invoice
230
234
* ProvisionerApi* | [ ** getMany** ] ( docs/Api/ProvisionerApi.md#getmany ) | ** GET** /api/ProvisionerData | Get provisioner data
231
235
* ProvisionerApi* | [ ** getOne** ] ( docs/Api/ProvisionerApi.md#getone ) | ** GET** /api/ProvisionerData/{id} | Get provisioner data
232
236
* ProvisioningAccountApi* | [ ** setSiteForSubscription** ] ( docs/Api/ProvisioningAccountApi.md#setsiteforsubscription ) | ** POST** /api/provisioning/account/regenerate-token | Generate a new auth token
@@ -240,12 +244,11 @@ Class | Method | HTTP request | Description
240
244
* ServerCheckApi* | [ ** checkHealth** ] ( docs/Api/ServerCheckApi.md#checkhealth ) | ** GET** /server-check | Server health check
241
245
* SiteApi* | [ ** addSubscription** ] ( docs/Api/SiteApi.md#addsubscription ) | ** PUT** /api/Sites/{id}/subscriptions | Adds a subscription to a site
242
246
* SiteApi* | [ ** current** ] ( docs/Api/SiteApi.md#current ) | ** GET** /api/Sites/current | Get the current connected site for an access token.
243
- * SiteApi* | [ ** currentClone** ] ( docs/Api/SiteApi.md#currentclone ) | ** GET** /api/Sites/info | Get the current connected site for an access token .
247
+ * SiteApi* | [ ** currentClone** ] ( docs/Api/SiteApi.md#currentclone ) | ** GET** /api/Sites/info | Get the current connected site for a URL .
244
248
* SiteApi* | [ ** deleteOne** ] ( docs/Api/SiteApi.md#deleteone ) | ** DELETE** /api/Sites/{id} |
245
249
* SiteApi* | [ ** getMany** ] ( docs/Api/SiteApi.md#getmany ) | ** GET** /api/Sites | Get sites
246
250
* SiteApi* | [ ** getManyPaged** ] ( docs/Api/SiteApi.md#getmanypaged ) | ** GET** /api/Sites/paged | Get sites
247
251
* 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
249
252
* SiteApi* | [ ** index** ] ( docs/Api/SiteApi.md#index ) | ** POST** /api/Sites/index |
250
253
* SiteApi* | [ ** removeSubscription** ] ( docs/Api/SiteApi.md#removesubscription ) | ** DELETE** /api/Sites/{id}/subscriptions/{subscriptionId} | Removes a subscription from a site
251
254
* SiteApi* | [ ** switchSubscription** ] ( docs/Api/SiteApi.md#switchsubscription ) | ** POST** /api/Sites/switchSubscription | Switches the subscription for a number of times.
@@ -254,6 +257,7 @@ Class | Method | HTTP request | Description
254
257
* SiteApi* | [ ** updateSiteUrl** ] ( docs/Api/SiteApi.md#updatesiteurl ) | ** PATCH** /api/Sites/{id}/url |
255
258
* SubscriptionApi* | [ ** calculateExpansionPrice** ] ( docs/Api/SubscriptionApi.md#calculateexpansionprice ) | ** GET** /api/Subscriptions/calculateExpansionPrice/{id}/{subscriptionNumber} | Calculate expansion price
256
259
* SubscriptionApi* | [ ** deleteOne** ] ( docs/Api/SubscriptionApi.md#deleteone ) | ** DELETE** /api/Subscriptions/{id} | Delete a subscription
260
+ * SubscriptionApi* | [ ** ensureAdmissionScript** ] ( docs/Api/SubscriptionApi.md#ensureadmissionscript ) | ** GET** /api/Subscriptions/ensureAdmissions | Ensure Admission for subscriptions script
257
261
* SubscriptionApi* | [ ** forceCancel** ] ( docs/Api/SubscriptionApi.md#forcecancel ) | ** POST** /api/Subscriptions/{id}/force-cancel | Forcefully cancel a subscription
258
262
* SubscriptionApi* | [ ** getExpiringSubscriptions** ] ( docs/Api/SubscriptionApi.md#getexpiringsubscriptions ) | ** GET** /api/Subscriptions/expiring |
259
263
* SubscriptionApi* | [ ** getMany** ] ( docs/Api/SubscriptionApi.md#getmany ) | ** GET** /api/Subscriptions | Get subscriptions
@@ -268,6 +272,7 @@ Class | Method | HTTP request | Description
268
272
* SubscriptionApi* | [ ** setExpiryDate** ] ( docs/Api/SubscriptionApi.md#setexpirydate ) | ** POST** /api/Subscriptions/setExpiryDate | Set Date.
269
273
* SubscriptionApi* | [ ** switchPaymentMethod** ] ( docs/Api/SubscriptionApi.md#switchpaymentmethod ) | ** GET** /api/Subscriptions/switchPaymentMethod/{id}/{subscriptionNumber} |
270
274
* SubscriptionApi* | [ ** switchProduct** ] ( docs/Api/SubscriptionApi.md#switchproduct ) | ** POST** /api/Subscriptions/{id}/switch-product | Switch to another product
275
+ * SubscriptionApi* | [ ** switchToAutomatic** ] ( docs/Api/SubscriptionApi.md#switchtoautomatic ) | ** GET** /api/Subscriptions/enable-automatic-billing/{id}/{subscriptionNumber} |
271
276
* SubscriptionApi* | [ ** transferOwnership** ] ( docs/Api/SubscriptionApi.md#transferownership ) | ** POST** /api/Subscriptions/transfer | Transfer subscription ownership
272
277
* SubscriptionApi* | [ ** upgrade** ] ( docs/Api/SubscriptionApi.md#upgrade ) | ** GET** /api/Subscriptions/upgrade/{subscriptionNumber}/{secretKey} | Upgrade subscriptions
273
278
* SubscriptionProvisioningApi* | [ ** cancelSubscription** ] ( docs/Api/SubscriptionProvisioningApi.md#cancelsubscription ) | ** POST** /api/provisioning/subscriptions/{id}/cancel | Cancel a single subscription
@@ -320,6 +325,7 @@ Class | Method | HTTP request | Description
320
325
- [ CustomerFromWooDto] ( docs/Model/CustomerFromWooDto.md )
321
326
- [ CustomerNote] ( docs/Model/CustomerNote.md )
322
327
- [ EddDTO] ( docs/Model/EddDTO.md )
328
+ - [ EventDto] ( docs/Model/EventDto.md )
323
329
- [ ExtraCourseDataDto] ( docs/Model/ExtraCourseDataDto.md )
324
330
- [ ExtraOrderData] ( docs/Model/ExtraOrderData.md )
325
331
- [ ExtraProductData] ( docs/Model/ExtraProductData.md )
@@ -331,6 +337,8 @@ Class | Method | HTTP request | Description
331
337
- [ InviteDto] ( docs/Model/InviteDto.md )
332
338
- [ JSZip] ( docs/Model/JSZip.md )
333
339
- [ JobOptionsDto] ( docs/Model/JobOptionsDto.md )
340
+ - [ License] ( docs/Model/License.md )
341
+ - [ LicenseDTO] ( docs/Model/LicenseDTO.md )
334
342
- [ LineItemDto] ( docs/Model/LineItemDto.md )
335
343
- [ LineItemTax] ( docs/Model/LineItemTax.md )
336
344
- [ LinkSiteDto] ( docs/Model/LinkSiteDto.md )
@@ -360,6 +368,7 @@ Class | Method | HTTP request | Description
360
368
- [ Refund] ( docs/Model/Refund.md )
361
369
- [ RefundDataDto] ( docs/Model/RefundDataDto.md )
362
370
- [ RegenerateTokenResponseDto] ( docs/Model/RegenerateTokenResponseDto.md )
371
+ - [ ReleaseDetailsDto] ( docs/Model/ReleaseDetailsDto.md )
363
372
- [ RenameBodyDto] ( docs/Model/RenameBodyDto.md )
364
373
- [ ResetPasswordDto] ( docs/Model/ResetPasswordDto.md )
365
374
- [ RoleIDDto] ( docs/Model/RoleIDDto.md )
@@ -370,12 +379,10 @@ Class | Method | HTTP request | Description
370
379
- [ ShippingDto] ( docs/Model/ShippingDto.md )
371
380
- [ SignupAccountDto] ( docs/Model/SignupAccountDto.md )
372
381
- [ Site] ( docs/Model/Site.md )
373
- - [ SubscribeByEmailBodyDto] ( docs/Model/SubscribeByEmailBodyDto.md )
374
382
- [ SubscribeDto] ( docs/Model/SubscribeDto.md )
375
383
- [ Subscription] ( docs/Model/Subscription.md )
376
384
- [ SubscriptionMutation] ( docs/Model/SubscriptionMutation.md )
377
385
- [ SubscriptionProvisioningResponseDto] ( docs/Model/SubscriptionProvisioningResponseDto.md )
378
- - [ SubscriptionStatusDto] ( docs/Model/SubscriptionStatusDto.md )
379
386
- [ SwitchSubscriptionNumberOfTimesDto] ( docs/Model/SwitchSubscriptionNumberOfTimesDto.md )
380
387
- [ TOTPTwoFactorConfigDto] ( docs/Model/TOTPTwoFactorConfigDto.md )
381
388
- [ TagDto] ( docs/Model/TagDto.md )
0 commit comments