Skip to content

Commit 2e52734

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 277b373 commit 2e52734

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

oas/api/openapi.yaml

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8577,7 +8577,9 @@ paths:
85778577
- "manage_customers:{projectKey}"
85788578
operationId: ByProjectKeyCustomersEmailTokenPost
85798579
description: |-
8580-
Produces the [CustomerEmailTokenCreated](ctp:api:type:CustomerEmailTokenCreatedMessage) Message.
8580+
Use this method to create an email token for a global Customer during their [email verification process](/../api/customers-overview#customer-email-verification).
8581+
8582+
Creating an email token for the Customer produces the [CustomerEmailTokenCreated](ctp:api:type:CustomerEmailTokenCreatedMessage) Message.
85818583
requestBody:
85828584
content:
85838585
application/json:
@@ -8624,6 +8626,8 @@ paths:
86248626
- oauth_2_0:
86258627
- "view_customers:{projectKey}"
86268628
operationId: ByProjectKeyCustomersEmailTokenByEmailTokenGet
8629+
description: |-
8630+
Use this method to retrieve a global Customer's details by using the email token during their [email verification process](/../api/customers-overview#customer-email-verification).
86278631
parameters:
86288632
- name: expand
86298633
in: query
@@ -8670,6 +8674,8 @@ paths:
86708674
- "manage_customers:{projectKey}"
86718675
operationId: ByProjectKeyCustomersEmailConfirmPost
86728676
description: |-
8677+
Use this method to verify a global Customer's email during their [email verification process](/../api/customers-overview#customer-email-verification).
8678+
86738679
Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message.
86748680
requestBody:
86758681
content:
@@ -8939,6 +8945,10 @@ paths:
89398945
- oauth_2_0:
89408946
- "manage_customers:{projectKey}"
89418947
operationId: ByProjectKeyCustomersPasswordTokenPost
8948+
description: |-
8949+
Use this method to create a password reset token for a global Customer during their [password reset process](/../api/customers-overview#customer-password-reset).
8950+
8951+
Creating a password reset token does not invalidate existing tokens.
89428952
requestBody:
89438953
content:
89448954
application/json:
@@ -8985,6 +8995,8 @@ paths:
89858995
- oauth_2_0:
89868996
- "view_customers:{projectKey}"
89878997
operationId: ByProjectKeyCustomersPasswordTokenByPasswordTokenGet
8998+
description: |-
8999+
Use this method to retrieve the details of a global Customer by using the password token during their [password reset process](/../api/customers-overview#customer-password-reset).
89889000
parameters:
89899001
- name: expand
89909002
in: query
@@ -9031,6 +9043,10 @@ paths:
90319043
- "manage_customers:{projectKey}"
90329044
operationId: ByProjectKeyCustomersPasswordResetPost
90339045
description: |-
9046+
Use this method to reset a global Customer's password during their [password reset process](/../api/customers-overview#customer-password-reset).
9047+
9048+
After the password is reset, any previously issued access and/or refresh tokens created through the [password flow](/authorization#password-flow) or [refresh token flow](/authorization#refresh-token-flow) are invalidated.
9049+
90349050
Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`.
90359051
requestBody:
90369052
content:
@@ -12524,6 +12540,8 @@ paths:
1252412540
- "manage_customers:{projectKey}:{storeKey}"
1252512541
operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenPost
1252612542
description: |-
12543+
Use this method to create an email token for a Store-specific Customer during their [email verification process](/../api/customers-overview#customer-email-verification).
12544+
1252712545
If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1252812546
requestBody:
1252912547
content:
@@ -12578,6 +12596,8 @@ paths:
1257812596
- "view_customers:{projectKey}:{storeKey}"
1257912597
operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenGet
1258012598
description: |-
12599+
Use this method to retrieve a Store-specific Customer's details by using the email token during their [email verification process](/../api/customers-overview#customer-email-verification).
12600+
1258112601
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1258212602
parameters:
1258312603
- name: expand
@@ -12631,7 +12651,8 @@ paths:
1263112651
- "manage_customers:{projectKey}:{storeKey}"
1263212652
operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmPost
1263312653
description: |-
12634-
The customer verifies the email using the token value.
12654+
Use this method to verify a Store-specific Customer's email during their [email verification process](/../api/customers-overview#customer-email-verification).
12655+
1263512656
Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message.
1263612657

1263712658
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
@@ -12929,6 +12950,10 @@ paths:
1292912950
- "manage_customers:{projectKey}:{storeKey}"
1293012951
operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenPost
1293112952
description: |-
12953+
Use this method to create a password reset token for a Store-specific Customer during their [password reset process](/../api/customers-overview#customer-password-reset).
12954+
12955+
Creating a password reset token does not invalidate existing tokens.
12956+
1293212957
If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1293312958
requestBody:
1293412959
content:
@@ -12983,6 +13008,8 @@ paths:
1298313008
- "view_customers:{projectKey}:{storeKey}"
1298413009
operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenGet
1298513010
description: |-
13011+
Use this method to retrieve a Store-specific Customer's details by using the password reset token during their [password reset process](/../api/customers-overview#customer-password-reset).
13012+
1298613013
If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1298713014
parameters:
1298813015
- name: expand
@@ -13036,9 +13063,13 @@ paths:
1303613063
- "manage_customers:{projectKey}:{storeKey}"
1303713064
operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetPost
1303813065
description: |-
13066+
Use this method to reset a Store-specific Customer's password during their [password reset process](/../api/customers-overview#customer-password-reset).
13067+
13068+
After the password is reset, any previously issued access and/or refresh tokens created through the [password flow](/authorization#password-flow) or [refresh token flow](/authorization#refresh-token-flow) are invalidated.
13069+
1303913070
Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`.
1304013071

13041-
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
13072+
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), then this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1304213073
requestBody:
1304313074
content:
1304413075
application/json:

0 commit comments

Comments
 (0)