Skip to content

Commit

Permalink
Updated API from documentation release
Browse files Browse the repository at this point in the history
  • Loading branch information
Auto Mation committed Oct 12, 2023
1 parent 378dc7e commit 316dfbe
Show file tree
Hide file tree
Showing 10 changed files with 58 additions and 17 deletions.
4 changes: 4 additions & 0 deletions api-specs/api/types/common/ReferenceTypeId.raml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ enum:
- category
- channel
- customer
- customer-email-token
- customer-group
- customer-password-token
- direct-discount
- discount-code
- extension
Expand Down Expand Up @@ -57,8 +59,10 @@ enum:
References a [Channel](ctp:api:type:Channel).
customer: |
References a [Customer](ctp:api:type:Customer).
customer-email-token: References a [CustomerToken](ctp:api:type:CustomerToken) for [email verification](/../api/projects/customers#email-verification-of-customer).
customer-group: |
References a [CustomerGroup](ctp:api:type:CustomerGroup).
customer-password-token: References a [CustomerToken](ctp:api:type:CustomerToken) for [password reset](/../api/projects/customers#password-reset-of-customer).
direct-discount: |
References a [DirectDiscount](ctp:api:type:DirectDiscount).
discount-code: |
Expand Down
13 changes: 13 additions & 0 deletions api-specs/api/types/customer/CustomerEmailTokenReference.raml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#%RAML 1.0 DataType
(package): Customer
(docs-uri): https://docs.commercetools.com/api/projects/customers#customeremailtokenreference
type: Reference
displayName: CustomerEmailTokenReference
discriminatorValue: customer-email-token
description: |
[Reference](ctp:api:type:Reference) to a [CustomerToken](ctp:api:type:CustomerToken) for email verification.
properties:
id:
type: string
description: |
Unique identifier of the referenced [CustomerToken](ctp:api:type:CustomerToken).
13 changes: 13 additions & 0 deletions api-specs/api/types/customer/CustomerPasswordTokenReference.raml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#%RAML 1.0 DataType
(package): Customer
(docs-uri): https://docs.commercetools.com/api/projects/customers#customerpasswordtokenreference
type: Reference
displayName: CustomerPasswordTokenReference
discriminatorValue: customer-password-token
description: |
[Reference](ctp:api:type:Reference) to a [CustomerToken](ctp:api:type:CustomerToken) for password reset.
properties:
id:
type: string
description: |
Unique identifier of the referenced [CustomerToken](ctp:api:type:CustomerToken).
22 changes: 11 additions & 11 deletions api-specs/api/types/customer/CustomerToken.raml
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ properties:
type: string
description: |
Unique identifier of the token.
createdAt:
type: datetime
description: |
Date and time (UTC) the token was initially created.
lastModifiedAt?:
type: datetime
description: |
When the token is created, `lastModifiedAt` is set to `createdAt`.
customerId:
type: string
description: |
The `id` of the Customer.
value:
type: string
description: |
Value of the token.
expiresAt:
type: datetime
description: |
Date and time (UTC) the token expires.
value:
type: string
createdAt:
type: datetime
description: |
Value of the token.
Date and time (UTC) the token was initially created.
lastModifiedAt?:
type: datetime
description: |
When the token is created, `lastModifiedAt` is set to `createdAt`.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type: Message
displayName: CustomerEmailTokenCreatedMessage
discriminatorValue: CustomerEmailTokenCreated
description: |
Generated after a successful [Create email token for Customer](/../api/projects/customers#create-email-token-for-customer) request.
Generated after a successful [Create email token for Customer](/../api/projects/customers#create-email-token-for-customer) request. The `resource` property of the Message is a [CustomerEmailTokenReference](ctp:api:type:CustomerEmailTokenReference).
properties:
customerId:
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type: Message
displayName: CustomerPasswordTokenCreatedMessage
discriminatorValue: CustomerPasswordTokenCreated
description: |
Generated after a successful [Create password reset token for Customer](/../api/projects/customers#create-password-reset-token-for-customer) request.
Generated after a successful [Create password reset token for Customer](/../api/projects/customers#create-password-reset-token-for-customer) request. The `resource` property of the Message is a [CustomerPasswordTokenReference](ctp:api:type:CustomerPasswordTokenReference).
properties:
customerId:
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type: MessagePayload
displayName: CustomerEmailTokenCreatedMessagePayload
discriminatorValue: CustomerEmailTokenCreated
description: |
Generated after a successful [Create email token for Customer](/../api/projects/customers#create-email-token-for-customer) request.
Generated after a successful [Create email token for Customer](/../api/projects/customers#create-email-token-for-customer) request. The `resource` property of the Message is a [CustomerEmailTokenReference](ctp:api:type:CustomerEmailTokenReference).
properties:
customerId:
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type: MessagePayload
displayName: CustomerPasswordTokenCreatedMessagePayload
discriminatorValue: CustomerPasswordTokenCreated
description: |
Generated after a successful [Create password reset token for Customer](/../api/projects/customers#create-password-reset-token-for-customer) request.
Generated after a successful [Create password reset token for Customer](/../api/projects/customers#create-password-reset-token-for-customer) request. The `resource` property of the Message is a [CustomerPasswordTokenReference](ctp:api:type:CustomerPasswordTokenReference).
properties:
customerId:
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ enum:
- business-unit
- category
- customer
- customer-email-token
- customer-group
- customer-password-token
- inventory-entry
- order
- payment
Expand All @@ -22,13 +25,19 @@ enum:
- store
(enumDescriptions):
associate-role: |
Messages related to [Associate Roles](ctp:api:type:AssociateRole).
Messages related to [AssociateRoles](ctp:api:type:AssociateRole).
business-unit: |
Messages related to [Business Units](ctp:api:type:BusinessUnit).
Messages related to [BusinessUnits](ctp:api:type:BusinessUnit).
category: |
Messages related to [Categories](ctp:api:type:Category).
customer: |
Messages related to [Customers](ctp:api:type:Customer).
customer-email-token: |
Messages related to [CustomerTokens](ctp:api:type:CustomerToken) for email verification.
customer-group: |
Messages related to [CustomerGroups](ctp:api:type:CustomerGroup).
customer-password-token: |
Messages related to [CustomerTokens](ctp:api:type:CustomerToken) for password reset.
inventory-entry: |
Messages related to [InventoryEntries](ctp:api:type:InventoryEntry).
order: |
Expand Down
2 changes: 2 additions & 0 deletions api-specs/api/types/types.raml
Original file line number Diff line number Diff line change
Expand Up @@ -405,8 +405,10 @@ CustomerChangePassword: !include customer/CustomerChangePassword.raml
CustomerCreateEmailToken: !include customer/CustomerCreateEmailToken.raml
CustomerCreatePasswordResetToken: !include customer/CustomerCreatePasswordResetToken.raml
CustomerDraft: !include customer/CustomerDraft.raml
CustomerEmailTokenReference: !include customer/CustomerEmailTokenReference.raml
CustomerEmailVerify: !include customer/CustomerEmailVerify.raml
CustomerPagedQueryResponse: !include customer/CustomerPagedQueryResponse.raml
CustomerPasswordTokenReference: !include customer/CustomerPasswordTokenReference.raml
CustomerReference: !include customer/CustomerReference.raml
CustomerResetPassword: !include customer/CustomerResetPassword.raml
CustomerResourceIdentifier: !include customer/CustomerResourceIdentifier.raml
Expand Down

0 comments on commit 316dfbe

Please sign in to comment.