Skip to content

Commit d2f4646

Browse files
diedexxdiedexx
committed
Generated client from my.yoast.test
1 parent a019616 commit d2f4646

18 files changed

+1270
-133
lines changed

‎README.md

+3
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,7 @@ Class | Method | HTTP request | Description
347347
- [AcademyCourseAccessListDto](docs/Model/AcademyCourseAccessListDto.md)
348348
- [AccessTokenResponse](docs/Model/AccessTokenResponse.md)
349349
- [ActivateAccountDto](docs/Model/ActivateAccountDto.md)
350+
- [ActivateAccountResponseDto](docs/Model/ActivateAccountResponseDto.md)
350351
- [AddAgencyDto](docs/Model/AddAgencyDto.md)
351352
- [AddJobDto](docs/Model/AddJobDto.md)
352353
- [AddOwnerToAgencyDto](docs/Model/AddOwnerToAgencyDto.md)
@@ -434,6 +435,7 @@ Class | Method | HTTP request | Description
434435
- [SubscribeDto](docs/Model/SubscribeDto.md)
435436
- [Subscription](docs/Model/Subscription.md)
436437
- [SubscriptionProvisioningResponseDto](docs/Model/SubscriptionProvisioningResponseDto.md)
438+
- [SubscriptionStatusDto](docs/Model/SubscriptionStatusDto.md)
437439
- [SwitchSubscriptionNumberOfTimesDto](docs/Model/SwitchSubscriptionNumberOfTimesDto.md)
438440
- [TOTPTwoFactorConfigDto](docs/Model/TOTPTwoFactorConfigDto.md)
439441
- [TagDto](docs/Model/TagDto.md)
@@ -445,6 +447,7 @@ Class | Method | HTTP request | Description
445447
- [TransferOwnershipDto](docs/Model/TransferOwnershipDto.md)
446448
- [TransferSiteDto](docs/Model/TransferSiteDto.md)
447449
- [TwoFactorConfigDto](docs/Model/TwoFactorConfigDto.md)
450+
- [UnspecifiedResponseDto](docs/Model/UnspecifiedResponseDto.md)
448451
- [UnsubscribeDto](docs/Model/UnsubscribeDto.md)
449452
- [UpdateAgencyDto](docs/Model/UpdateAgencyDto.md)
450453
- [UpdateAllKVRequestDto](docs/Model/UpdateAllKVRequestDto.md)

‎docs/Api/CustomerApi.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Method | HTTP request | Description
5050
[**uploadAvatar**](CustomerApi.md#uploadavatar) | **POST** /api/Customers/{id}/avatar | Upload a new UserAvatar to WordPress
5151

5252
# **activate**
53-
> \Yoast\MyYoastApiClient\Model\ activate($body)
53+
> \Yoast\MyYoastApiClient\Model\ActivateAccountResponseDto activate($body)
5454
5555
Activate the account of a user
5656

@@ -85,7 +85,7 @@ Name | Type | Description | Notes
8585

8686
### Return type
8787

88-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
88+
[**\Yoast\MyYoastApiClient\Model\ActivateAccountResponseDto**](../Model/ActivateAccountResponseDto.md)
8989

9090
### Authorization
9191

@@ -147,7 +147,7 @@ No authorization required
147147
[[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)
148148

149149
# **cancelSubscription**
150-
> \Yoast\MyYoastApiClient\Model\ cancelSubscription($body, $customerId, $id)
150+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto cancelSubscription($body, $customerId, $id)
151151
152152
Cancel (part of) a subscription.
153153

@@ -186,7 +186,7 @@ Name | Type | Description | Notes
186186

187187
### Return type
188188

189-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
189+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
190190

191191
### Authorization
192192

@@ -297,7 +297,7 @@ No authorization required
297297
[[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)
298298

299299
# **createAccount**
300-
> \Yoast\MyYoastApiClient\Model\ createAccount($body)
300+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto createAccount($body)
301301
302302
Creates an account for a customer on yoast.com without the signup flow.
303303

@@ -332,7 +332,7 @@ Name | Type | Description | Notes
332332

333333
### Return type
334334

335-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
335+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
336336

337337
### Authorization
338338

@@ -586,7 +586,7 @@ No authorization required
586586
[[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)
587587

588588
# **enable**
589-
> \Yoast\MyYoastApiClient\Model\ enable($id)
589+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto enable($id)
590590
591591
Enables the customer with the given ID
592592

@@ -621,7 +621,7 @@ Name | Type | Description | Notes
621621

622622
### Return type
623623

624-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
624+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
625625

626626
### Authorization
627627

@@ -684,7 +684,7 @@ No authorization required
684684
[[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)
685685

686686
# **getAllRoles**
687-
> \Yoast\MyYoastApiClient\Model\ getAllRoles()
687+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto getAllRoles()
688688
689689
Get all existing roles with their ID.
690690

@@ -713,7 +713,7 @@ This endpoint does not need any parameter.
713713

714714
### Return type
715715

716-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
716+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
717717

718718
### Authorization
719719

@@ -1729,7 +1729,7 @@ No authorization required
17291729
[[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)
17301730

17311731
# **profile**
1732-
> \Yoast\MyYoastApiClient\Model\ profile($id)
1732+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto profile($id)
17331733
17341734

17351735

@@ -1762,7 +1762,7 @@ Name | Type | Description | Notes
17621762

17631763
### Return type
17641764

1765-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
1765+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
17661766

17671767
### Authorization
17681768

@@ -1776,7 +1776,7 @@ No authorization required
17761776
[[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)
17771777

17781778
# **resetPassword**
1779-
> \Yoast\MyYoastApiClient\Model\ resetPassword($body)
1779+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto resetPassword($body)
17801780
17811781
Reset the user's password.
17821782

@@ -1811,7 +1811,7 @@ Name | Type | Description | Notes
18111811

18121812
### Return type
18131813

1814-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
1814+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
18151815

18161816
### Authorization
18171817

@@ -1825,7 +1825,7 @@ No authorization required
18251825
[[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)
18261826

18271827
# **sendResetPasswordEmail**
1828-
> \Yoast\MyYoastApiClient\Model\ sendResetPasswordEmail($body)
1828+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto sendResetPasswordEmail($body)
18291829
18301830
Send a reset password email to the user.
18311831

@@ -1860,7 +1860,7 @@ Name | Type | Description | Notes
18601860

18611861
### Return type
18621862

1863-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
1863+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
18641864

18651865
### Authorization
18661866

@@ -1874,7 +1874,7 @@ No authorization required
18741874
[[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)
18751875

18761876
# **signup**
1877-
> \Yoast\MyYoastApiClient\Model\ signup($body)
1877+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto signup($body)
18781878
18791879
Signup a customer on yoast.com following the normal signup flow.
18801880

@@ -1909,7 +1909,7 @@ Name | Type | Description | Notes
19091909

19101910
### Return type
19111911

1912-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
1912+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
19131913

19141914
### Authorization
19151915

@@ -1923,7 +1923,7 @@ No authorization required
19231923
[[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)
19241924

19251925
# **status**
1926-
> \Yoast\MyYoastApiClient\Model\ status($customerId)
1926+
> \Yoast\MyYoastApiClient\Model\SubscriptionStatusDto status($customerId)
19271927
19281928
Newsletter subscription status
19291929

@@ -1956,7 +1956,7 @@ Name | Type | Description | Notes
19561956

19571957
### Return type
19581958

1959-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
1959+
[**\Yoast\MyYoastApiClient\Model\SubscriptionStatusDto**](../Model/SubscriptionStatusDto.md)
19601960

19611961
### Authorization
19621962

@@ -1970,7 +1970,7 @@ No authorization required
19701970
[[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)
19711971

19721972
# **subscribe**
1973-
> \Yoast\MyYoastApiClient\Model\ subscribe($customerId)
1973+
> \Yoast\MyYoastApiClient\Model\SubscriptionStatusDto subscribe($customerId)
19741974
19751975
Subscribe to the newsletter
19761976

@@ -2003,7 +2003,7 @@ Name | Type | Description | Notes
20032003

20042004
### Return type
20052005

2006-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
2006+
[**\Yoast\MyYoastApiClient\Model\SubscriptionStatusDto**](../Model/SubscriptionStatusDto.md)
20072007

20082008
### Authorization
20092009

@@ -2017,7 +2017,7 @@ No authorization required
20172017
[[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)
20182018

20192019
# **subscribeByEmail**
2020-
> \Yoast\MyYoastApiClient\Model\ subscribeByEmail($body, $list)
2020+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto subscribeByEmail($body, $list)
20212021
20222022
Subscribes a user to a newsletter
20232023

@@ -2054,7 +2054,7 @@ Name | Type | Description | Notes
20542054

20552055
### Return type
20562056

2057-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
2057+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
20582058

20592059
### Authorization
20602060

@@ -2068,7 +2068,7 @@ No authorization required
20682068
[[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)
20692069

20702070
# **unsubscribe**
2071-
> \Yoast\MyYoastApiClient\Model\ unsubscribe($customerId)
2071+
> \Yoast\MyYoastApiClient\Model\SubscriptionStatusDto unsubscribe($customerId)
20722072
20732073
Unsubscribe from the newsletter
20742074

@@ -2101,7 +2101,7 @@ Name | Type | Description | Notes
21012101

21022102
### Return type
21032103

2104-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
2104+
[**\Yoast\MyYoastApiClient\Model\SubscriptionStatusDto**](../Model/SubscriptionStatusDto.md)
21052105

21062106
### Authorization
21072107

‎docs/Api/DownloadApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ No authorization required
6262
[[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)
6363

6464
# **uploadFile**
65-
> \Yoast\MyYoastApiClient\Model\ uploadFile($body, $name)
65+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto uploadFile($body, $name)
6666
6767
Route to update a file.
6868

@@ -99,7 +99,7 @@ Name | Type | Description | Notes
9999

100100
### Return type
101101

102-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
102+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
103103

104104
### Authorization
105105

‎docs/Api/HelpscoutApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Method | HTTP request | Description
77
[**helpscout**](HelpscoutApi.md#helpscout) | **POST** /helpscout | Get information about a customer
88

99
# **helpscout**
10-
> \Yoast\MyYoastApiClient\Model\ helpscout($body, $xHelpScoutSignature)
10+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto helpscout($body, $xHelpScoutSignature)
1111
1212
Get information about a customer
1313

@@ -44,7 +44,7 @@ Name | Type | Description | Notes
4444

4545
### Return type
4646

47-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
47+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
4848

4949
### Authorization
5050

‎docs/Api/SiteApi.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ No authorization required
6969
[[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)
7070

7171
# **current**
72-
> \Yoast\MyYoastApiClient\Model\ current($token, $url)
72+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto current($token, $url)
7373
7474
Get the current connected site for an access token.
7575

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

105105
### Return type
106106

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

109109
### Authorization
110110

@@ -118,7 +118,7 @@ No authorization required
118118
[[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)
119119

120120
# **currentClone**
121-
> \Yoast\MyYoastApiClient\Model\ currentClone($token, $url)
121+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto currentClone($token, $url)
122122
123123
Get the current connected site for an access token.
124124

@@ -153,7 +153,7 @@ Name | Type | Description | Notes
153153

154154
### Return type
155155

156-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
156+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
157157

158158
### Authorization
159159

@@ -410,7 +410,7 @@ No authorization required
410410
[[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)
411411

412412
# **index**
413-
> \Yoast\MyYoastApiClient\Model\ index($token, $url, $method)
413+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto index($token, $url, $method)
414414
415415

416416

@@ -447,7 +447,7 @@ Name | Type | Description | Notes
447447

448448
### Return type
449449

450-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
450+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
451451

452452
### Authorization
453453

@@ -559,7 +559,7 @@ No authorization required
559559
[[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)
560560

561561
# **switchSubscriptionNumberOfTimes**
562-
> \Yoast\MyYoastApiClient\Model\ switchSubscriptionNumberOfTimes($body)
562+
> \Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto switchSubscriptionNumberOfTimes($body)
563563
564564
Switches the subscription for a number of times.
565565

@@ -594,7 +594,7 @@ Name | Type | Description | Notes
594594

595595
### Return type
596596

597-
[**\Yoast\MyYoastApiClient\Model\**](../Model/.md)
597+
[**\Yoast\MyYoastApiClient\Model\UnspecifiedResponseDto**](../Model/UnspecifiedResponseDto.md)
598598

599599
### Authorization
600600

‎docs/Model/ActivateAccountResponseDto.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ActivateAccountResponseDto
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**error** | **object** | | [optional]
7+
8+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
9+

‎docs/Model/SubscriptionStatusDto.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SubscriptionStatusDto
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**subscribed** | **string** | |
7+
8+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
9+

‎docs/Model/UnspecifiedResponseDto.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# UnspecifiedResponseDto
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
8+

0 commit comments

Comments
 (0)