Skip to content

Commit 0ff2843

Browse files
committed
Generated client from my.yoast.test
1 parent 6fe970b commit 0ff2843

File tree

357 files changed

+8138
-8143
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

357 files changed

+8138
-8143
lines changed

README.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ try {
9090

9191
## Documentation for API Endpoints
9292

93-
All URIs are relative to *http://my.yoast.test:3000*
93+
All URIs are relative to *https://my.yoast.test*
9494

9595
Class | Method | HTTP request | Description
9696
------------ | ------------- | ------------- | -------------
@@ -159,6 +159,7 @@ Class | Method | HTTP request | Description
159159
*CustomerApi* | [**getMany_3**](docs/Api/CustomerApi.md#getmany_3) | **GET** /api/Customers/{id}/roles |
160160
*CustomerApi* | [**getMany_4**](docs/Api/CustomerApi.md#getmany_4) | **GET** /api/Customers/{customerId}/identities | Get user identities
161161
*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
162163
*CustomerApi* | [**getOne**](docs/Api/CustomerApi.md#getone) | **GET** /api/Customers/{customerId}/composerTokens/{id} | Get a composer token
163164
*CustomerApi* | [**getOne_0**](docs/Api/CustomerApi.md#getone_0) | **GET** /api/Customers/{customerId}/subscriptions/{id} | Get a subscriptions
164165
*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
170171
*CustomerApi* | [**resetPassword**](docs/Api/CustomerApi.md#resetpassword) | **PATCH** /api/Customers/resetPassword | Reset the user's password.
171172
*CustomerApi* | [**sendResetPasswordEmail**](docs/Api/CustomerApi.md#sendresetpasswordemail) | **POST** /api/Customers/sendResetPasswordEmail | Send a reset password email to the user.
172173
*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
177174
*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
179175
*CustomerNoteApi* | [**createOne**](docs/Api/CustomerNoteApi.md#createone) | **POST** /api/CustomerNotes |
180176
*CustomerNoteApi* | [**deleteOne**](docs/Api/CustomerNoteApi.md#deleteone) | **DELETE** /api/CustomerNotes/{id} |
181177
*CustomerNoteApi* | [**getMany**](docs/Api/CustomerNoteApi.md#getmany) | **GET** /api/CustomerNotes | Get customer notes
@@ -194,6 +190,10 @@ Class | Method | HTTP request | Description
194190
*FromWooCommerceApi* | [**productGroupFromWooCommerce**](docs/Api/FromWooCommerceApi.md#productgroupfromwoocommerce) | **PUT** /api/ProductGroups/fromWooCommerce | Sync products to MyYoast.
195191
*GDPRApi* | [**deleteCustomer**](docs/Api/GDPRApi.md#deletecustomer) | **DELETE** /api/Customers/{id}/gdpr-delete | Performs a \"GDPR forget me\" request.
196192
*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 |
197197
*MailingListApi* | [**checkGetRoute**](docs/Api/MailingListApi.md#checkgetroute) | **GET** /api/Mailing-list/newsletter/tZhjyjwsYFUMPzNNhJaVADZZIrixRSbXOFgptZJyyK |
198198
*MailingListApi* | [**getStatus**](docs/Api/MailingListApi.md#getstatus) | **GET** /api/Mailing-list/status | Get the subscription status.
199199
*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
224224
*ProductApi* | [**getOne**](docs/Api/ProductApi.md#getone) | **GET** /api/Products/{id} | Get a product
225225
*ProductApi* | [**pluginVersionDetails**](docs/Api/ProductApi.md#pluginversiondetails) | **GET** /api/Products/wordpressPluginVersionDetails |
226226
*ProductGroupApi* | [**getMany**](docs/Api/ProductGroupApi.md#getmany) | **GET** /api/ProductGroups | Get productgroups
227+
*ProductGroupApi* | [**getReleaseDetails**](docs/Api/ProductGroupApi.md#getreleasedetails) | **GET** /api/ProductGroups/releaseDetails |
227228
*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
230234
*ProvisionerApi* | [**getMany**](docs/Api/ProvisionerApi.md#getmany) | **GET** /api/ProvisionerData | Get provisioner data
231235
*ProvisionerApi* | [**getOne**](docs/Api/ProvisionerApi.md#getone) | **GET** /api/ProvisionerData/{id} | Get provisioner data
232236
*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
240244
*ServerCheckApi* | [**checkHealth**](docs/Api/ServerCheckApi.md#checkhealth) | **GET** /server-check | Server health check
241245
*SiteApi* | [**addSubscription**](docs/Api/SiteApi.md#addsubscription) | **PUT** /api/Sites/{id}/subscriptions | Adds a subscription to a site
242246
*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.
244248
*SiteApi* | [**deleteOne**](docs/Api/SiteApi.md#deleteone) | **DELETE** /api/Sites/{id} |
245249
*SiteApi* | [**getMany**](docs/Api/SiteApi.md#getmany) | **GET** /api/Sites | Get sites
246250
*SiteApi* | [**getManyPaged**](docs/Api/SiteApi.md#getmanypaged) | **GET** /api/Sites/paged | Get sites
247251
*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
249252
*SiteApi* | [**index**](docs/Api/SiteApi.md#index) | **POST** /api/Sites/index |
250253
*SiteApi* | [**removeSubscription**](docs/Api/SiteApi.md#removesubscription) | **DELETE** /api/Sites/{id}/subscriptions/{subscriptionId} | Removes a subscription from a site
251254
*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
254257
*SiteApi* | [**updateSiteUrl**](docs/Api/SiteApi.md#updatesiteurl) | **PATCH** /api/Sites/{id}/url |
255258
*SubscriptionApi* | [**calculateExpansionPrice**](docs/Api/SubscriptionApi.md#calculateexpansionprice) | **GET** /api/Subscriptions/calculateExpansionPrice/{id}/{subscriptionNumber} | Calculate expansion price
256259
*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
257261
*SubscriptionApi* | [**forceCancel**](docs/Api/SubscriptionApi.md#forcecancel) | **POST** /api/Subscriptions/{id}/force-cancel | Forcefully cancel a subscription
258262
*SubscriptionApi* | [**getExpiringSubscriptions**](docs/Api/SubscriptionApi.md#getexpiringsubscriptions) | **GET** /api/Subscriptions/expiring |
259263
*SubscriptionApi* | [**getMany**](docs/Api/SubscriptionApi.md#getmany) | **GET** /api/Subscriptions | Get subscriptions
@@ -268,6 +272,7 @@ Class | Method | HTTP request | Description
268272
*SubscriptionApi* | [**setExpiryDate**](docs/Api/SubscriptionApi.md#setexpirydate) | **POST** /api/Subscriptions/setExpiryDate | Set Date.
269273
*SubscriptionApi* | [**switchPaymentMethod**](docs/Api/SubscriptionApi.md#switchpaymentmethod) | **GET** /api/Subscriptions/switchPaymentMethod/{id}/{subscriptionNumber} |
270274
*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} |
271276
*SubscriptionApi* | [**transferOwnership**](docs/Api/SubscriptionApi.md#transferownership) | **POST** /api/Subscriptions/transfer | Transfer subscription ownership
272277
*SubscriptionApi* | [**upgrade**](docs/Api/SubscriptionApi.md#upgrade) | **GET** /api/Subscriptions/upgrade/{subscriptionNumber}/{secretKey} | Upgrade subscriptions
273278
*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
320325
- [CustomerFromWooDto](docs/Model/CustomerFromWooDto.md)
321326
- [CustomerNote](docs/Model/CustomerNote.md)
322327
- [EddDTO](docs/Model/EddDTO.md)
328+
- [EventDto](docs/Model/EventDto.md)
323329
- [ExtraCourseDataDto](docs/Model/ExtraCourseDataDto.md)
324330
- [ExtraOrderData](docs/Model/ExtraOrderData.md)
325331
- [ExtraProductData](docs/Model/ExtraProductData.md)
@@ -331,6 +337,8 @@ Class | Method | HTTP request | Description
331337
- [InviteDto](docs/Model/InviteDto.md)
332338
- [JSZip](docs/Model/JSZip.md)
333339
- [JobOptionsDto](docs/Model/JobOptionsDto.md)
340+
- [License](docs/Model/License.md)
341+
- [LicenseDTO](docs/Model/LicenseDTO.md)
334342
- [LineItemDto](docs/Model/LineItemDto.md)
335343
- [LineItemTax](docs/Model/LineItemTax.md)
336344
- [LinkSiteDto](docs/Model/LinkSiteDto.md)
@@ -360,6 +368,7 @@ Class | Method | HTTP request | Description
360368
- [Refund](docs/Model/Refund.md)
361369
- [RefundDataDto](docs/Model/RefundDataDto.md)
362370
- [RegenerateTokenResponseDto](docs/Model/RegenerateTokenResponseDto.md)
371+
- [ReleaseDetailsDto](docs/Model/ReleaseDetailsDto.md)
363372
- [RenameBodyDto](docs/Model/RenameBodyDto.md)
364373
- [ResetPasswordDto](docs/Model/ResetPasswordDto.md)
365374
- [RoleIDDto](docs/Model/RoleIDDto.md)
@@ -370,12 +379,10 @@ Class | Method | HTTP request | Description
370379
- [ShippingDto](docs/Model/ShippingDto.md)
371380
- [SignupAccountDto](docs/Model/SignupAccountDto.md)
372381
- [Site](docs/Model/Site.md)
373-
- [SubscribeByEmailBodyDto](docs/Model/SubscribeByEmailBodyDto.md)
374382
- [SubscribeDto](docs/Model/SubscribeDto.md)
375383
- [Subscription](docs/Model/Subscription.md)
376384
- [SubscriptionMutation](docs/Model/SubscriptionMutation.md)
377385
- [SubscriptionProvisioningResponseDto](docs/Model/SubscriptionProvisioningResponseDto.md)
378-
- [SubscriptionStatusDto](docs/Model/SubscriptionStatusDto.md)
379386
- [SwitchSubscriptionNumberOfTimesDto](docs/Model/SwitchSubscriptionNumberOfTimesDto.md)
380387
- [TOTPTwoFactorConfigDto](docs/Model/TOTPTwoFactorConfigDto.md)
381388
- [TagDto](docs/Model/TagDto.md)

composer.json

+6-5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"swagger",
66
"php",
77
"sdk",
8+
"rest",
89
"api"
910
],
1011
"homepage": "http://swagger.io",
@@ -16,16 +17,16 @@
1617
}
1718
],
1819
"require": {
19-
"php": ">=5.5",
20+
"php": "^7.4 || ^8.0",
2021
"ext-curl": "*",
2122
"ext-json": "*",
2223
"ext-mbstring": "*",
23-
"guzzlehttp/guzzle": "^6.2"
24+
"guzzlehttp/guzzle": "^7.3",
25+
"guzzlehttp/psr7": "^1.7 || ^2.0"
2426
},
2527
"require-dev": {
26-
"phpunit/phpunit": "^4.8",
27-
"squizlabs/php_codesniffer": "~2.6",
28-
"friendsofphp/php-cs-fixer": "~1.12"
28+
"phpunit/phpunit": "^8.0 || ^9.0",
29+
"friendsofphp/php-cs-fixer": "^3.5"
2930
},
3031
"autoload": {
3132
"psr-4": { "Yoast\\MyYoastApiClient\\" : "src/" }

docs/Api/AccountsApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yoast\MyYoastApiClient\AccountsApi
22

3-
All URIs are relative to *http://my.yoast.test:3000*
3+
All URIs are relative to *https://my.yoast.test*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/Api/AdmissionApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yoast\MyYoastApiClient\AdmissionApi
22

3-
All URIs are relative to *http://my.yoast.test:3000*
3+
All URIs are relative to *https://my.yoast.test*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/Api/AuthApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yoast\MyYoastApiClient\AuthApi
22

3-
All URIs are relative to *http://my.yoast.test:3000*
3+
All URIs are relative to *https://my.yoast.test*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/Api/AuthenticationApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yoast\MyYoastApiClient\AuthenticationApi
22

3-
All URIs are relative to *http://my.yoast.test:3000*
3+
All URIs are relative to *https://my.yoast.test*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/Api/BlacklistApi.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yoast\MyYoastApiClient\BlacklistApi
22

3-
All URIs are relative to *http://my.yoast.test:3000*
3+
All URIs are relative to *https://my.yoast.test*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
@@ -10,7 +10,7 @@ Method | HTTP request | Description
1010
[**getManyPaged**](BlacklistApi.md#getmanypaged) | **GET** /api/Blacklist/paged | Gets blacklisted sites
1111

1212
# **createOne**
13-
> \Yoast\MyYoastApiClient\Model\ createOne($body)
13+
> string createOne($body)
1414
1515
Creates a blacklisted site
1616

@@ -50,7 +50,7 @@ Name | Type | Description | Notes
5050

5151
### Return type
5252

53-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
53+
**string**
5454

5555
### Authorization
5656

@@ -64,7 +64,7 @@ Name | Type | Description | Notes
6464
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
6565

6666
# **deleteOne**
67-
> \Yoast\MyYoastApiClient\Model\ deleteOne($id)
67+
> string deleteOne($id)
6868
6969
Remove a site from the blacklist
7070

@@ -104,7 +104,7 @@ Name | Type | Description | Notes
104104

105105
### Return type
106106

107-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
107+
**string**
108108

109109
### Authorization
110110

docs/Api/CloudflareApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yoast\MyYoastApiClient\CloudflareApi
22

3-
All URIs are relative to *http://my.yoast.test:3000*
3+
All URIs are relative to *https://my.yoast.test*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/Api/ComposerTokenApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yoast\MyYoastApiClient\ComposerTokenApi
22

3-
All URIs are relative to *http://my.yoast.test:3000*
3+
All URIs are relative to *https://my.yoast.test*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/Api/CourseApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yoast\MyYoastApiClient\CourseApi
22

3-
All URIs are relative to *http://my.yoast.test:3000*
3+
All URIs are relative to *https://my.yoast.test*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/Api/CourseEnrollmentApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yoast\MyYoastApiClient\CourseEnrollmentApi
22

3-
All URIs are relative to *http://my.yoast.test:3000*
3+
All URIs are relative to *https://my.yoast.test*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

0 commit comments

Comments
 (0)