/**
* Deletes a transaction from the customer account specified in the request.
*
* @param int $accountId Unique identifier of the customer account.
* @param string $transactionId Unique identifier of the transaction to delete.
*/
public static function removeTransactionClient($accountId, $transactionId)
{
$url = TransactionUrl::removeTransactionUrl($accountId, $transactionId);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Deletes the location type specified in the request.
*
* @param string $locationTypeCode The user-defined code that identifies the location type.
*/
public static function deleteLocationTypeClient($locationTypeCode)
{
$url = LocationTypeUrl::deleteLocationTypeUrl($locationTypeCode);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Retrieves a collection of entity containers. Each container holds a set of entities per ID.
*
* @param string $entityListFullName The full name of the EntityList including namespace in name@nameSpace format
* @param string $filter A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. Valid operators include equals (eq), does not equal (ne), greater than (gt), less than (lt), greater than or equal to (ge), less than or equal to (le), starts with (sw), or contains (cont). For example - "filter=IsDisplayed+eq+true"
* @param int $pageSize The number of results to display on each page when creating paged results from a query. The amount is divided and displayed on the `pageCount `amount of pages. The default is 20 and maximum value is 200 per page.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param string $sortBy The element to sort the results by and the channel in which the results appear. Either ascending (a-z) or descending (z-a) channel. Optional.
* @param int $startIndex When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a `pageSize `of 25, to get the 51st through the 75th items, use `startIndex=3`.
* @return MozuClient
*/
public static function getEntityContainersClient($entityListFullName, $pageSize = null, $startIndex = null, $filter = null, $sortBy = null, $responseFields = null)
{
$url = EntityContainerUrl::getEntityContainersUrl($entityListFullName, $filter, $pageSize, $responseFields, $sortBy, $startIndex);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Modifies properties of the discount target, for example, the dollar amount, or precentage off the price.
*
* @param int $discountId Unique identifier of the discount. System-supplied and read only.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param DiscountTarget $discountTarget Properties of the target to which the discount applies, such as the type of discount and which products, categories, or shipping methods are eligible for the discount and the properties of this discount target.
* @return MozuClient
*/
public static function updateDiscountTargetClient($discountTarget, $discountId, $responseFields = null)
{
$url = DiscountTargetUrl::updateDiscountTargetUrl($discountId, $responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($discountTarget);
return $mozuClient;
}
/**
* Suggests possible search terms as the shopper enters search text.
*
* @param string $groups
* @param int $pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200.
* @param string $query A query entered for searches and facet range.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return MozuClient
*/
public static function suggestClient($query = null, $groups = null, $pageSize = null, $responseFields = null)
{
$url = ProductSearchResultUrl::suggestUrl($groups, $pageSize, $query, $responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Initializes an application with the necessary configured settings.
*
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param Application $application Properties of an application installed in a tenant.
* @return MozuClient
*/
public static function thirdPartyUpdateApplicationClient($application, $responseFields = null)
{
$url = ApplicationUrl::thirdPartyUpdateApplicationUrl($responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($application);
return $mozuClient;
}
/**
* Deletes a shipment for a return replacement.
*
* @param string $returnId Unique identifier of the return whose items you want to get.
* @param string $shipmentId Unique identifier of the shipment to retrieve.
*/
public static function deleteShipmentClient($returnId, $shipmentId)
{
$url = ShipmentUrl::deleteShipmentUrl($returnId, $shipmentId);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Updates the location usage for the site based on the location usage code specified in the request.
*
* @param string $code User-defined code that uniqely identifies the channel group.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param LocationUsage $usage Configuration properties of a location usage type for a specified site. The direct ship location usage type consists of a single location that represents location that supports direct ship (DS) fulfillment. The in-store pickup location usage type consists of a list of location types that represent locations that support in-store pickup (SP) fulfillment. The store finder location usage type consists of a list of location codes, location types, or both.
* @return MozuClient
*/
public static function updateLocationUsageClient($usage, $code, $responseFields = null)
{
$url = LocationUsageUrl::updateLocationUsageUrl($code, $responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($usage);
return $mozuClient;
}
/**
* Updates one or more taxable territories configured for a site.
*
* @param array|TaxableTerritory $taxableterritories Properties of the territory which is subject to sales tax.
* @return MozuClient
*/
public static function updateTaxableTerritoriesClient($taxableterritories)
{
$url = TaxableTerritoryUrl::updateTaxableTerritoriesUrl();
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($taxableterritories);
return $mozuClient;
}
/**
* Updates a site's general global settings.
*
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param GeneralSettings $generalSettings General settings used on the storefront site.
* @return MozuClient
*/
public static function updateGeneralSettingsClient($generalSettings, $responseFields = null)
{
$url = GeneralSettingsUrl::updateGeneralSettingsUrl($responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($generalSettings);
return $mozuClient;
}
/**
* Removes a single message associated with the cart of the current shopper.
*
* @param string $messageId Identifier of the message to remove from the cart.
*/
public static function removeMessageClient($messageId)
{
$url = ChangeMessageUrl::removeMessageUrl($messageId);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Updates a DocumentListType
*
* @param string $documentListTypeFQN
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param DocumentListType $list Properties for the document list type. Document lists contain documents with an associated document type, such as web pages.
* @return MozuClient
*/
public static function updateDocumentListTypeClient($list, $documentListTypeFQN, $responseFields = null)
{
$url = DocumentListTypeUrl::updateDocumentListTypeUrl($documentListTypeFQN, $responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($list);
return $mozuClient;
}
/**
* Retrieve details about a specific tenant by providing the tenant ID.
*
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param int $tenantId Unique identifier of the Mozu tenant.
* @return MozuClient
*/
public static function getTenantClient($tenantId, $responseFields = null)
{
$url = TenantUrl::getTenantUrl($responseFields, $tenantId);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Retrieves a list of attribute type rules according to optional filter criteria and sort options. Attribute type rules help drive the behavior of attributes on a storefront page.
*
* @param string $filter A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. Valid operators include equals (eq), does not equal (ne), greater than (gt), less than (lt), greater than or equal to (ge), less than or equal to (le), starts with (sw), or contains (cont). For example - "filter=IsDisplayed+eq+true"
* @param int $pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param string $sortBy
* @param int $startIndex
* @return MozuClient
*/
public static function getAttributeTypeRulesClient($startIndex = null, $pageSize = null, $sortBy = null, $filter = null, $responseFields = null)
{
$url = AttributeTypeRuleUrl::getAttributeTypeRulesUrl($filter, $pageSize, $responseFields, $sortBy, $startIndex);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Removes a price adjustment from the specified order.
*
* @param string $orderId Unique identifier of the order.
* @param string $updateMode Specifies whether to update the original order, update the order in draft mode, or update the order in draft mode and then commit the changes to the original. Draft mode enables users to make incremental order changes before committing the changes to the original order. Valid values are "ApplyToOriginal," "ApplyToDraft," or "ApplyAndCommit."
* @param string $version System-supplied integer that represents the current version of the order, which prevents users from unintentionally overriding changes to the order. When a user performs an operation for a defined order, the system validates that the version of the updated order matches the version of the order on the server. After the operation completes successfully, the system increments the version number by one.
* @return MozuClient
*/
public static function removeAdjustmentClient($orderId, $updateMode = null, $version = null)
{
$url = AdjustmentUrl::removeAdjustmentUrl($orderId, $updateMode, $version);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Retrieves the shipping rates applicable for the site.
*
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param RateRequest $rateRequest Properties required to request a shipping rate calculation.
* @return MozuClient
*/
public static function getRatesClient($rateRequest, $responseFields = null)
{
$url = ShippingUrl::getRatesUrl($responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($rateRequest);
return $mozuClient;
}
/**
* orders-orderrefunds Put ResendRefundEmail description DOCUMENT_HERE
*
* @param string $orderId Unique identifier of the order.
* @param string $refundId
*/
public static function resendRefundEmailClient($orderId, $refundId)
{
$url = RefundUrl::resendRefundEmailUrl($orderId, $refundId);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Updates one or more properties of fulfillment information for the specified order.
*
* @param string $orderId Unique identifier of the order.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param string $updateMode Specifies whether to update the original order, update the order in draft mode, or update the order in draft mode and then commit the changes to the original. Draft mode enables users to make incremental order changes before committing the changes to the original order. Valid values are "ApplyToOriginal," "ApplyToDraft," or "ApplyAndCommit."
* @param string $version System-supplied integer that represents the current version of the order, which prevents users from unintentionally overriding changes to the order. When a user performs an operation for a defined order, the system validates that the version of the updated order matches the version of the order on the server. After the operation completes successfully, the system increments the version number by one.
* @param FulfillmentInfo $fulfillmentInfo Properties of the information needed to fulfill an order, whether via in-store pickup or direct shipping.
* @return MozuClient
*/
public static function setFulFillmentInfoClient($fulfillmentInfo, $orderId, $updateMode = null, $version = null, $responseFields = null)
{
$url = FulfillmentInfoUrl::setFulFillmentInfoUrl($orderId, $responseFields, $updateMode, $version);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($fulfillmentInfo);
return $mozuClient;
}
/**
* Deletes an authentication for an application based on the specified refresh token.
*
* @param string $refreshToken Alphanumeric string used for access tokens. This token refreshes access for accounts by generating a new developer or application account authentication ticket after an access token expires.
*/
public static function deleteAppAuthTicketClient($refreshToken)
{
$url = AuthTicketUrl::deleteAppAuthTicketUrl($refreshToken);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* platform-extensions Put UpdateExtensions description DOCUMENT_HERE
*
* @param string $responseFields A list or array of fields returned for a call. These fields may be customized and may be used for various types of data calls in Mozu. For example, responseFields are returned for retrieving or updating attributes, carts, and messages in Mozu.
* @param TenantExtensions $extensions Mozu.InstalledApplications.Contracts.TenantExtensions ApiType DOCUMENT_HERE
* @return MozuClient
*/
public static function updateExtensionsClient($extensions, $responseFields = null)
{
$url = TenantExtensionsUrl::updateExtensionsUrl($responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($extensions);
return $mozuClient;
}
/**
* Retrieve a customer attribute definition by supplying its fully qualified name.
*
* @param string $attributeFQN The fully qualified name of the attribute, which is a user defined attribute identifier.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return MozuClient
*/
public static function getAttributeClient($attributeFQN, $responseFields = null)
{
$url = AttributeUrl::getAttributeUrl($attributeFQN, $responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Retrieves the details of the third-party payment service workflows configured for the site.
*
* @return MozuClient
*/
public static function getThirdPartyPaymentWorkflowsClient()
{
$url = PaymentSettingsUrl::getThirdPartyPaymentWorkflowsUrl();
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Retrieves the list of audit entries for the credit, according to any filter or sort criteria specified in the request.
*
* @param string $code User-defined code that uniqely identifies the channel group.
* @param string $filter A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. Valid operators include equals (eq), does not equal (ne), greater than (gt), less than (lt), greater than or equal to (ge), less than or equal to (le), starts with (sw), or contains (cont). For example - "filter=IsDisplayed+eq+true"
* @param int $pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param string $sortBy The property by which to sort results and whether the results appear in ascending (a-z) order, represented by ASC or in descending (z-a) order, represented by DESC. The sortBy parameter follows an available property. For example: "sortBy=productCode+asc"
* @param int $startIndex When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, use startIndex=3.
* @return MozuClient
*/
public static function getAuditEntriesClient($code, $startIndex = null, $pageSize = null, $sortBy = null, $filter = null, $responseFields = null)
{
$url = CreditAuditEntryUrl::getAuditEntriesUrl($code, $filter, $pageSize, $responseFields, $sortBy, $startIndex);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Deletes the content associated with a document, such as a product image or PDF specifications file.
*
* @param string $documentListName Name of content documentListName to delete
* @param string $documentName The name of the document in the site.
* @param Stream $stream Data stream that delivers information. Used to input and output data.
*/
public static function deleteTreeDocumentContentClient($stream, $documentListName, $documentName, $contentType = null)
{
$url = DocumentTreeUrl::deleteTreeDocumentContentUrl($documentListName, $documentName);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withStreamBody($stream)->withHeader(Headers::CONTENT_TYPE, $contentType);
return $mozuClient;
}
/**
* Retrieves a list of the shipping settings configured for a site.
*
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return MozuClient
*/
public static function getSiteShippingSettingsClient($responseFields = null)
{
$url = SiteShippingSettingsUrl::getSiteShippingSettingsUrl($responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* payments-cards Delete Delete description DOCUMENT_HERE
*
* @param string $cardId Unique identifier of the card associated with the customer account billing contact.
*/
public static function deleteClient($cardId)
{
$url = PublicCardUrl::deleteUrl($cardId);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Removes a previously defined record in the Mozu database.
*
* @param string $dbEntryQuery The database entry string to create.
*/
public static function deleteDBValueClient($dbEntryQuery)
{
$url = SiteDataUrl::deleteDBValueUrl($dbEntryQuery);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
/**
* Validates the customer address supplied in the request.
*
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param AddressValidationRequest $addressValidationRequest Properties of the address used for validation of the account's full address. This content may include multiple lines of an address, city, state/province, zip/postal code, and country.
* @return MozuClient
*/
public static function validateAddressClient($addressValidationRequest, $responseFields = null)
{
$url = AddressValidationRequestUrl::validateAddressUrl($responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($addressValidationRequest);
return $mozuClient;
}
/**
* Modifies existing site checkout settings. Modify Payment, Customer Checkout, and Order Processing settings in one PUT.
*
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param CustomerCheckoutSettings $customerCheckoutSettings The properties of the customer checkout settings such as whether shoppers must be logged in.
* @return MozuClient
*/
public static function updateCustomerCheckoutSettingsClient($customerCheckoutSettings, $responseFields = null)
{
$url = CustomerCheckoutSettingsUrl::updateCustomerCheckoutSettingsUrl($responseFields);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url)->withBody($customerCheckoutSettings);
return $mozuClient;
}
/**
* Retrieves the list of segments associated with a customer account.
*
* @param int $accountId Unique identifier of the customer account.
* @param string $filter A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. Valid operators include equals (eq), does not equal (ne), greater than (gt), less than (lt), greater than or equal to (ge), less than or equal to (le), starts with (sw), or contains (cont). For example - "filter=IsDisplayed+eq+true"
* @param int $pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param string $sortBy The property by which to sort results and whether the results appear in ascending (a-z) order, represented by ASC or in descending (z-a) order, represented by DESC. The sortBy parameter follows an available property. For example: "sortBy=productCode+asc"
* @param int $startIndex When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, use startIndex=3.
* @return MozuClient
*/
public static function getAccountSegmentsClient($accountId, $startIndex = null, $pageSize = null, $sortBy = null, $filter = null, $responseFields = null)
{
$url = CustomerSegmentUrl::getAccountSegmentsUrl($accountId, $filter, $pageSize, $responseFields, $sortBy, $startIndex);
$mozuClient = new MozuClient();
$mozuClient->withResourceUrl($url);
return $mozuClient;
}
