Skip to content

Commit

Permalink
build(codegen): updating SDK
Browse files Browse the repository at this point in the history
  • Loading branch information
ct-sdks[bot] committed Jan 12, 2024
1 parent fc2071f commit 2688ccf
Show file tree
Hide file tree
Showing 14 changed files with 18 additions and 17 deletions.
10 changes: 5 additions & 5 deletions lib/commercetools-api/docs/RequestBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -5163,7 +5163,7 @@ $request = $builder

Authenticates a global Customer not associated with a Store.
For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers).
If the Customer is registered in a Store, use the [Authenticate (sign in) Customer in Store](/../api/projects/customers#authenticate-sign-in-customer-in-store) method.
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.

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

Expand Down Expand Up @@ -7498,7 +7498,7 @@ $request = $builder
```
## `withProjectKey("projectKey")->productSelections()->withId("ID")->delete()`

Deletion will only succeed if the Product Selection is not assigned to any [Store](/../api/projects/stores#store).
Deletion will only succeed if the Product Selection is not assigned to any [Store](ctp:api:type:Store).

### Example
```php
Expand Down Expand Up @@ -7574,7 +7574,7 @@ $request = $builder
```
## `withProjectKey("projectKey")->productSelections()->withKey("key")->delete()`

Deletion will only succeed if the Product Selection is not assigned to any [Store](/../api/projects/stores#store).
Deletion will only succeed if the Product Selection is not assigned to any [Store](ctp:api:type:Store).

### Example
```php
Expand Down Expand Up @@ -8666,7 +8666,7 @@ $request = $builder
```
## `withProjectKey("projectKey")->shippingMethods()->matchingCartLocation()->get()`

Retrieves all the ShippingMethods that can ship to the given [Location](/projects/zones#location)
Retrieves all the ShippingMethods that can ship to the given [Location](ctp:api:type:Location)
with a `predicate` that matches the given Cart.
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
Expand Down Expand Up @@ -8735,7 +8735,7 @@ $request = $builder
```
## `withProjectKey("projectKey")->shippingMethods()->matchingOrderedit()->get()`

Retrieves all the ShippingMethods that can ship to the given [Location](/../api/projects/zones#location) for an [OrderEdit](/../api/projects/order-edits).
Retrieves all the ShippingMethods that can ship to the given [Location](ctp:api:type:Location) for an [OrderEdit](ctp:api:type:OrderEdit).

If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface BusinessUnitSetCustomTypeAction extends BusinessUnitUpdateAction
public const FIELD_FIELDS = 'fields';

/**
* <p>Defines the <a href="ctp:api:type:Type">Type</a> that extends the BusinessUnit with <a href="/../api/projects/custom-fields">Custom Fields</a>.
* <p>Defines the <a href="ctp:api:type:Type">Type</a> that extends the BusinessUnit with <a href="ctp:api:type:CustomFields">Custom Fields</a>.
* If absent, any existing Type and Custom Fields are removed from the BusinessUnit.</p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ final class BusinessUnitSetCustomTypeActionBuilder implements Builder
private $fields;

/**
* <p>Defines the <a href="ctp:api:type:Type">Type</a> that extends the BusinessUnit with <a href="/../api/projects/custom-fields">Custom Fields</a>.
* <p>Defines the <a href="ctp:api:type:Type">Type</a> that extends the BusinessUnit with <a href="ctp:api:type:CustomFields">Custom Fields</a>.
* If absent, any existing Type and Custom Fields are removed from the BusinessUnit.</p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public function getAction()
}

/**
* <p>Defines the <a href="ctp:api:type:Type">Type</a> that extends the BusinessUnit with <a href="/../api/projects/custom-fields">Custom Fields</a>.
* <p>Defines the <a href="ctp:api:type:Type">Type</a> that extends the BusinessUnit with <a href="ctp:api:type:CustomFields">Custom Fields</a>.
* If absent, any existing Type and Custom Fields are removed from the BusinessUnit.</p>
*
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface CustomerPasswordUpdatedMessage extends Message
public const FIELD_RESET = 'reset';

/**
* <p>Whether the Customer's password was updated during the <a href="/../api/projects/customers#password-reset-of-customer">Reset password</a> or <a href="/../api/projects/customers#change-password-of-customer">Change password</a> flow.</p>
* <p>Whether the Customer's password was updated during the <a href="ctp:api:endpoint:/{projectKey}/customers/password/reset:POST">Reset password</a> or <a href="ctp:api:endpoint:/{projectKey}/customers/password:POST">Change password</a> flow.</p>
*
* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ public function getResourceUserProvidedIdentifiers()
}

/**
* <p>Whether the Customer's password was updated during the <a href="/../api/projects/customers#password-reset-of-customer">Reset password</a> or <a href="/../api/projects/customers#change-password-of-customer">Change password</a> flow.</p>
* <p>Whether the Customer's password was updated during the <a href="ctp:api:endpoint:/{projectKey}/customers/password/reset:POST">Reset password</a> or <a href="ctp:api:endpoint:/{projectKey}/customers/password:POST">Change password</a> flow.</p>
*
* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ public function getResourceUserProvidedIdentifiers()
}

/**
* <p>Whether the Customer's password was updated during the <a href="/../api/projects/customers#password-reset-of-customer">Reset password</a> or <a href="/../api/projects/customers#change-password-of-customer">Change password</a> flow.</p>
* <p>Whether the Customer's password was updated during the <a href="ctp:api:endpoint:/{projectKey}/customers/password/reset:POST">Reset password</a> or <a href="ctp:api:endpoint:/{projectKey}/customers/password:POST">Change password</a> flow.</p>
*
*
* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface CustomerPasswordUpdatedMessagePayload extends MessagePayload
public const FIELD_RESET = 'reset';

/**
* <p>Whether the Customer's password was updated during the <a href="/../api/projects/customers#password-reset-of-customer">Reset password</a> or <a href="/../api/projects/customers#change-password-of-customer">Change password</a> flow.</p>
* <p>Whether the Customer's password was updated during the <a href="ctp:api:endpoint:/{projectKey}/customers/password/reset:POST">Reset password</a> or <a href="ctp:api:endpoint:/{projectKey}/customers/password:POST">Change password</a> flow.</p>
*
* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ final class CustomerPasswordUpdatedMessagePayloadBuilder implements Builder
private $reset;

/**
* <p>Whether the Customer's password was updated during the <a href="/../api/projects/customers#password-reset-of-customer">Reset password</a> or <a href="/../api/projects/customers#change-password-of-customer">Change password</a> flow.</p>
* <p>Whether the Customer's password was updated during the <a href="ctp:api:endpoint:/{projectKey}/customers/password/reset:POST">Reset password</a> or <a href="ctp:api:endpoint:/{projectKey}/customers/password:POST">Change password</a> flow.</p>
*
* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public function getType()
}

/**
* <p>Whether the Customer's password was updated during the <a href="/../api/projects/customers#password-reset-of-customer">Reset password</a> or <a href="/../api/projects/customers#change-password-of-customer">Change password</a> flow.</p>
* <p>Whether the Customer's password was updated during the <a href="ctp:api:endpoint:/{projectKey}/customers/password/reset:POST">Reset password</a> or <a href="ctp:api:endpoint:/{projectKey}/customers/password:POST">Change password</a> flow.</p>
*
*
* @return null|bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public function getInputHint();
* <p>If <code>true</code>, the Attribute's values are available for the <a href="/../api/projects/products-search">Product Projections Search API</a> for use in full-text search queries, filters, and facets.</p>
* <p>Which exact features are available with this flag depends on the specific <a href="ctp:api:type:AttributeType">AttributeType</a>.
* The maximum size of a searchable field is <strong>restricted</strong> by the <a href="/../api/limits#field-content-size">Field content size limit</a>.
* This constraint is enforced at both <a href="/../api/projects/products#create-product">Product creation</a> and <a href="/../api/projects/products#update-product">Product update</a>.
* This constraint is enforced at both <a href="ctp:api:endpoint:/{projectKey}/products:POST">Product creation</a> and <a href="/../api/projects/products#update-product">Product update</a>.
* If the length of the input exceeds the maximum size, an <a href="ctp:api:type:InvalidFieldError">InvalidField</a> error is returned.</p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public function getInputHint()
* <p>If <code>true</code>, the Attribute's values are available for the <a href="/../api/projects/products-search">Product Projections Search API</a> for use in full-text search queries, filters, and facets.</p>
* <p>Which exact features are available with this flag depends on the specific <a href="ctp:api:type:AttributeType">AttributeType</a>.
* The maximum size of a searchable field is <strong>restricted</strong> by the <a href="/../api/limits#field-content-size">Field content size limit</a>.
* This constraint is enforced at both <a href="/../api/projects/products#create-product">Product creation</a> and <a href="/../api/projects/products#update-product">Product update</a>.
* This constraint is enforced at both <a href="ctp:api:endpoint:/{projectKey}/products:POST">Product creation</a> and <a href="/../api/projects/products#update-product">Product update</a>.
* If the length of the input exceeds the maximum size, an <a href="ctp:api:type:InvalidFieldError">InvalidField</a> error is returned.</p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ public function getInputHint()
* <p>If <code>true</code>, the Attribute's values are available for the <a href="/../api/projects/products-search">Product Projections Search API</a> for use in full-text search queries, filters, and facets.</p>
* <p>Which exact features are available with this flag depends on the specific <a href="ctp:api:type:AttributeType">AttributeType</a>.
* The maximum size of a searchable field is <strong>restricted</strong> by the <a href="/../api/limits#field-content-size">Field content size limit</a>.
* This constraint is enforced at both <a href="/../api/projects/products#create-product">Product creation</a> and <a href="/../api/projects/products#update-product">Product update</a>.
* This constraint is enforced at both <a href="ctp:api:endpoint:/{projectKey}/products:POST">Product creation</a> and <a href="/../api/projects/products#update-product">Product update</a>.
* If the length of the input exceeds the maximum size, an <a href="ctp:api:type:InvalidFieldError">InvalidField</a> error is returned.</p>
*
*
Expand Down
1 change: 1 addition & 0 deletions references.txt
Original file line number Diff line number Diff line change
Expand Up @@ -182,3 +182,4 @@ d216fff1d56706c8f7cb20b8c9d10b917b8f7781
580c5cde461a20eb43322d6bb592ac2de30eb61f
abf2e5abe5909b6f2f44aa192852d2a12c5aa519
d54ef63fe5ba7eac24c714f805b0a0dbe4315fb7
281ab8a36f5fd144e39212855c2991eaeb29407a

0 comments on commit 2688ccf

Please sign in to comment.