Skip to content

Commit 0544a90

Browse files
Merge pull request #458 from commercetools/gen-sdk-updates
Update generated SDKs
2 parents b437c5e + b4c940d commit 0544a90

11 files changed

+38
-45
lines changed

lib/commercetools-api/docs/RequestBuilder.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3006,9 +3006,6 @@ $request = $builder
30063006
```
30073007
## `withProjectKey("projectKey")->customers()->post(null)`
30083008

3009-
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).
3010-
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`.
3011-
30123009
Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. Simultaneously creating two Customers with the same email address can return a [LockedField](ctp:api:type:LockedFieldError) error.
30133010

30143011

@@ -4573,10 +4570,10 @@ $request = $builder
45734570

45744571
When using this endpoint, if omitted, the Customer `stores` field is set to the [Store](ctp:api:type:Store) specified in the path parameter.
45754572

4576-
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).
4577-
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`.
45784573
If a Cart with a `store` field specified, the `store` field must reference the same [Store](ctp:api:type:Store) specified in the `{storeKey}` path parameter.
45794574

4575+
If the Customer has multiple active Carts, the anonymous Cart is [merged](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up) into the most recently modified active Cart.
4576+
45804577
Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. Simultaneously creating two Customers with the same email address can return a [LockedField](ctp:api:type:LockedFieldError) error.
45814578

45824579

@@ -4880,11 +4877,9 @@ $request = $builder
48804877
```
48814878
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->login()->post(null)`
48824879

4883-
Authenticates a Customer associated with a [Store](ctp:api:type:Store). For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers).
4880+
Authenticates a Customer associated with a [Store](ctp:api:type:Store).
48844881

4885-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
4886-
4887-
Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in).
4882+
If the Customer has multiple active Carts, the anonymous Cart is [merged](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up) into the most recently modified active Cart.
48884883

48894884
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error.
48904885

@@ -5197,8 +5192,6 @@ If used with an optional [access token for an anonymous session](ctp:api:type:An
51975192
- If the Customer does not have a Cart, the most recently modified anonymous cart becomes the Customer's Cart.
51985193
- If the Customer already has a Cart, the most recently modified anonymous cart is handled according to [AnonymousCartSignInMode](ctp:api:type:AnonymousCartSignInMode).
51995194

5200-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
5201-
52025195
If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.
52035196

52045197

@@ -5655,12 +5648,11 @@ $request = $builder
56555648
```
56565649
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->me()->signup()->post(null)`
56575650

5658-
56595651
If used with an optional [access token for an anonymous session](ctp:api:type:AnonymousSession), all Orders and Carts that belong to the `anonymousId` are assigned to the newly created Customer.
56605652

56615653
If omitted in the request body, the [Customer](ctp:api:type:Customer) `stores` field is set to the [Store](ctp:api:type:Store) specified in the path parameter.
56625654

5663-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
5655+
If the Customer has multiple active Carts, the anonymous Cart is [merged](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up) into the most recently modified active Cart.
56645656

56655657
Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message.
56665658

@@ -7136,13 +7128,9 @@ $request = $builder
71367128
```
71377129
## `withProjectKey("projectKey")->login()->post(null)`
71387130

7139-
Authenticates a global Customer not associated with a Store.
7140-
For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers).
7141-
If the Customer is registered in a Store, use the [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) method.
7142-
7143-
Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in).
7131+
Authenticates a global Customer.
71447132

7145-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
7133+
If the Customer has multiple active Carts, the anonymous Cart is [merged](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up) into the most recently modified active Cart.
71467134

71477135
If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.
71487136

@@ -7599,8 +7587,6 @@ If used with an optional [access token for an anonymous session](ctp:api:type:An
75997587
- If the Customer does not have a Cart yet, the most recently modified anonymous cart becomes the Customer's Cart.
76007588
- If the Customer already has a Cart, the most recently modified anonymous cart is handled in accordance with [AnonymousCartSignInMode](ctp:api:type:AnonymousCartSignInMode).
76017589

7602-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
7603-
76047590
If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.
76057591

76067592

lib/commercetools-api/src/Models/Customer/CustomerDraft.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,15 +135,16 @@ public function getTitle();
135135
public function getAnonymousCartId();
136136

137137
/**
138-
* <p>Identifies a <a href="ctp:api:type:Cart">Cart</a> that will be assigned to the new Customer.</p>
138+
* <p>Assigns the Customer to the specified Cart.</p>
139139
*
140140
141141
* @return null|CartResourceIdentifier
142142
*/
143143
public function getAnonymousCart();
144144

145145
/**
146-
* <p>Identifies Carts and Orders belonging to an anonymous session that will be assigned to the new Customer.</p>
146+
* <p>Assigns the Customer to all <a href="ctp:api:type:Cart">Carts</a>, <a href="ctp:api:type:Order">Orders</a>, <a href="ctp:api:type:ShoppingList">ShoppingLists</a>, and <a href="ctp:api:type:Payment">Payments</a> with the same <code>anonymousId</code>.</p>
147+
* <p>If <code>anonymousCart</code> is provided, this value must match the <code>anonymousId</code> of the anonymous <a href="ctp:api:type:Cart">Cart</a>; otherwise, an <a href="ctp:api:type:InvalidOperationError">InvalidOperation</a> error is returned.</p>
147148
*
148149
149150
* @return null|string

lib/commercetools-api/src/Models/Customer/CustomerDraftBuilder.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ public function getAnonymousCartId()
314314
}
315315

316316
/**
317-
* <p>Identifies a <a href="ctp:api:type:Cart">Cart</a> that will be assigned to the new Customer.</p>
317+
* <p>Assigns the Customer to the specified Cart.</p>
318318
*
319319
320320
* @return null|CartResourceIdentifier
@@ -325,7 +325,8 @@ public function getAnonymousCart()
325325
}
326326

327327
/**
328-
* <p>Identifies Carts and Orders belonging to an anonymous session that will be assigned to the new Customer.</p>
328+
* <p>Assigns the Customer to all <a href="ctp:api:type:Cart">Carts</a>, <a href="ctp:api:type:Order">Orders</a>, <a href="ctp:api:type:ShoppingList">ShoppingLists</a>, and <a href="ctp:api:type:Payment">Payments</a> with the same <code>anonymousId</code>.</p>
329+
* <p>If <code>anonymousCart</code> is provided, this value must match the <code>anonymousId</code> of the anonymous <a href="ctp:api:type:Cart">Cart</a>; otherwise, an <a href="ctp:api:type:InvalidOperationError">InvalidOperation</a> error is returned.</p>
329330
*
330331
331332
* @return null|string

lib/commercetools-api/src/Models/Customer/CustomerDraftModel.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ public function getAnonymousCartId()
467467
}
468468

469469
/**
470-
* <p>Identifies a <a href="ctp:api:type:Cart">Cart</a> that will be assigned to the new Customer.</p>
470+
* <p>Assigns the Customer to the specified Cart.</p>
471471
*
472472
*
473473
* @return null|CartResourceIdentifier
@@ -488,7 +488,8 @@ public function getAnonymousCart()
488488
}
489489

490490
/**
491-
* <p>Identifies Carts and Orders belonging to an anonymous session that will be assigned to the new Customer.</p>
491+
* <p>Assigns the Customer to all <a href="ctp:api:type:Cart">Carts</a>, <a href="ctp:api:type:Order">Orders</a>, <a href="ctp:api:type:ShoppingList">ShoppingLists</a>, and <a href="ctp:api:type:Payment">Payments</a> with the same <code>anonymousId</code>.</p>
492+
* <p>If <code>anonymousCart</code> is provided, this value must match the <code>anonymousId</code> of the anonymous <a href="ctp:api:type:Cart">Cart</a>; otherwise, an <a href="ctp:api:type:InvalidOperationError">InvalidOperation</a> error is returned.</p>
492493
*
493494
*
494495
* @return null|string

lib/commercetools-api/src/Models/Customer/CustomerSignInResult.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ interface CustomerSignInResult extends JsonObject
2626
public function getCustomer();
2727

2828
/**
29-
* <p>Cart associated with the Customer.
30-
* If empty, the Customer does not have a Cart assigned.</p>
29+
* <p>Cart associated with the Customer.</p>
30+
* <p>The Cart is recalculated to remove invalid Line Items and apply the latest prices, taxes, and discounts.
31+
* During these updates, the following errors can be returned: <a href="ctp:api:type:MatchingPriceNotFoundError">MatchingPriceNotFound</a> and <a href="ctp:api:type:MissingTaxRateForCountryError">MissingTaxRateForCountry</a>.</p>
32+
* <p>For more information, see <a href="/../api/carts-orders-overview#update-a-cart">Cart updates</a>.</p>
3133
*
3234
3335
* @return null|Cart

lib/commercetools-api/src/Models/Customer/CustomerSignInResultBuilder.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ public function getCustomer()
4646
}
4747

4848
/**
49-
* <p>Cart associated with the Customer.
50-
* If empty, the Customer does not have a Cart assigned.</p>
49+
* <p>Cart associated with the Customer.</p>
50+
* <p>The Cart is recalculated to remove invalid Line Items and apply the latest prices, taxes, and discounts.
51+
* During these updates, the following errors can be returned: <a href="ctp:api:type:MatchingPriceNotFoundError">MatchingPriceNotFound</a> and <a href="ctp:api:type:MissingTaxRateForCountryError">MissingTaxRateForCountry</a>.</p>
52+
* <p>For more information, see <a href="/../api/carts-orders-overview#update-a-cart">Cart updates</a>.</p>
5153
*
5254
5355
* @return null|Cart

lib/commercetools-api/src/Models/Customer/CustomerSignInResultModel.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,10 @@ public function getCustomer()
6767
}
6868

6969
/**
70-
* <p>Cart associated with the Customer.
71-
* If empty, the Customer does not have a Cart assigned.</p>
70+
* <p>Cart associated with the Customer.</p>
71+
* <p>The Cart is recalculated to remove invalid Line Items and apply the latest prices, taxes, and discounts.
72+
* During these updates, the following errors can be returned: <a href="ctp:api:type:MatchingPriceNotFoundError">MatchingPriceNotFound</a> and <a href="ctp:api:type:MissingTaxRateForCountryError">MissingTaxRateForCountry</a>.</p>
73+
* <p>For more information, see <a href="/../api/carts-orders-overview#update-a-cart">Cart updates</a>.</p>
7274
*
7375
*
7476
* @return null|Cart

lib/commercetools-api/src/Models/Customer/CustomerSignin.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public function getPassword();
4747
public function getAnonymousCartId();
4848

4949
/**
50-
* <p>Identifies a <a href="ctp:api:type:Cart">Cart</a> that will be assigned to the Customer.</p>
50+
* <p>Assigns the Customer to the specified Cart.</p>
5151
*
5252
5353
* @return null|CartResourceIdentifier
@@ -66,9 +66,8 @@ public function getAnonymousCart();
6666
public function getAnonymousCartSignInMode();
6767

6868
/**
69-
* <p>If both <code>anonymousCart</code> and <code>anonymousId</code> are provided, the <code>anonymousId</code> on the CustomerSignin must match that of the anonymous <a href="ctp:api:type:Cart">Cart</a>.
70-
* Otherwise a <a href="ctp:api:type:InvalidOperationError">400 Bad Request</a> <code>Invalid Operation</code> error is returned with the message:
71-
* &quot;Cart with the ID cart-id does not have the expected anonymousId.&quot;.</p>
69+
* <p>Assigns the Customer to all <a href="ctp:api:type:Cart">Carts</a>, <a href="ctp:api:type:Order">Orders</a>, <a href="ctp:api:type:ShoppingList">ShoppingLists</a>, and <a href="ctp:api:type:Payment">Payments</a> with the same <code>anonymousId</code>.</p>
70+
* <p>If <code>anonymousCart</code> is provided, this value must match the <code>anonymousId</code> of the anonymous <a href="ctp:api:type:Cart">Cart</a>; otherwise, an <a href="ctp:api:type:InvalidOperationError">InvalidOperation</a> error is returned.</p>
7271
*
7372
7473
* @return null|string

lib/commercetools-api/src/Models/Customer/CustomerSigninBuilder.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public function getAnonymousCartId()
9898
}
9999

100100
/**
101-
* <p>Identifies a <a href="ctp:api:type:Cart">Cart</a> that will be assigned to the Customer.</p>
101+
* <p>Assigns the Customer to the specified Cart.</p>
102102
*
103103
104104
* @return null|CartResourceIdentifier
@@ -123,9 +123,8 @@ public function getAnonymousCartSignInMode()
123123
}
124124

125125
/**
126-
* <p>If both <code>anonymousCart</code> and <code>anonymousId</code> are provided, the <code>anonymousId</code> on the CustomerSignin must match that of the anonymous <a href="ctp:api:type:Cart">Cart</a>.
127-
* Otherwise a <a href="ctp:api:type:InvalidOperationError">400 Bad Request</a> <code>Invalid Operation</code> error is returned with the message:
128-
* &quot;Cart with the ID cart-id does not have the expected anonymousId.&quot;.</p>
126+
* <p>Assigns the Customer to all <a href="ctp:api:type:Cart">Carts</a>, <a href="ctp:api:type:Order">Orders</a>, <a href="ctp:api:type:ShoppingList">ShoppingLists</a>, and <a href="ctp:api:type:Payment">Payments</a> with the same <code>anonymousId</code>.</p>
127+
* <p>If <code>anonymousCart</code> is provided, this value must match the <code>anonymousId</code> of the anonymous <a href="ctp:api:type:Cart">Cart</a>; otherwise, an <a href="ctp:api:type:InvalidOperationError">InvalidOperation</a> error is returned.</p>
129128
*
130129
131130
* @return null|string

lib/commercetools-api/src/Models/Customer/CustomerSigninModel.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ public function getAnonymousCartId()
146146
}
147147

148148
/**
149-
* <p>Identifies a <a href="ctp:api:type:Cart">Cart</a> that will be assigned to the Customer.</p>
149+
* <p>Assigns the Customer to the specified Cart.</p>
150150
*
151151
*
152152
* @return null|CartResourceIdentifier
@@ -190,9 +190,8 @@ public function getAnonymousCartSignInMode()
190190
}
191191

192192
/**
193-
* <p>If both <code>anonymousCart</code> and <code>anonymousId</code> are provided, the <code>anonymousId</code> on the CustomerSignin must match that of the anonymous <a href="ctp:api:type:Cart">Cart</a>.
194-
* Otherwise a <a href="ctp:api:type:InvalidOperationError">400 Bad Request</a> <code>Invalid Operation</code> error is returned with the message:
195-
* &quot;Cart with the ID cart-id does not have the expected anonymousId.&quot;.</p>
193+
* <p>Assigns the Customer to all <a href="ctp:api:type:Cart">Carts</a>, <a href="ctp:api:type:Order">Orders</a>, <a href="ctp:api:type:ShoppingList">ShoppingLists</a>, and <a href="ctp:api:type:Payment">Payments</a> with the same <code>anonymousId</code>.</p>
194+
* <p>If <code>anonymousCart</code> is provided, this value must match the <code>anonymousId</code> of the anonymous <a href="ctp:api:type:Cart">Cart</a>; otherwise, an <a href="ctp:api:type:InvalidOperationError">InvalidOperation</a> error is returned.</p>
196195
*
197196
*
198197
* @return null|string

0 commit comments

Comments
 (0)