Skip to content

Commit 0f563d3

Browse files
authored
Merge pull request #84 from commercetools/gen-sdk-updates
2 parents 173da2b + afe4173 commit 0f563d3

File tree

194 files changed

+883
-327
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

194 files changed

+883
-327
lines changed

lib/commercetools-api/docs/RequestBuilder.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1216,10 +1216,10 @@ $request = $builder
12161216
```
12171217
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->carts()->post(null)`
12181218

1219-
Creates a cart in the store specified by {storeKey}.
1220-
When using this endpoint the cart's store field is always set to the store specified in the path parameter.
1221-
Creating a cart can fail with an InvalidOperation if the referenced shipping method
1222-
in the CartDraft has a predicate which does not match the cart.
1219+
Creates a [Cart](ctp:api:type:Cart) in the Store specified by `storeKey`.
1220+
When using this endpoint the Cart's `store` field is always set to the store specified in the path parameter.
1221+
Creating a Cart can fail with an [InvalidOperationError](ctp:api:type:InvalidOperationError) if the referenced [ShippingMethod](ctp:api:type:ShippingMethod)
1222+
in the [CartDraft](ctp:api:type:CartDraft) has a predicate which does not match the Cart.
12231223

12241224

12251225
### Example
@@ -1256,9 +1256,9 @@ $request = $builder
12561256
```
12571257
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->carts()->withId("ID")->post(null)`
12581258

1259-
Updates a cart in the store specified by {storeKey}.
1260-
If the cart exists in the project but does not have the store field,
1261-
or the store field references a different store, this method returns a ResourceNotFound error.
1259+
Updates a [Cart](ctp:api:type:Cart) in the Store specified by `storeKey`.
1260+
If the Cart exists in the Project but does not have the store field,
1261+
or the `store` field references a different Store, this method returns a [ResourceNotFoundError](ctp:api:type:ResourceNotFoundError).
12621262

12631263

12641264
### Example
@@ -1335,9 +1335,9 @@ $request = $builder
13351335
```
13361336
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->carts()->withKey("key")->post(null)`
13371337

1338-
Updates a cart in the store specified by {storeKey}.
1339-
If the cart exists in the project but does not have the store field,
1340-
or the store field references a different store, this method returns a ResourceNotFound error.
1338+
Updates a [Cart](ctp:api:type:Cart) in the Store specified by `storeKey`.
1339+
If the Cart exists in the Project but does not have the store field,
1340+
or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFound) error.
13411341

13421342

13431343
### Example
@@ -2217,9 +2217,9 @@ $request = $builder
22172217
```
22182218
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->productProjections()->get()`
22192219

2220-
You can use the product projections query endpoint to get the current or staged representations of Products.
2221-
When used with an API client that has the view_published_products:{projectKey} scope,
2222-
this endpoint only returns published (current) product projections.
2220+
Use this endpoint to get the current or staged projection of [Products](ctp:api:type:Product) in the Store specified by `storeKey`.
2221+
When used with an [API Client](ctp:api:type:ApiClient) that has the `view_published_products:{projectKey}` scope,
2222+
this endpoint only returns published (current) Product Projections.
22232223

22242224

22252225
### Example
@@ -2235,7 +2235,7 @@ $request = $builder
22352235
```
22362236
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->productProjections()->withId("ID")->get()`
22372237

2238-
Gets the current or staged representation of a product by its ID from a specific Store.
2238+
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID from the specified Store.
22392239

22402240
### Example
22412241
```php
@@ -2251,7 +2251,7 @@ $request = $builder
22512251
```
22522252
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->productProjections()->withKey("key")->get()`
22532253

2254-
Gets the current or staged representation of a product by its ID from a specific Store.
2254+
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its key from the specified Store.
22552255

22562256
### Example
22572257
```php
@@ -2282,7 +2282,10 @@ $request = $builder
22822282
```
22832283
## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->shippingMethods()->matchingCart()->get()`
22842284

2285-
null
2285+
Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given Store.
2286+
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
2287+
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
2288+
22862289

22872290
### Example
22882291
```php
@@ -4548,7 +4551,10 @@ $request = $builder
45484551
```
45494552
## `withProjectKey("projectKey")->shippingMethods()->matchingCart()->get()`
45504553

4551-
null
4554+
Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart.
4555+
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
4556+
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
4557+
45524558

45534559
### Example
45544560
```php
@@ -4563,7 +4569,11 @@ $request = $builder
45634569
```
45644570
## `withProjectKey("projectKey")->shippingMethods()->matchingLocation()->get()`
45654571

4566-
null
4572+
Retrieves all the ShippingMethods that can ship to the given [Location](/projects/zones#location).
4573+
If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency.
4574+
Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`.
4575+
If the `currency` parameter is given, exactly one ShippingRate will contain it.
4576+
45674577

45684578
### Example
45694579
```php
@@ -4578,7 +4588,9 @@ $request = $builder
45784588
```
45794589
## `withProjectKey("projectKey")->shippingMethods()->matchingOrderedit()->get()`
45804590

4581-
null
4591+
Retrieves all the ShippingMethods that can ship to the given [Location](/projects/zones#location) for an [OrderEdit](/projects/order-edits).
4592+
In case the OrderEdit preview cannot be created an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is raised.
4593+
45824594

45834595
### Example
45844596
```php

lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededError.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ interface MaxResourceLimitExceededError extends ErrorObject
1616
public const FIELD_EXCEEDED_RESOURCE = 'exceededResource';
1717

1818
/**
19-
* <p>supported resource type identifiers:</p>
19+
* <p>Type of resource the value should reference. Supported resource type identifiers are:</p>
2020
*
2121
* @return null|string
2222
*/

lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function getMessage()
3939
}
4040

4141
/**
42-
* <p>supported resource type identifiers:</p>
42+
* <p>Type of resource the value should reference. Supported resource type identifiers are:</p>
4343
*
4444
* @return null|string
4545
*/

lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorModel.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ public function getMessage()
8383
}
8484

8585
/**
86-
* <p>supported resource type identifiers:</p>
86+
* <p>Type of resource the value should reference. Supported resource type identifiers are:</p>
8787
*
8888
* @return null|string
8989
*/

lib/commercetools-api/src/Models/Error/ReferenceExistsError.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ interface ReferenceExistsError extends ErrorObject
1616
public const FIELD_REFERENCED_BY = 'referencedBy';
1717

1818
/**
19-
* <p>supported resource type identifiers:</p>
19+
* <p>Type of resource the value should reference. Supported resource type identifiers are:</p>
2020
*
2121
* @return null|string
2222
*/

lib/commercetools-api/src/Models/Error/ReferenceExistsErrorBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function getMessage()
3939
}
4040

4141
/**
42-
* <p>supported resource type identifiers:</p>
42+
* <p>Type of resource the value should reference. Supported resource type identifiers are:</p>
4343
*
4444
* @return null|string
4545
*/

lib/commercetools-api/src/Models/Error/ReferenceExistsErrorModel.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ public function getMessage()
8383
}
8484

8585
/**
86-
* <p>supported resource type identifiers:</p>
86+
* <p>Type of resource the value should reference. Supported resource type identifiers are:</p>
8787
*
8888
* @return null|string
8989
*/

lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundError.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ interface ReferencedResourceNotFoundError extends ErrorObject
1818
public const FIELD_KEY = 'key';
1919

2020
/**
21-
* <p>supported resource type identifiers:</p>
21+
* <p>Type of resource the value should reference. Supported resource type identifiers are:</p>
2222
*
2323
* @return null|string
2424
*/

lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function getMessage()
4949
}
5050

5151
/**
52-
* <p>supported resource type identifiers:</p>
52+
* <p>Type of resource the value should reference. Supported resource type identifiers are:</p>
5353
*
5454
* @return null|string
5555
*/

lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorModel.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ public function getMessage()
9797
}
9898

9999
/**
100-
* <p>supported resource type identifiers:</p>
100+
* <p>Type of resource the value should reference. Supported resource type identifiers are:</p>
101101
*
102102
* @return null|string
103103
*/

0 commit comments

Comments
 (0)