diff --git a/api-specs/api/types/common/ReferenceTypeId.raml b/api-specs/api/types/common/ReferenceTypeId.raml index 2f4b58227..955568ed6 100644 --- a/api-specs/api/types/common/ReferenceTypeId.raml +++ b/api-specs/api/types/common/ReferenceTypeId.raml @@ -13,7 +13,9 @@ enum: - category - channel - customer + - customer-email-token - customer-group + - customer-password-token - direct-discount - discount-code - extension @@ -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: | diff --git a/api-specs/api/types/customer/CustomerEmailTokenReference.raml b/api-specs/api/types/customer/CustomerEmailTokenReference.raml new file mode 100644 index 000000000..22a2bc6ee --- /dev/null +++ b/api-specs/api/types/customer/CustomerEmailTokenReference.raml @@ -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). diff --git a/api-specs/api/types/customer/CustomerPasswordTokenReference.raml b/api-specs/api/types/customer/CustomerPasswordTokenReference.raml new file mode 100644 index 000000000..394d9be63 --- /dev/null +++ b/api-specs/api/types/customer/CustomerPasswordTokenReference.raml @@ -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). diff --git a/api-specs/api/types/customer/CustomerToken.raml b/api-specs/api/types/customer/CustomerToken.raml index 4eb238839..f399806ae 100644 --- a/api-specs/api/types/customer/CustomerToken.raml +++ b/api-specs/api/types/customer/CustomerToken.raml @@ -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`. diff --git a/api-specs/api/types/message/CustomerEmailTokenCreatedMessage.raml b/api-specs/api/types/message/CustomerEmailTokenCreatedMessage.raml index d38460733..cc2e33c9d 100644 --- a/api-specs/api/types/message/CustomerEmailTokenCreatedMessage.raml +++ b/api-specs/api/types/message/CustomerEmailTokenCreatedMessage.raml @@ -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 diff --git a/api-specs/api/types/message/CustomerPasswordTokenCreatedMessage.raml b/api-specs/api/types/message/CustomerPasswordTokenCreatedMessage.raml index 68f34ac84..313bec7d9 100644 --- a/api-specs/api/types/message/CustomerPasswordTokenCreatedMessage.raml +++ b/api-specs/api/types/message/CustomerPasswordTokenCreatedMessage.raml @@ -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 diff --git a/api-specs/api/types/message/payload/CustomerEmailTokenCreatedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerEmailTokenCreatedMessagePayload.raml index 0ebfef686..5bb2d5ee9 100644 --- a/api-specs/api/types/message/payload/CustomerEmailTokenCreatedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerEmailTokenCreatedMessagePayload.raml @@ -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 diff --git a/api-specs/api/types/message/payload/CustomerPasswordTokenCreatedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerPasswordTokenCreatedMessagePayload.raml index 85fa23370..826d660c2 100644 --- a/api-specs/api/types/message/payload/CustomerPasswordTokenCreatedMessagePayload.raml +++ b/api-specs/api/types/message/payload/CustomerPasswordTokenCreatedMessagePayload.raml @@ -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 diff --git a/api-specs/api/types/subscription/MessageSubscriptionResourceTypeId.raml b/api-specs/api/types/subscription/MessageSubscriptionResourceTypeId.raml index c57d574bf..55be39c91 100644 --- a/api-specs/api/types/subscription/MessageSubscriptionResourceTypeId.raml +++ b/api-specs/api/types/subscription/MessageSubscriptionResourceTypeId.raml @@ -9,6 +9,9 @@ enum: - business-unit - category - customer + - customer-email-token + - customer-group + - customer-password-token - inventory-entry - order - payment @@ -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: | diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml index c510797af..df68aadcf 100644 --- a/api-specs/api/types/types.raml +++ b/api-specs/api/types/types.raml @@ -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