Regenerate with latest raml specs

Author: mvantellingen

src/commercetools/platform/client/by_project_key_request_builder.py

@@ -167,7 +167,7 @@ def channels(self) -> ByProjectKeyChannelsRequestBuilder:
         )
 
     def customers(self) -> ByProjectKeyCustomersRequestBuilder:
-        """A customer is a person purchasing products. customers, Orders, Comments and Reviews can be associated to a customer."""
+        """A Customer is a person purchasing products. Carts, Orders, Quotes, Reviews and Payments can be associated to a Customer."""
         return ByProjectKeyCustomersRequestBuilder(
             project_key=self._project_key,
             client=self._client,

src/commercetools/platform/client/confirm/by_project_key_customers_email_confirm_request_builder.py

@@ -34,7 +34,7 @@ def post(
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
-        """Verifies customer's email using a token."""
+        """Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message."""
         headers = {} if headers is None else headers
         response = self._client._post(
             endpoint=f"/{self._project_key}/customers/email/confirm",

src/commercetools/platform/client/confirm/by_project_key_in_store_key_by_store_key_customers_email_confirm_request_builder.py

@@ -37,7 +37,12 @@ def post(
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
-        """Verifies customer's email using a token."""
+        """The customer verifies the email using the token value.
+        Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message.
+
+        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.
+
+        """
         headers = {} if headers is None else headers
         response = self._client._post(
             endpoint=f"/{self._project_key}/in-store/key={self._store_key}/customers/email/confirm",

src/commercetools/platform/client/confirm/by_project_key_in_store_key_by_store_key_me_email_confirm_request_builder.py

@@ -7,7 +7,7 @@
 import typing
 import warnings
 
-from ...models.customer import Customer, CustomerEmailVerify
+from ...models.customer import Customer, MyCustomerEmailVerify
 from ...models.error import ErrorResponse
 
 if typing.TYPE_CHECKING:
@@ -32,11 +32,12 @@ def __init__(
 
     def post(
         self,
-        body: "CustomerEmailVerify",
+        body: "MyCustomerEmailVerify",
         *,
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
+        """This is the last step in the [email verification process of a Customer](/../api/projects/customers#email-verification-of-customer-in-store)."""
         headers = {} if headers is None else headers
         response = self._client._post(
             endpoint=f"/{self._project_key}/in-store/key={self._store_key}/me/email/confirm",

src/commercetools/platform/client/confirm/by_project_key_me_email_confirm_request_builder.py

@@ -7,7 +7,7 @@
 import typing
 import warnings
 
-from ...models.customer import Customer, CustomerEmailVerify
+from ...models.customer import Customer, MyCustomerEmailVerify
 from ...models.error import ErrorResponse
 
 if typing.TYPE_CHECKING:
@@ -29,11 +29,12 @@ def __init__(
 
     def post(
         self,
-        body: "CustomerEmailVerify",
+        body: "MyCustomerEmailVerify",
         *,
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
+        """This is the last step in the [email verification process of a Customer](/../api/projects/customers#email-verification-of-customer)."""
         headers = {} if headers is None else headers
         response = self._client._post(
             endpoint=f"/{self._project_key}/me/email/confirm",

src/commercetools/platform/client/customers/by_project_key_customers_by_id_request_builder.py

@@ -87,6 +87,7 @@ def delete(
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
+        """Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message."""
         headers = {} if headers is None else headers
         response = self._client._delete(
             endpoint=f"/{self._project_key}/customers/{self._id}",

src/commercetools/platform/client/customers/by_project_key_customers_key_by_key_request_builder.py

@@ -87,6 +87,7 @@ def delete(
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
+        """Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message."""
         headers = {} if headers is None else headers
         response = self._client._delete(
             endpoint=f"/{self._project_key}/customers/key={self._key}",

src/commercetools/platform/client/customers/by_project_key_customers_request_builder.py

@@ -77,11 +77,6 @@ def with_email_token(
         )
 
     def email_token(self) -> ByProjectKeyCustomersEmailTokenRequestBuilder:
-        """To verify a customer's email, an email token can be created. This should be embedded in a link and sent to the
-        customer via email. When the customer clicks on the link, the "verify customer's email" endpoint should be called,
-        which sets customer's isVerifiedEmail field to true.
-
-        """
         return ByProjectKeyCustomersEmailTokenRequestBuilder(
             project_key=self._project_key,
             client=self._client,
@@ -106,13 +101,6 @@ def password_reset(self) -> ByProjectKeyCustomersPasswordResetRequestBuilder:
         )
 
     def password_token(self) -> ByProjectKeyCustomersPasswordTokenRequestBuilder:
-        """The following workflow can be used to reset the customer's password:
-
-        * Create a password reset token and send it embedded in a link to the customer.
-        * When the customer clicks on the link, the customer is retrieved with the token.
-        * The customer enters a new password and the "reset customer's password" endpoint is called.
-
-        """
         return ByProjectKeyCustomersPasswordTokenRequestBuilder(
             project_key=self._project_key,
             client=self._client,
@@ -180,9 +168,9 @@ def post(
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["CustomerSignInResult"]:
-        """Creates a customer. If an anonymous cart is passed in,
-        then the cart is assigned to the created customer and the version number of the Cart will increase.
-        If the ID of an anonymous session is given, all carts and orders will be assigned to the created customer.
+        """If the `anonymousCart` field is set on the [CustomerDraft](ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that [Cart](ctp:api:type:Cart).
+        Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`.
+        Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message.
 
         """
         headers = {} if headers is None else headers

src/commercetools/platform/client/customers/by_project_key_in_store_key_by_store_key_customers_by_id_request_builder.py

@@ -40,12 +40,7 @@ def get(
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
-        """Returns a customer by its ID from a specific Store.
-        It also considers customers that do not have the stores field.
-        If the customer exists in the project but the stores field references different stores,
-        this method returns a ResourceNotFound error.
-
-        """
+        """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."""
         headers = {} if headers is None else headers
         response = self._client._get(
             endpoint=f"/{self._project_key}/in-store/key={self._store_key}/customers/{self._id}",
@@ -70,11 +65,7 @@ def post(
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
-        """Updates a customer in the store specified by {storeKey}.
-        If the customer exists in the project but the stores field references a different store,
-        this method returns a ResourceNotFound error.
-
-        """
+        """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."""
         headers = {} if headers is None else headers
         response = self._client._post(
             endpoint=f"/{self._project_key}/in-store/key={self._store_key}/customers/{self._id}",
@@ -101,6 +92,11 @@ def delete(
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
+        """Deleting a Customer produces the [CustomerDeleted](ctp:api:type:CustomerDeletedMessage) Message.
+
+        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.
+
+        """
         headers = {} if headers is None else headers
         response = self._client._delete(
             endpoint=f"/{self._project_key}/in-store/key={self._store_key}/customers/{self._id}",

src/commercetools/platform/client/customers/by_project_key_in_store_key_by_store_key_customers_email_token_by_email_token_request_builder.py

@@ -40,6 +40,7 @@ def get(
         headers: typing.Dict[str, str] = None,
         options: typing.Dict[str, typing.Any] = None,
     ) -> typing.Optional["Customer"]:
+        """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."""
         headers = {} if headers is None else headers
         response = self._client._get(
             endpoint=f"/{self._project_key}/in-store/key={self._store_key}/customers/email-token={self._email_token}",