Skip to content

Commit ea092ba

Browse files
Merge pull request #337 from commercetools/gen-sdk-updates
Update generated SDKs
2 parents de745be + 599af9a commit ea092ba

File tree

8 files changed

+13
-8
lines changed

8 files changed

+13
-8
lines changed

lib/commercetools-api/docs/RequestBuilder.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6325,6 +6325,7 @@ $request = $builder
63256325
Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store).
63266326
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
63276327
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
6328+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
63286329

63296330

63306331
### Example
@@ -10564,6 +10565,7 @@ $request = $builder
1056410565
Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart.
1056510566
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
1056610567
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
10568+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
1056710569

1056810570

1056910571
### Example
@@ -10579,7 +10581,7 @@ $request = $builder
1057910581
```
1058010582
## `withProjectKey("projectKey")->shippingMethods()->matchingCart()->head()`
1058110583

10582-
Checks if an active ShippingMethod exists for the given Cart. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.
10584+
Checks if an active ShippingMethod exists for the given Cart. If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.
1058310585

1058410586
### Example
1058510587
```php
@@ -10598,6 +10600,7 @@ Retrieves all the active ShippingMethods that can ship to the given [Location](c
1059810600
with a `predicate` that matches the given Cart.
1059910601
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
1060010602
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
10603+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
1060110604

1060210605

1060310606
### Example
@@ -10633,6 +10636,7 @@ ShippingMethods that have a `predicate` defined are automatically disqualified.
1063310636
If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency.
1063410637
Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`.
1063510638
If the `currency` parameter is given, exactly one ShippingRate will contain it.
10639+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
1063610640

1063710641

1063810642
### Example
@@ -10664,7 +10668,7 @@ $request = $builder
1066410668
## `withProjectKey("projectKey")->shippingMethods()->matchingOrderedit()->get()`
1066510669

1066610670
Retrieves all the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location) for an [OrderEdit](ctp:api:type:OrderEdit).
10667-
10671+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
1066810672
If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned.
1066910673

1067010674

lib/commercetools-api/src/Models/ShippingMethod/ShippingMethod.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ public function getZoneRates();
148148
public function getActive();
149149

150150
/**
151-
* <p>If <code>true</code>, this ShippingMethod is the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod.</p>
151+
* <p>If <code>true</code>, this ShippingMethod is the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod. When retrieving <a href="/projects/shippingMethods#get-matching-shipping-methods">matching Shipping Methods</a>, it is returned as the first item in the array. This flag does not automatically apply the Shipping Method to Carts.</p>
152152
*
153153
154154
* @return null|bool

lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ public function getActive()
291291
}
292292

293293
/**
294-
* <p>If <code>true</code>, this ShippingMethod is the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod.</p>
294+
* <p>If <code>true</code>, this ShippingMethod is the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod. When retrieving <a href="/projects/shippingMethods#get-matching-shipping-methods">matching Shipping Methods</a>, it is returned as the first item in the array. This flag does not automatically apply the Shipping Method to Carts.</p>
295295
*
296296
297297
* @return null|bool

lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraft.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public function getZoneRates();
9393
public function getActive();
9494

9595
/**
96-
* <p>If set to <code>true</code>, the ShippingMethod will be the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod.</p>
96+
* <p>If set to <code>true</code>, the ShippingMethod will be the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod. When retrieving <a href="/projects/shippingMethods#get-matching-shipping-methods">matching Shipping Methods</a>, it is returned as the first item in the array. This flag does not automatically apply the Shipping Method to Carts.</p>
9797
*
9898
9999
* @return null|bool

lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ public function getActive()
181181
}
182182

183183
/**
184-
* <p>If set to <code>true</code>, the ShippingMethod will be the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod.</p>
184+
* <p>If set to <code>true</code>, the ShippingMethod will be the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod. When retrieving <a href="/projects/shippingMethods#get-matching-shipping-methods">matching Shipping Methods</a>, it is returned as the first item in the array. This flag does not automatically apply the Shipping Method to Carts.</p>
185185
*
186186
187187
* @return null|bool

lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftModel.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ public function getActive()
285285
}
286286

287287
/**
288-
* <p>If set to <code>true</code>, the ShippingMethod will be the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod.</p>
288+
* <p>If set to <code>true</code>, the ShippingMethod will be the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod. When retrieving <a href="/projects/shippingMethods#get-matching-shipping-methods">matching Shipping Methods</a>, it is returned as the first item in the array. This flag does not automatically apply the Shipping Method to Carts.</p>
289289
*
290290
*
291291
* @return null|bool

lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodModel.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,7 @@ public function getActive()
471471
}
472472

473473
/**
474-
* <p>If <code>true</code>, this ShippingMethod is the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod.</p>
474+
* <p>If <code>true</code>, this ShippingMethod is the <a href="ctp:api:type:Project">Project</a>'s default ShippingMethod. When retrieving <a href="/projects/shippingMethods#get-matching-shipping-methods">matching Shipping Methods</a>, it is returned as the first item in the array. This flag does not automatically apply the Shipping Method to Carts.</p>
475475
*
476476
*
477477
* @return null|bool

references.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,3 +379,4 @@ a4fe92e28e967d91ddaad6750b6434a65949b840
379379
83cd8adc6f390f5621bc908ec4482f74baabdba0
380380
ffa8644c871728467258443ffb54707031865c44
381381
a7aa20c17dc375042673f3de785e65cda595960c
382+
9e27b6b4195fb7839b6c87f31a988d1612f327d6

0 commit comments

Comments
 (0)