Generated client from my.yoast.test

Author: boblinthorst

.babelrc

@@ -1,8 +1,33 @@
 {
-  "plugins": [
-    ["babel-plugin-transform-builtin-extend", {
-      "globals": ["Error", "Array"]
-    }]
+  "presets": [
+    "@babel/preset-env"
   ],
-  "presets": ["env", "stage-0"]
+  "plugins": [
+    "@babel/plugin-syntax-dynamic-import",
+    "@babel/plugin-syntax-import-meta",
+    "@babel/plugin-proposal-class-properties",
+    "@babel/plugin-proposal-json-strings",
+    [
+      "@babel/plugin-proposal-decorators",
+      {
+        "legacy": true
+      }
+    ],
+    "@babel/plugin-proposal-function-sent",
+    "@babel/plugin-proposal-export-namespace-from",
+    "@babel/plugin-proposal-numeric-separator",
+    "@babel/plugin-proposal-throw-expressions",
+    "@babel/plugin-proposal-export-default-from",
+    "@babel/plugin-proposal-logical-assignment-operators",
+    "@babel/plugin-proposal-optional-chaining",
+    [
+      "@babel/plugin-proposal-pipeline-operator",
+      {
+        "proposal": "minimal"
+      }
+    ],
+    "@babel/plugin-proposal-nullish-coalescing-operator",
+    "@babel/plugin-proposal-do-expressions",
+    "@babel/plugin-proposal-function-bind"
+  ]
 }

.swagger-codegen/VERSION

@@ -1 +1 @@
-3.0.24
+3.0.26

README.md

@@ -71,101 +71,4 @@ Please follow the [installation](#installation) instruction and execute the foll
 var YoastProvisionerApiClient = require('Yoast provisioner API client');
 ```
 
-# Subscription API
-
-The subscription API can be used by Yoast partners to create subscriptions in MyYoast. Subscriptions facilitate passing license checks of yoast plugins.
-
-We have a Swagger document you can use to [explore the API](https://my.yoast.com/provisioning-api/#/). We can provide the credentials to view it.
-## Provisioner
-
-A provisioner is a yoast partner allowed to create subscriptions in MyYoast.
-
-We create an account for each provisioner, and with the credentials for that account, the provisioners can call the API endpoints.
-
-The API uses basic auth. If you are a provisioner and do not yet have the proper credentials to call the provisioning API, please contact us.
-
-## Client API
-
-To assist provisioners we have used [swagger-codegen](https://swagger.io/docs/open-source-tools/swagger-codegen/) to generate clients for the API. There's:
-
-- [PHP client](https://github.com/Yoast/subscription-api-php-client)
-   - [With additional documentation](https://github.com/Yoast/subscription-api-php-client/blob/master/docs/Api/SubscriptionProvisioningApi.md)
-- [javascript client](https://github.com/Yoast/subscription-api-javascript-client)
-
-The readme of these clients should explain how to install and use them.
-
-## Subscription
-
-A subscription gives a site a valid license for a plugin on the site of the customer's choice, for a set amount of time.
-
-### Subscription statuses
-
-There are four possible statuses a subscription can have:
-
-- `active`: This subscription is active, will be set to `expired` when the end date has passed.
-- `pending-cancel`: The customer has manually cancelled their subscription. The subscription will not be renewed, and will be set to `cancelled` when the end date has passed.
-- `cancelled`: The subscription has been cancelled, and no longer provides a valid license.
-- `expired`: The subscription's end date has passed without renewing, and no longer provides a valid license.
-
-### Creating subscriptions
-
-You can use the [create endpoint](https://my.yoast.com/provisioning-api/#/Subscription%20Provisioning/post_api_provisioning_subscriptions_create) to create a new subscription.
-
-When creating a subscription, you should send along the site the customer wants to connect their subscription to. A subscription acts as a valid license for its connected site.
-
-If you know the first name and last name of the customer, you should send them along as well. We use the names to address our customer in communication.
-
-When a subscription is created, a MyYoast account is created for the customer if they didn't have an account already. With this account, the customer can access Yoast SEO Academy and its premium content.
-We will then create the subscription for the customer, and return this new subscription as the response to the API call.
-If the customer account is new, the customer will also receive an email informing them that an account has been created for them, and that they can set a password.
-
-If the subscription should give the user access to courses (such as a Yoast SEO Premium subscription), these courses can be accessed via MyYoast in the [courses tab](https://my.yoast.com/courses).
-
-### Renewing subscriptions
-
-You can use the [renew endpoint](https://my.yoast.com/provisioning-api/#/Subscription%20Provisioning/post_api_provisioning_subscriptions__id__renew) to renew an existing subscription.
-
-Renewing a subscription extends the subscription duration. The amount of time the subscription is extended by depends on the product.
-Most products give access for one year. Some products give access for a month. This is or will be configured for your provisioner account.
-
-Renewing a subscription sets the end date of the subscription to a new date further in the future.
-If the end date of a subscription is in the past, the amount of extra time is added to the date of the request instead.
-
-**Cancelled subscriptions can no longer be renewed.**
-
-#### Cancelling subscriptions
-
-If it is known that a customer will not renew their subscription or if the customer should no longer have their subscription, the [cancel endpoint](https://my.yoast.com/provisioning-api/#/Subscription%20Provisioning/post_api_provisioning_subscriptions__id__cancel) should be used.
-
-The status of that subscription will be set to `pending-cancel`. It's still a valid license until the end date passes, then it will be set to `cancelled`.
-
-If the customer should lose access immediately. you can set `immediately` to `true` in the body. In this case, the subscription is set to `cancelled` immediately, regardless of the amount of time the subscription had remaining. The subscription is no longer considered a valid license when it has the `cancelled` status.
-
-### Subscription expiration and cancellation.
-
-If a subscription's end date has passed, that subscription is due for expiration.
-
-If the subscription's status is `active`, the subscription's status will be set to `expired`, and the subscription is no longer considered a valid license. We have a CRON job in my-yoast responsible for this. This is done automatically every 30 minutes..
-
-The same applies for subscriptions that are `pending-cancel`, and whose end date has passed. These subscriptions will be set to `cancelled`.
-
-## License checks
-
-The Yoast plugin on the site of the customer sends a request on visiting the plugin page or the premium settings page, to check whether the site has a valid license for that plugin. This request is cached.
-
-A site has a valid license for a product when the site has any connected `active` or `pending-cancel` subscription in MyYoast, that grants access to that product.
-
-The response of the license check will always include a download url for the latest version of the plugins the user has access to.
-
-### Connecting a site to subscriptions.
-
-You can connect a site to a subscription on creation of that subscription, or use the [set-site endpoint](https://my.yoast.com/provisioning-api/#/Subscription%20Provisioning/post_api_provisioning_subscriptions__id__set_site) of the API.
-
-## Getting the plugin
-
-After a customer gets a subscription, that customer will get access to the connected product.
-
-Any plugins the customer should get access to can be downloaded. The download URLS for a subscription are always present in any response to the subscription API.
-
-If the subscription should give the user access to courses (such as a subscription for the Yoast SEO Premium plugin), these courses can be accessed via MyYoast on the [courses page](https://my.yoast.com/courses).
-We will also send an email to the customer when the customer gets access to any of our courses. If a customer gains access to multiple courses at once, a single email is sent containing a notice of all the courses that are accessible.
+Documentation on how to use the subscription API, can be found [in the developer docs.](https://developer.yoast.com/customization/myyoast/apis/subscription-api)

docs/ProvisioningAccountApi.md

@@ -1,6 +1,6 @@
 # YoastProvisionerApiClient.ProvisioningAccountApi
 
-All URIs are relative to *http://my.yoast.test:3000/*
+All URIs are relative to *https://my.yoast.test:3000/*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -16,7 +16,7 @@ This route generate a new Basic Auth token that is used for provisioner accounts
 
 ### Example
 ```javascript
-import YoastProvisionerApiClient from 'Yoast provisioner API client';
+import {YoastProvisionerApiClient} from 'Yoast provisioner API client';
 
 let apiInstance = new YoastProvisionerApiClient.ProvisioningAccountApi();
 apiInstance.apiProvisioningAccountRegenerateTokenPost((error, data, response) => {

docs/ProvisioningDownloadsApi.md

@@ -1,6 +1,6 @@
 # YoastProvisionerApiClient.ProvisioningDownloadsApi
 
-All URIs are relative to *http://my.yoast.test:3000/*
+All URIs are relative to *https://my.yoast.test:3000/*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -17,7 +17,7 @@ This route returns the latest version of the product that is offered to the cust
 
 ### Example
 ```javascript
-import YoastProvisionerApiClient from 'Yoast provisioner API client';
+import {YoastProvisionerApiClient} from 'Yoast provisioner API client';
 
 let apiInstance = new YoastProvisionerApiClient.ProvisioningDownloadsApi();
 let productCode = "productCode_example"; // String | The code used to create the product.
@@ -52,15 +52,15 @@ No authorization required
 
 <a name="apiProvisioningDownloadsCurrentZipGet"></a>
 # **apiProvisioningDownloadsCurrentZipGet**
-> &#x27;String&#x27; apiProvisioningDownloadsCurrentZipGet(productCode)
+> apiProvisioningDownloadsCurrentZipGet(productCode)
 
 Redirect to the current zip for the productCode.
 
 If a new version is available, you can use this route to redirect to the zip of that new version of the product.
 
 ### Example
 ```javascript
-import YoastProvisionerApiClient from 'Yoast provisioner API client';
+import {YoastProvisionerApiClient} from 'Yoast provisioner API client';
 
 let apiInstance = new YoastProvisionerApiClient.ProvisioningDownloadsApi();
 let productCode = "productCode_example"; // String | The code used to create the product.
@@ -69,7 +69,7 @@ apiInstance.apiProvisioningDownloadsCurrentZipGet(productCode, (error, data, res
   if (error) {
     console.error(error);
   } else {
-    console.log('API called successfully. Returned data: ' + data);
+    console.log('API called successfully.');
   }
 });
 ```
@@ -82,7 +82,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-**&#x27;String&#x27;**
+null (empty response body)
 
 ### Authorization
 
@@ -91,5 +91,5 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: Not defined
 

docs/ProvisioningUsersApi.md

@@ -0,0 +1,51 @@
+# YoastProvisionerApiClient.ProvisioningUsersApi
+
+All URIs are relative to *https://my.yoast.test:3000/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**apiProvisioningUserScheduleDeletePost**](ProvisioningUsersApi.md#apiProvisioningUserScheduleDeletePost) | **POST** /api/provisioning/user/schedule-delete | Schedule a delete for a subscription
+
+<a name="apiProvisioningUserScheduleDeletePost"></a>
+# **apiProvisioningUserScheduleDeletePost**
+> SubscriptionProvisioningResponseDto apiProvisioningUserScheduleDeletePost(body)
+
+Schedule a delete for a subscription
+
+Schedules a customer for gdpr delete.
+
+### Example
+```javascript
+import {YoastProvisionerApiClient} from 'Yoast provisioner API client';
+
+let apiInstance = new YoastProvisionerApiClient.ProvisioningUsersApi();
+let body = new YoastProvisionerApiClient.ScheduleDeleteUserDto(); // ScheduleDeleteUserDto | 
+
+apiInstance.apiProvisioningUserScheduleDeletePost(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ScheduleDeleteUserDto**](ScheduleDeleteUserDto.md)|  | 
+
+### Return type
+
+[**SubscriptionProvisioningResponseDto**](SubscriptionProvisioningResponseDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+