Skip to content

Commit 277b373

Browse files
committed
Updated API from documentation release
1 parent daffa35 commit 277b373

File tree

2 files changed

+36
-3
lines changed

2 files changed

+36
-3
lines changed

api-specs/api/resources/customers.raml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ post:
4848
get:
4949
displayName: Get customer by password verification token
5050
securedBy: [oauth_2_0: { scopes: ['view_customers:{projectKey}'] }]
51+
description: |
52+
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).
5153
responses:
5254
200:
5355
body:
@@ -62,6 +64,8 @@ post:
6264
get:
6365
displayName: Get customer by email verification token
6466
securedBy: [oauth_2_0: { scopes: ['view_customers:{projectKey}'] }]
67+
description: |
68+
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).
6569
responses:
6670
200:
6771
body:
@@ -71,8 +75,11 @@ post:
7175
type: base
7276
post:
7377
displayName: Create a Token for verifying the Customer's Email
74-
description: Produces the [CustomerEmailTokenCreated](ctp:api:type:CustomerEmailTokenCreatedMessage) Message.
7578
securedBy: [oauth_2_0: { scopes: ['manage_customers:{projectKey}'] }]
79+
description: |
80+
Use this method to create an email token for a global Customer during their [email verification process](/../api/customers-overview#customer-email-verification).
81+
82+
Creating an email token for the Customer produces the [CustomerEmailTokenCreated](ctp:api:type:CustomerEmailTokenCreatedMessage) Message.
7683
body:
7784
application/json:
7885
example: !include ../examples/Customer/CustomerCreateEmailToken.json
@@ -88,6 +95,8 @@ post:
8895
post:
8996
displayName: Verifies customer's email.
9097
description: |
98+
Use this method to verify a global Customer's email during their [email verification process](/../api/customers-overview#customer-email-verification).
99+
91100
Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message.
92101
securedBy: [oauth_2_0: { scopes: ['manage_customers:{projectKey}'] }]
93102
body:
@@ -124,6 +133,10 @@ post:
124133
post:
125134
displayName: Reset Customer's Password
126135
description: |
136+
Use this method to reset a global Customer's password during their [password reset process](/../api/customers-overview#customer-password-reset).
137+
138+
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.
139+
127140
Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`.
128141
securedBy: [oauth_2_0: { scopes: ['manage_customers:{projectKey}'] }]
129142
body:
@@ -143,6 +156,10 @@ post:
143156
post:
144157
displayName: Create a Token for Resetting the Customer's Password
145158
securedBy: [oauth_2_0: { scopes: ['manage_customers:{projectKey}'] }]
159+
description: |
160+
Use this method to create a password reset token for a global Customer during their [password reset process](/../api/customers-overview#customer-password-reset).
161+
162+
Creating a password reset token does not invalidate existing tokens.
146163
body:
147164
application/json:
148165
example: !include ../examples/Customer/CustomerCreatePasswordResetToken.json

api-specs/api/resources/in-store.raml

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1817,6 +1817,8 @@ uriParameters:
18171817
get:
18181818
displayName: Get customer by password verification token in store
18191819
description: |
1820+
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).
1821+
18201822
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.
18211823
securedBy:
18221824
- oauth_2_0:
@@ -1837,6 +1839,8 @@ uriParameters:
18371839
get:
18381840
displayName: Get customer by email verification token in store
18391841
description: |
1842+
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).
1843+
18401844
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.
18411845
securedBy:
18421846
- oauth_2_0:
@@ -1854,6 +1858,8 @@ uriParameters:
18541858
post:
18551859
displayName: Create a Token for verifying the Customer's Email in store
18561860
description: |
1861+
Use this method to create an email token for a Store-specific Customer during their [email verification process](/../api/customers-overview#customer-email-verification).
1862+
18571863
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.
18581864
securedBy:
18591865
- oauth_2_0:
@@ -1874,7 +1880,8 @@ uriParameters:
18741880
post:
18751881
displayName: Verify Customer's Email in store
18761882
description: |
1877-
The customer verifies the email using the token value.
1883+
Use this method to verify a Store-specific Customer's email during their [email verification process](/../api/customers-overview#customer-email-verification).
1884+
18781885
Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message.
18791886
18801887
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.
@@ -1920,9 +1927,14 @@ uriParameters:
19201927
post:
19211928
displayName: Reset Customer's Password in store
19221929
description: |
1930+
Use this method to reset a Store-specific Customer's password during their [password reset process](/../api/customers-overview#customer-password-reset).
1931+
1932+
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.
1933+
19231934
Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`.
19241935
1925-
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.
1936+
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.
1937+
19261938
securedBy:
19271939
- oauth_2_0:
19281940
scopes:
@@ -1944,6 +1956,10 @@ uriParameters:
19441956
post:
19451957
displayName: Create a Token for Resetting the Customer's Password in store
19461958
description: |
1959+
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).
1960+
1961+
Creating a password reset token does not invalidate existing tokens.
1962+
19471963
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.
19481964
securedBy:
19491965
- oauth_2_0:

0 commit comments

Comments
 (0)