diff --git a/Mozu.Api.Test/Factories/AddressValidationFactory.cs b/Mozu.Api.Test/Factories/AddressValidationFactory.cs deleted file mode 100644 index 0217a9bd..00000000 --- a/Mozu.Api.Test/Factories/AddressValidationFactory.cs +++ /dev/null @@ -1,75 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Address Validation resource to validate addresses associated with a customer account contact. - /// - public partial class AddressValidationFactory : BaseDataFactory - { - - /// - /// Validates the customer address supplied in the request. - /// - /// - /// var result = AddressValidationFactory.ValidateAddress(handler : handler, addressValidationRequest : addressValidationRequest, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Customer.AddressValidationResponse ValidateAddress(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.Customer.AddressValidationRequest addressValidationRequest, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Customer.AddressValidationRequestClient.ValidateAddressClient( - addressValidationRequest : addressValidationRequest, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/AppAuthTicketFactory.cs b/Mozu.Api.Test/Factories/AppAuthTicketFactory.cs deleted file mode 100644 index 47bc8e08..00000000 --- a/Mozu.Api.Test/Factories/AppAuthTicketFactory.cs +++ /dev/null @@ -1,150 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Authetickets for applications resource to manage authentication tickets for your apps. - /// - public partial class AppAuthTicketFactory : BaseDataFactory - { - - /// - /// Generate an authentication ticket for an application. - /// - /// - /// var result = AppAuthTicketFactory.AuthenticateApp(handler : handler, appAuthInfo : appAuthInfo, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.AuthTicket AuthenticateApp(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.AppDev.AppAuthInfo appAuthInfo, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Applications.AuthTicketClient.AuthenticateAppClient( - appAuthInfo : appAuthInfo, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Refreshes the application's authentication ticket and generates a new access token by providing the refresh token string. - /// - /// - /// var result = AppAuthTicketFactory.RefreshAppAuthTicket(handler : handler, authTicketRequest : authTicketRequest, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.AuthTicket RefreshAppAuthTicket(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.AppDev.AuthTicketRequest authTicketRequest, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Applications.AuthTicketClient.RefreshAppAuthTicketClient( - authTicketRequest : authTicketRequest, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Deletes an authentication for an application based on the specified refresh token. - /// - /// - /// var result = AppAuthTicketFactory.DeleteAppAuthTicket(handler : handler, refreshToken : refreshToken, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static void DeleteAppAuthTicket(ServiceClientMessageHandler handler, - string refreshToken, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Applications.AuthTicketClient.DeleteAppAuthTicketClient( - refreshToken : refreshToken ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/AppAuthTicketsFactory.cs b/Mozu.Api.Test/Factories/AppAuthTicketsFactory.cs deleted file mode 100644 index 40f29d17..00000000 --- a/Mozu.Api.Test/Factories/AppAuthTicketsFactory.cs +++ /dev/null @@ -1,150 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Authetickets for applications resource to manage authentication tickets for your apps. - /// - public partial class AppAuthTicketsFactory : BaseDataFactory - { - - /// - /// Generate an authentication ticket for an application. - /// - /// - /// var result = AppAuthTicketsFactory.AuthenticateApp(handler : handler, appAuthInfo : appAuthInfo, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.AuthTicket AuthenticateApp(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.AppDev.AppAuthInfo appAuthInfo, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Applications.AppAuthTicketsClient.AuthenticateAppClient( - appAuthInfo : appAuthInfo, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Refreshes the application's authentication ticket and generates a new access token by providing the refresh token string. - /// - /// - /// var result = AppAuthTicketsFactory.RefreshAppAuthTicket(handler : handler, authTicketRequest : authTicketRequest, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.AuthTicket RefreshAppAuthTicket(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.AppDev.AuthTicketRequest authTicketRequest, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Applications.AppAuthTicketsClient.RefreshAppAuthTicketClient( - authTicketRequest : authTicketRequest, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Deletes an authentication for an application based on the specified refresh token. - /// - /// - /// var result = AppAuthTicketsFactory.DeleteAppAuthTicket(handler : handler, refreshToken : refreshToken, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static void DeleteAppAuthTicket(ServiceClientMessageHandler handler, - string refreshToken, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Applications.AppAuthTicketsClient.DeleteAppAuthTicketClient( - refreshToken : refreshToken ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/ApplicationVersionFactory.cs b/Mozu.Api.Test/Factories/ApplicationVersionFactory.cs deleted file mode 100644 index 20859e31..00000000 --- a/Mozu.Api.Test/Factories/ApplicationVersionFactory.cs +++ /dev/null @@ -1,529 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Applications resource to manage the applications associated with a developer account. - /// - public partial class ApplicationVersionFactory : BaseDataFactory - { - - /// - /// Retrieves the list of applications associated with the developer account scoped to the user claim specified in the request. - /// - /// - /// var result = ApplicationVersionFactory.GetAllApplications(handler : handler, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.ApplicationCollection GetAllApplications(ServiceClientMessageHandler handler, - - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.GetAllApplicationsClient( - ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the details of the application specified in the request. The application specified in the request must be associated with the developer account scoped to the user claim specified in the request header, otherwise the operation returns an error. - /// - /// - /// var result = ApplicationVersionFactory.GetApplication(handler : handler, applicationId : applicationId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.Application GetApplication(ServiceClientMessageHandler handler, - int? applicationId = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.GetApplicationClient( - applicationId : applicationId ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the details of a specific version of an application associated with the developer account scoped to the user claim specified in the request. - /// - /// - /// var result = ApplicationVersionFactory.GetApplicationVersion(handler : handler, applicationVersionId : applicationVersionId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.ApplicationVersion GetApplicationVersion(ServiceClientMessageHandler handler, - int applicationVersionId, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.GetApplicationVersionClient( - applicationVersionId : applicationVersionId ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves a list of the package definitions created for an application version, including all development packages and release packages. The application must be associated with the developer account scoped to the user claim specified in the request. - /// - /// - /// var result = ApplicationVersionFactory.GetPackages(handler : handler, applicationVersionId : applicationVersionId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.PackageCollection GetPackages(ServiceClientMessageHandler handler, - int applicationVersionId, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.GetPackagesClient( - applicationVersionId : applicationVersionId ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the details of a package definition associated with an application version. The application ust be associated with the developer account scoped to the user claim specified in the request. - /// - /// - /// var result = ApplicationVersionFactory.GetPackage(handler : handler, applicationVersionId : applicationVersionId, packageId : packageId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.Package GetPackage(ServiceClientMessageHandler handler, - int applicationVersionId, int packageId, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.GetPackageClient( - applicationVersionId : applicationVersionId, packageId : packageId ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the metadata for items in a package associated with an application version, including a list of all files and subfolders. The application must be associated with the developer account acoped to the user claim specified in the request. - /// - /// - /// var result = ApplicationVersionFactory.GetPackageItemsMetadata(handler : handler, applicationVersionId : applicationVersionId, packageId : packageId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.FolderMetadata GetPackageItemsMetadata(ServiceClientMessageHandler handler, - int applicationVersionId, int packageId, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.GetPackageItemsMetadataClient( - applicationVersionId : applicationVersionId, packageId : packageId ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the metadata of a file in a package for an application version. The application must be associated with the developer account scoped to the user claim specified in the request. - /// - /// - /// var result = ApplicationVersionFactory.GetPackageItemMetadata(handler : handler, applicationVersionId : applicationVersionId, packageId : packageId, itempath : itempath, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.FileMetadata GetPackageItemMetadata(ServiceClientMessageHandler handler, - int applicationVersionId, int packageId, string itempath, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.GetPackageItemMetadataClient( - applicationVersionId : applicationVersionId, packageId : packageId, itempath : itempath ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// - /// - /// - /// var result = ApplicationVersionFactory.GetPackageFilesZip(handler : handler, applicationVersionId : applicationVersionId, packageId : packageId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static System.IO.Stream GetPackageFilesZip(ServiceClientMessageHandler handler, - int applicationVersionId, int packageId, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.GetPackageFilesZipClient( - applicationVersionId : applicationVersionId, packageId : packageId ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Creates a new development or release package for the application version specified in the request. - /// - /// - /// var result = ApplicationVersionFactory.AddPackage(handler : handler, pkg : pkg, applicationVersionId : applicationVersionId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.Package AddPackage(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.AppDev.Package pkg, int applicationVersionId, - HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.AddPackageClient( - pkg : pkg, applicationVersionId : applicationVersionId ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// - /// - /// - /// var result = ApplicationVersionFactory.ChangePackageFileNameOrPath(handler : handler, renameInfo : renameInfo, applicationVersionId : applicationVersionId, packageId : packageId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.FileMetadata ChangePackageFileNameOrPath(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.AppDev.RenameInfo renameInfo, int applicationVersionId, int packageId, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.ChangePackageFileNameOrPathClient( - renameInfo : renameInfo, applicationVersionId : applicationVersionId, packageId : packageId ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Uploads a file to a defined package for an application version in the file location specified in the request. - /// - /// - /// var result = ApplicationVersionFactory.AddPackageFile(handler : handler, stream : stream, applicationVersionId : applicationVersionId, packageId : packageId, filepath : filepath, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.FileMetadata AddPackageFile(ServiceClientMessageHandler handler, - System.IO.Stream stream, int applicationVersionId, int packageId, string filepath, - HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.AddPackageFileClient( - stream : stream, applicationVersionId : applicationVersionId, packageId : packageId, filepath : filepath ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Updates one or more properties of a file in a package associated with an application version. - /// - /// - /// var result = ApplicationVersionFactory.UpdatePackageFile(handler : handler, stream : stream, applicationVersionId : applicationVersionId, packageId : packageId, filepath : filepath, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.FileMetadata UpdatePackageFile(ServiceClientMessageHandler handler, - System.IO.Stream stream, int applicationVersionId, int packageId, string filepath, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.UpdatePackageFileClient( - stream : stream, applicationVersionId : applicationVersionId, packageId : packageId, filepath : filepath ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Deletes the specified file from a package associated with an application version. - /// - /// - /// var result = ApplicationVersionFactory.DeletePackageFile(handler : handler, applicationVersionId : applicationVersionId, packageId : packageId, filepath : filepath, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static void DeletePackageFile(ServiceClientMessageHandler handler, - int applicationVersionId, int packageId, string filepath, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.ApplicationVersionClient.DeletePackageFileClient( - applicationVersionId : applicationVersionId, packageId : packageId, filepath : filepath ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/CheckoutSettingFactory.cs b/Mozu.Api.Test/Factories/CheckoutSettingFactory.cs deleted file mode 100644 index a42f71d2..00000000 --- a/Mozu.Api.Test/Factories/CheckoutSettingFactory.cs +++ /dev/null @@ -1,75 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Checkout Settings resource to specify the site-wide settings that define checkout and order processing behavior. This resource includes subresources for payment settings, customer checkout settings, and order processing settings. - /// - public partial class CheckoutSettingFactory : BaseDataFactory - { - - /// - /// Retrieves all checkout settings defined for the site including payment settings (payment gateway ID and credentials), shopper checkout settings (login requirement or guest mode and custom attributes), and order processing settings (when payment is authorized and captured plus any custom attributes). - /// - /// - /// var result = CheckoutSettingFactory.GetCheckoutSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.SiteSettings.Order.CheckoutSettings GetCheckoutSettings(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.CheckoutSettingsClient.GetCheckoutSettingsClient( - responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/LocationAdminFactory.cs b/Mozu.Api.Test/Factories/Commerce/Admin/LocationAdminFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/LocationAdminFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Admin/LocationAdminFactory.cs index fe8fa974..2702c1f7 --- a/Mozu.Api.Test/Factories/LocationAdminFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Admin/LocationAdminFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Admin { /// /// Use the Locations resource to manage each physical location associated with a tenant. Locations enable tenants to associate a physical address with product inventory, provide a store finder for in-store pickup, or both. Locations that support inventory can use both direct ship and in-store pickup fulfillment types. @@ -30,7 +31,7 @@ public partial class LocationAdminFactory : BaseDataFactory { /// - /// Retrieves a list of all locations associated with a tenant, according to any filter and sort criteria specified in the request. + /// /// /// /// var result = LocationFactory.GetLocations(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Location.LocationCollection GetLocations(Servic startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Location.LocationCollection GetLocations(Servic } /// - /// Retrieves the details of the location specified in the request by location code. + /// /// /// /// var result = LocationFactory.GetLocation(handler : handler, locationCode : locationCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Location.Location GetLocation(ServiceClientMess locationCode : locationCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Location.Location GetLocation(ServiceClientMess } /// - /// Creates a new physical location for the tenant specified in the request header. + /// /// /// /// var result = LocationFactory.AddLocation(handler : handler, location : location, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Location.Location AddLocation(ServiceClientMess location : location, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Location.Location AddLocation(ServiceClientMess } /// - /// Updates one or more details of a the location specified in the request by location code. + /// /// /// /// var result = LocationFactory.UpdateLocation(handler : handler, location : location, locationCode : locationCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Location.Location UpdateLocation(ServiceClientM location : location, locationCode : locationCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Location.Location UpdateLocation(ServiceClientM } /// - /// Deletes the location specified in the request. + /// /// /// /// var result = LocationFactory.DeleteLocation(handler : handler, locationCode : locationCode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteLocation(ServiceClientMessageHandler handler, locationCode : locationCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/LocationTypeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Admin/LocationTypeFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/LocationTypeFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Admin/LocationTypeFactory.cs index 413b0b38..80b97711 --- a/Mozu.Api.Test/Factories/LocationTypeFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Admin/LocationTypeFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Admin { /// /// Use the Location Types resource to manage the types of locations your tenant maintains, such as warehouses, physical storefronts, and kiosks. @@ -30,7 +31,7 @@ public partial class LocationTypeFactory : BaseDataFactory { /// - /// Retrieve a list of all location types defined for the tenant. + /// /// /// /// var result = LocationTypeFactory.GetLocationTypes(handler : handler, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class LocationTypeFactory : BaseDataFactory ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class LocationTypeFactory : BaseDataFactory } /// - /// Retrieves the details of the location type specified in the request. + /// /// /// /// var result = LocationTypeFactory.GetLocationType(handler : handler, locationTypeCode : locationTypeCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Location.LocationType GetLocationType(ServiceCl locationTypeCode : locationTypeCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Location.LocationType GetLocationType(ServiceCl } /// - /// Creates a new location type based on the information specified in the request. + /// /// /// /// var result = LocationTypeFactory.AddLocationType(handler : handler, locationType : locationType, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Location.LocationType AddLocationType(ServiceCl locationType : locationType, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Location.LocationType AddLocationType(ServiceCl } /// - /// Updates the name of a defined location type. + /// /// /// /// var result = LocationTypeFactory.UpdateLocationType(handler : handler, locationType : locationType, locationTypeCode : locationTypeCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Location.LocationType UpdateLocationType(Servic locationType : locationType, locationTypeCode : locationTypeCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Location.LocationType UpdateLocationType(Servic } /// - /// Deletes the location type specified in the request. + /// /// /// /// var result = LocationTypeFactory.DeleteLocationType(handler : handler, locationTypeCode : locationTypeCode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteLocationType(ServiceClientMessageHandler handler, locationTypeCode : locationTypeCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/Commerce/Admin/Locations/Attributedefinition/AttributeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Admin/Locations/Attributedefinition/AttributeFactory.cs new file mode 100755 index 00000000..266be02f --- /dev/null +++ b/Mozu.Api.Test/Factories/Commerce/Admin/Locations/Attributedefinition/AttributeFactory.cs @@ -0,0 +1,228 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#region Usings Setup + +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Net; +using Mozu.Api; +using Mozu.Api.Security; +using Mozu.Api.Test.Helpers; +using System.Diagnostics; +using Newtonsoft.Json.Linq; +using System.Threading; + +#endregion + +namespace Mozu.Api.Test.Factories.Commerce.Admin.Locations.Attributedefinition +{ + /// + /// + /// + public partial class AttributeFactory : BaseDataFactory + { + + /// + /// + /// + /// + /// var result = AttributeFactory.GetAttributes(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttributes(ServiceClientMessageHandler handler, + int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.GetAttributesClient( + startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.GetAttributeVocabularyValues(handler : handler, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); + /// return optionalCasting; + /// + /// + /// + public static List GetAttributeVocabularyValues(ServiceClientMessageHandler handler, + string attributeFQN, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.GetAttributeVocabularyValuesClient( + attributeFQN : attributeFQN ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.GetAttribute(handler : handler, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.Attribute GetAttribute(ServiceClientMessageHandler handler, + string attributeFQN, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.GetAttributeClient( + attributeFQN : attributeFQN, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.CreateAttribute(handler : handler, attribute : attribute, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.Attribute CreateAttribute(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.CreateAttributeClient( + attribute : attribute, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.UpdateAttribute(handler : handler, attribute : attribute, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.Attribute UpdateAttribute(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.UpdateAttributeClient( + attribute : attribute, attributeFQN : attributeFQN, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + + } + +} + + diff --git a/Mozu.Api.Test/Factories/CartFactory.cs b/Mozu.Api.Test/Factories/Commerce/CartFactory.cs old mode 100644 new mode 100755 similarity index 88% rename from Mozu.Api.Test/Factories/CartFactory.cs rename to Mozu.Api.Test/Factories/Commerce/CartFactory.cs index a8a11a88..0c599de6 --- a/Mozu.Api.Test/Factories/CartFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/CartFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce { /// - /// Use this resource to manage storefront shopping carts as shoppers add and remove items for purchase. Each time a shopper's cart is modified, the Carts resource updates the estimated total with any applicable discounts. + /// Use the Carts resource to manage storefront shopping carts as items are added and removed. Each time a shopper's cart is modified, the Carts resource updates the estimated total with any applicable discounts. /// public partial class CartFactory : BaseDataFactory { /// - /// Retrieves the cart specified in the request. + /// /// /// /// var result = CartFactory.GetCart(handler : handler, cartId : cartId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetCart(ServiceClien cartId : cartId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetCart(ServiceClien } /// - /// Retrieves a cart's contents for the current shopper. If the shopper does not have an active cart on the site, the service creates one. + /// /// /// /// var result = CartFactory.GetOrCreateCart(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetOrCreateCart(Serv responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetOrCreateCart(Serv } /// - /// Retrieves summary information associated with the cart of the current shopper, including the number of items, the current total, and whether the cart has expired. All anonymous idle carts that do not proceed to checkout expire after 14 days. + /// /// /// /// var result = CartFactory.GetCartSummary(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartSummary GetCartSummar responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartSummary GetCartSummar } /// - /// Retrieves summary information associated with the cart of user specified in the request, including the number of items in the cart, the current total, and whether the cart has expired. All anonymous idle carts that do not proceed to checkout expire after 14 days. + /// /// /// /// var result = CartFactory.GetUserCartSummary(handler : handler, userId : userId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartSummary GetUserCartSu userId : userId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartSummary GetUserCartSu } /// - /// Retrieves the cart of the user specified in the request. + /// /// /// /// var result = CartFactory.GetUserCart(handler : handler, userId : userId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetUserCart(ServiceC userId : userId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetUserCart(ServiceC } /// - /// Update the current shopper's cart. + /// /// /// /// var result = CartFactory.UpdateCart(handler : handler, cart : cart, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart UpdateCart(ServiceCl cart : cart, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart UpdateCart(ServiceCl } /// - /// Deletes the cart specified in the request. + /// /// /// /// var result = CartFactory.DeleteCart(handler : handler, cartId : cartId, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static void DeleteCart(ServiceClientMessageHandler handler, cartId : cartId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -295,7 +296,7 @@ public static void DeleteCart(ServiceClientMessageHandler handler, } /// - /// Deletes the cart of the currently active shopper. + /// /// /// /// var result = CartFactory.DeleteCurrentCart(handler : handler, expectedCode: expectedCode, successCode: successCode); @@ -316,7 +317,7 @@ public static void DeleteCurrentCart(ServiceClientMessageHandler handler, ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AppliedDiscountCartsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Carts/AppliedDiscountCartsFactory.cs old mode 100644 new mode 100755 similarity index 89% rename from Mozu.Api.Test/Factories/AppliedDiscountCartsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Carts/AppliedDiscountCartsFactory.cs index 17b84c96..0c07f1c1 --- a/Mozu.Api.Test/Factories/AppliedDiscountCartsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Carts/AppliedDiscountCartsFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Carts { /// - /// Use the Cart Coupons subresource to apply a coupon to a defined cart or remove a coupon from a cart. When the shopper proceeds to checkout, the coupons applied to the cart apply to the order. + /// Use the Cart Coupons resource to apply a coupon to a defined cart or remove a coupon from a cart. When the shopper proceeds to checkout, the coupons applied to the cart apply to the order. /// public partial class AppliedDiscountCartsFactory : BaseDataFactory { /// - /// Applies a defined coupon to the cart specified in the request. + /// /// /// /// var result = AppliedDiscountFactory.ApplyCoupon(handler : handler, cartId : cartId, couponCode : couponCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart ApplyCoupon(ServiceC cartId : cartId, couponCode : couponCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart ApplyCoupon(ServiceC } /// - /// Removes all coupons from the cart specified in the request. + /// /// /// /// var result = AppliedDiscountFactory.RemoveCoupons(handler : handler, cartId : cartId, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveCoupons(Servic cartId : cartId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveCoupons(Servic } /// - /// Removes an applied coupon from the cart specified in the request. + /// /// /// /// var result = AppliedDiscountFactory.RemoveCoupon(handler : handler, cartId : cartId, couponCode : couponCode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveCoupon(Service cartId : cartId, couponCode : couponCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CartItemFactory.cs b/Mozu.Api.Test/Factories/Commerce/Carts/CartItemFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/CartItemFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Carts/CartItemFactory.cs index 498adce8..950178c0 --- a/Mozu.Api.Test/Factories/CartItemFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Carts/CartItemFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Carts { /// /// Use the Cart Items subresource to manage a collection of items in an active shopping cart. @@ -30,7 +31,7 @@ public partial class CartItemFactory : BaseDataFactory { /// - /// Retrieves a particular cart item by providing the cart item ID. + /// /// /// /// var result = CartItemFactory.GetCartItem(handler : handler, cartItemId : cartItemId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem GetCartItem(Serv cartItemId : cartItemId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem GetCartItem(Serv } /// - /// Retrieves a list of cart items including the total number of items in the cart. + /// /// /// /// var result = CartItemFactory.GetCartItems(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItemCollection GetCar responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItemCollection GetCar } /// - /// Adds a product to the current shopper's cart. + /// /// /// /// var result = CartItemFactory.AddItemToCart(handler : handler, cartItem : cartItem, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem AddItemToCart(Se cartItem : cartItem, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem AddItemToCart(Se } /// - /// Update the quantity of an individual cart item in the cart of the current shopper. + /// /// /// /// var result = CartItemFactory.UpdateCartItemQuantity(handler : handler, cartItemId : cartItemId, quantity : quantity, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem UpdateCartItemQu cartItemId : cartItemId, quantity : quantity, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem UpdateCartItemQu } /// - /// Update the product or product quantity of an item in the current shopper's cart. + /// /// /// /// var result = CartItemFactory.UpdateCartItem(handler : handler, cartItem : cartItem, cartItemId : cartItemId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem UpdateCartItem(S cartItem : cartItem, cartItemId : cartItemId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem UpdateCartItem(S } /// - /// Removes all items in the current shopper's active cart. + /// /// /// /// var result = CartItemFactory.RemoveAllCartItems(handler : handler, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveAllCartItems(S ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveAllCartItems(S } /// - /// Deletes a specific cart item by providing the cart item ID. + /// /// /// /// var result = CartItemFactory.DeleteCartItem(handler : handler, cartItemId : cartItemId, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static void DeleteCartItem(ServiceClientMessageHandler handler, cartItemId : cartItemId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ChangeMessageFactory.cs b/Mozu.Api.Test/Factories/Commerce/Carts/ChangeMessageFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ChangeMessageFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Carts/ChangeMessageFactory.cs index 19031a11..b7844a97 --- a/Mozu.Api.Test/Factories/ChangeMessageFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Carts/ChangeMessageFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Carts { /// /// Use the Cart Messages resource to retrieve messages for live carts that the system logs when a product's price or inventory level changes. @@ -30,7 +31,7 @@ public partial class ChangeMessageFactory : BaseDataFactory { /// - /// Retrieves the messages associated with the current shopper's cart. + /// /// /// /// var result = ChangeMessageFactory.GetMessages(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartChangeMessageCollecti responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Carts.CartChangeMessageCollecti } /// - /// Deletes all messages associated with the cart of the current shopper. + /// /// /// /// var result = ChangeMessageFactory.RemoveAllMessages(handler : handler, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static void RemoveAllMessages(ServiceClientMessageHandler handler, ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -105,7 +106,7 @@ public static void RemoveAllMessages(ServiceClientMessageHandler handler, } /// - /// Removes a single message associated with the cart of the current shopper. + /// /// /// /// var result = ChangeMessageFactory.RemoveMessage(handler : handler, messageId : messageId, expectedCode: expectedCode, successCode: successCode); @@ -126,7 +127,7 @@ public static void RemoveMessage(ServiceClientMessageHandler handler, messageId : messageId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ExtendedPropertyFactory.cs b/Mozu.Api.Test/Factories/Commerce/Carts/ExtendedPropertyFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/ExtendedPropertyFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Carts/ExtendedPropertyFactory.cs index 6208fd10..359356f9 --- a/Mozu.Api.Test/Factories/ExtendedPropertyFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Carts/ExtendedPropertyFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Carts { /// - /// Use the Cart Extended Properties subresource to store an arbitrary number of cart extended properties such as tracking strings, marketing sources, affiliates, sales personnel/data, and so on, on a per cart basis. Each cart may have none, one, or more than one entry in the extended properties collection, and all values in the extended properties collection are represented as strings. When you create an order from a cart, all extended properties are retained from the cart and copied to the order. Refer to the subresource for more information about order extended properties. + /// /// public partial class ExtendedPropertyFactory : BaseDataFactory { /// - /// Retrieves a list of cart extended properties specified in the request. + /// /// /// /// var result = ExtendedPropertyFactory.GetExtendedProperties(handler : handler, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class ExtendedPropertyFactory : BaseDataFactory ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class ExtendedPropertyFactory : BaseDataFactory } /// - /// Adds one or more specified extended properties to the carts extended properties collection. + /// /// /// /// var result = ExtendedPropertyFactory.AddExtendedProperties(handler : handler, extendedProperties : extendedProperties, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public partial class ExtendedPropertyFactory : BaseDataFactory extendedProperties : extendedProperties ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public partial class ExtendedPropertyFactory : BaseDataFactory } /// - /// Updates one or more details of the extended property specified in the request. + /// /// /// /// var result = ExtendedPropertyFactory.UpdateExtendedProperty(handler : handler, extendedProperty : extendedProperty, key : key, upsert : upsert, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty Updat extendedProperty : extendedProperty, key : key, upsert : upsert, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty Updat } /// - /// Updates one or more details of the extended properties specified in the request. + /// /// /// /// var result = ExtendedPropertyFactory.UpdateExtendedProperties(handler : handler, extendedProperties : extendedProperties, upsert : upsert, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty Updat extendedProperties : extendedProperties, upsert : upsert ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty Updat } /// - /// Deletes the extended properties cart extended properties collection. + /// /// /// /// var result = ExtendedPropertyFactory.DeleteExtendedProperties(handler : handler, keys : keys, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteExtendedProperties(ServiceClientMessageHandler handler, keys : keys ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -219,7 +220,7 @@ public static void DeleteExtendedProperties(ServiceClientMessageHandler handler, } /// - /// Deletes a specific extended property from the cart extended property collection. + /// /// /// /// var result = ExtendedPropertyFactory.DeleteExtendedProperty(handler : handler, key : key, expectedCode: expectedCode, successCode: successCode); @@ -240,7 +241,7 @@ public static void DeleteExtendedProperty(ServiceClientMessageHandler handler, key : key ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AttributeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/AttributeFactory.cs old mode 100644 new mode 100755 similarity index 86% rename from Mozu.Api.Test/Factories/AttributeFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/AttributeFactory.cs index 627ba760..2e14e87b --- a/Mozu.Api.Test/Factories/AttributeFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/AttributeFactory.cs @@ -18,21 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition { /// - /// Attributes are used to add custom definitions and characteristics to the following objects: - - + /// Use the Attribute Definition resource to manage the properties, options, and extras that uniquely describe products of a specific type. Attributes can be associated with a product type, assigned values by a client or shopper, and added as faceted search filters for a product category. Options are product attributes that describe unique configurations made by the shopper, such as size or color, and generate a new product variation (or unique SKU). Properties are product attributes that describe aspects of the product that do not represent an option configurable by the shopper, such as screen resolution or brand. Extras are product attributes that describe add-on configurations made by the shopper that do not represent a product variation, such as a monogram. /// public partial class AttributeFactory : BaseDataFactory { /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. + /// /// /// /// var result = AttributeFactory.GetAttributes(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -53,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeCollection GetAttributes( startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -70,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeCollection GetAttributes( } /// - /// Retrieves the details of the specified product attribute. + /// /// /// /// var result = AttributeFactory.GetAttribute(handler : handler, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -91,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Attribute GetAttribute(ServiceClie attributeFQN : attributeFQN, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -108,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Attribute GetAttribute(ServiceClie } /// - /// Creates a new attribute to describe one aspect of a product such as color or size, based on its defined product type. The attribute name, attribute type, input type, and data type are required. + /// /// /// /// var result = AttributeFactory.AddAttribute(handler : handler, attribute : attribute, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -129,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Attribute AddAttribute(ServiceClie attribute : attribute, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -146,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Attribute AddAttribute(ServiceClie } /// - /// Updates an existing attribute with attribute properties to set. + /// /// /// /// var result = AttributeFactory.UpdateAttribute(handler : handler, attribute : attribute, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -167,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Attribute UpdateAttribute(ServiceC attribute : attribute, attributeFQN : attributeFQN, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -184,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Attribute UpdateAttribute(ServiceC } /// - /// Deletes a defined product attribute. You cannot delete an attribute assigned a value for a product. + /// /// /// /// var result = AttributeFactory.DeleteAttribute(handler : handler, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); @@ -205,7 +204,7 @@ public static void DeleteAttribute(ServiceClientMessageHandler handler, attributeFQN : attributeFQN ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AttributeLocalizedContentFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/AttributeLocalizedContentFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentFactory.cs index 02671aa9..e7c52f73 --- a/Mozu.Api.Test/Factories/AttributeLocalizedContentFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Attributes { /// - /// Properties of localized content for attributes, based on a `localeCode` at a site/tenant level. This content supports translated text for product, product options, and additional objects. + /// /// public partial class AttributeLocalizedContentFactory : BaseDataFactory { /// - /// Retrieves a collection of localized content for attributes based on a `localeCode`. + /// /// /// /// var result = AttributeLocalizedContentFactory.GetAttributeLocalizedContents(handler : handler, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class AttributeLocalizedContentFactory : BaseDataFactory attributeFQN : attributeFQN ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class AttributeLocalizedContentFactory : BaseDataFactory } /// - /// Retrieves the localized content for an attribute based on a `localeCode`. + /// /// /// /// var result = AttributeLocalizedContentFactory.GetAttributeLocalizedContent(handler : handler, attributeFQN : attributeFQN, localeCode : localeCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent GetAttri attributeFQN : attributeFQN, localeCode : localeCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent GetAttri } /// - /// Adds new localized content for an attribute based on a `localeCode`. + /// /// /// /// var result = AttributeLocalizedContentFactory.AddLocalizedContent(handler : handler, localizedContent : localizedContent, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent AddLocal localizedContent : localizedContent, attributeFQN : attributeFQN, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent AddLocal } /// - /// Updates the localized content for a collection of existing attributes based on a `localeCode`. + /// /// /// /// var result = AttributeLocalizedContentFactory.UpdateLocalizedContents(handler : handler, localizedContent : localizedContent, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent AddLocal localizedContent : localizedContent, attributeFQN : attributeFQN ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent AddLocal } /// - /// Updates the localized content for an existing attribute based on a `localeCode`. + /// /// /// /// var result = AttributeLocalizedContentFactory.UpdateLocalizedContent(handler : handler, localizedContent : localizedContent, attributeFQN : attributeFQN, localeCode : localeCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent UpdateLo localizedContent : localizedContent, attributeFQN : attributeFQN, localeCode : localeCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent UpdateLo } /// - /// Removes all localized content. Localized content is translated text information and data based on a `localeCode`. + /// /// /// /// var result = AttributeLocalizedContentFactory.DeleteLocalizedContent(handler : handler, attributeFQN : attributeFQN, localeCode : localeCode, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static void DeleteLocalizedContent(ServiceClientMessageHandler handler, attributeFQN : attributeFQN, localeCode : localeCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AttributeTypeRuleFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/AttributeTypeRuleFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleFactory.cs index 8e6796f2..ab15ea8d --- a/Mozu.Api.Test/Factories/AttributeTypeRuleFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Attributes { /// /// Type rules are subresources of product attributes which could be specifications that can be shared across products in a store or assigned to specific products. Attribute type rules provide definitions of how attribute types will appear on the user interface. @@ -30,7 +31,7 @@ public partial class AttributeTypeRuleFactory : BaseDataFactory { /// - /// 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. + /// /// /// /// var result = AttributeTypeRuleFactory.GetAttributeTypeRules(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeTypeRuleCollection GetAtt startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AttributeVocabularyValueFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/AttributeVocabularyValueFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueFactory.cs index 0762852e..6c7d1fba --- a/Mozu.Api.Test/Factories/AttributeVocabularyValueFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Attributes { /// /// Vocabulary values are predefined for an attribute. @@ -30,7 +31,7 @@ public partial class AttributeVocabularyValueFactory : BaseDataFactory { /// - /// Retrieves a list of vocabulary values defined for the attribute specified in the request. + /// /// /// /// var result = AttributeVocabularyValueFactory.GetAttributeVocabularyValues(handler : handler, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class AttributeVocabularyValueFactory : BaseDataFactory attributeFQN : attributeFQN ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class AttributeVocabularyValueFactory : BaseDataFactory } /// - /// Retrieves a collection of localized content for vocabulary value attributes based on a `localeCode`. + /// /// /// /// var result = AttributeVocabularyValueFactory.GetAttributeVocabularyValueLocalizedContents(handler : handler, attributeFQN : attributeFQN, value : value, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public partial class AttributeVocabularyValueFactory : BaseDataFactory attributeFQN : attributeFQN, value : value ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public partial class AttributeVocabularyValueFactory : BaseDataFactory } /// - /// Retrieves the localized content for a vocabulary value attribute based on a `localeCode`. + /// /// /// /// var result = AttributeVocabularyValueFactory.GetAttributeVocabularyValueLocalizedContent(handler : handler, attributeFQN : attributeFQN, value : value, localeCode : localeCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedC attributeFQN : attributeFQN, value : value, localeCode : localeCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedC } /// - /// Retrieves the details of a vocabulary value defined for an attribute by providing the attribute's fully qualified name and the value to retrieve. + /// /// /// /// var result = AttributeVocabularyValueFactory.GetAttributeVocabularyValue(handler : handler, attributeFQN : attributeFQN, value : value, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue GetAttrib attributeFQN : attributeFQN, value : value, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue GetAttrib } /// - /// Creates and saves localized vocabulary value content for an attribute, based on the `localeCode`. + /// /// /// /// var result = AttributeVocabularyValueFactory.AddAttributeVocabularyValueLocalizedContent(handler : handler, localizedContent : localizedContent, attributeFQN : attributeFQN, value : value, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedC localizedContent : localizedContent, attributeFQN : attributeFQN, value : value, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedC } /// - /// Creates a vocabulary value for a defined product attribute. + /// /// /// /// var result = AttributeVocabularyValueFactory.AddAttributeVocabularyValue(handler : handler, attributeVocabularyValue : attributeVocabularyValue, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttrib attributeVocabularyValue : attributeVocabularyValue, attributeFQN : attributeFQN, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttrib } /// - /// Update existing vocabulary values for an attribute. + /// /// /// /// var result = AttributeVocabularyValueFactory.UpdateAttributeVocabularyValues(handler : handler, vocabularyValues : vocabularyValues, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttrib vocabularyValues : vocabularyValues, attributeFQN : attributeFQN ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttrib } /// - /// Updates a collection of localized vocabulary value content for existing attributes, based on the `localeCode`. + /// /// /// /// var result = AttributeVocabularyValueFactory.UpdateAttributeVocabularyValueLocalizedContents(handler : handler, localizedContent : localizedContent, attributeFQN : attributeFQN, value : value, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttrib localizedContent : localizedContent, attributeFQN : attributeFQN, value : value ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttrib } /// - /// Updates localized vocabulary value content for an existing attribute, based on the `localeCode`. + /// /// /// /// var result = AttributeVocabularyValueFactory.UpdateAttributeVocabularyValueLocalizedContent(handler : handler, localizedContent : localizedContent, attributeFQN : attributeFQN, value : value, localeCode : localeCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedC localizedContent : localizedContent, attributeFQN : attributeFQN, value : value, localeCode : localeCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -372,7 +373,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedC } /// - /// Updates existing attribute vocabulary values. + /// /// /// /// var result = AttributeVocabularyValueFactory.UpdateAttributeVocabularyValue(handler : handler, attributeVocabularyValue : attributeVocabularyValue, attributeFQN : attributeFQN, value : value, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -393,7 +394,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue UpdateAtt attributeVocabularyValue : attributeVocabularyValue, attributeFQN : attributeFQN, value : value, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -410,7 +411,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue UpdateAtt } /// - /// Deletes an attribute's vocabulary value. + /// /// /// /// var result = AttributeVocabularyValueFactory.DeleteAttributeVocabularyValue(handler : handler, attributeFQN : attributeFQN, value : value, expectedCode: expectedCode, successCode: successCode); @@ -431,7 +432,7 @@ public static void DeleteAttributeVocabularyValue(ServiceClientMessageHandler ha attributeFQN : attributeFQN, value : value ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -447,7 +448,7 @@ public static void DeleteAttributeVocabularyValue(ServiceClientMessageHandler ha } /// - /// Removes localized content for a vocabulary value attribute. + /// /// /// /// var result = AttributeVocabularyValueFactory.DeleteAttributeVocabularyValueLocalizedContent(handler : handler, attributeFQN : attributeFQN, value : value, localeCode : localeCode, expectedCode: expectedCode, successCode: successCode); @@ -468,7 +469,7 @@ public static void DeleteAttributeVocabularyValueLocalizedContent(ServiceClientM attributeFQN : attributeFQN, value : value, localeCode : localeCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductTypeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/ProductTypeFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/ProductTypeFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/ProductTypeFactory.cs index 8ff4725a..27459d1c --- a/Mozu.Api.Test/Factories/ProductTypeFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/ProductTypeFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition { /// /// Use the Product Types resource to manage the types for your product catalog. Product types act as configuration templates, which store a set of attributes common to all products associated with that type. Unlike categories, products can only be associated with a single product type. @@ -30,7 +31,7 @@ public partial class ProductTypeFactory : BaseDataFactory { /// - /// Retrieves a list of product types according to any specified filter criteria and sort options. + /// /// /// /// var result = ProductTypeFactory.GetProductTypes(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductTypeCollection GetProductTy startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductTypeCollection GetProductTy } /// - /// Retrieves the details of the product type specified in the request. + /// /// /// /// var result = ProductTypeFactory.GetProductType(handler : handler, productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductType GetProductType(Service productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductType GetProductType(Service } /// - /// Creates a new product type based on the information supplied in the request. + /// /// /// /// var result = ProductTypeFactory.AddProductType(handler : handler, productType : productType, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductType AddProductType(Service productType : productType, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductType AddProductType(Service } /// - /// Updates one or more properties of a product type. + /// /// /// /// var result = ProductTypeFactory.UpdateProductType(handler : handler, productType : productType, productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductType UpdateProductType(Serv productType : productType, productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductType UpdateProductType(Serv } /// - /// Deletes the product type by providing the product type ID. + /// /// /// /// var result = ProductTypeFactory.DeleteProductType(handler : handler, productTypeId : productTypeId, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteProductType(ServiceClientMessageHandler handler, productTypeId : productTypeId, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductTypeExtraFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ProductTypeExtraFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraFactory.cs index f51999df..3f8678bd --- a/Mozu.Api.Test/Factories/ProductTypeExtraFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Producttypes { /// /// Use the Extras subresource to define how a product attribute classified as an "extra" is used for a specific product type. Product attribute defintions are unique for each associated product type. @@ -30,7 +31,7 @@ public partial class ProductTypeExtraFactory : BaseDataFactory { /// - /// Retrieves a list of extra attributes defined for the specified product type. + /// /// /// /// var result = ProductTypeExtraFactory.GetExtras(handler : handler, productTypeId : productTypeId, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class ProductTypeExtraFactory : BaseDataFactory productTypeId : productTypeId, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class ProductTypeExtraFactory : BaseDataFactory } /// - /// Retrieves the details of an extra attribute definition for the specified product type. + /// /// /// /// var result = ProductTypeExtraFactory.GetExtra(handler : handler, productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetExtra(Se productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetExtra(Se } /// - /// Assigns a defined extra attribute to the product type based on the information supplied in the request. + /// /// /// /// var result = ProductTypeExtraFactory.AddExtra(handler : handler, attributeInProductType : attributeInProductType, productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddExtra(Se attributeInProductType : attributeInProductType, productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddExtra(Se } /// - /// Update the definition of an extra attribute for the specified product type. + /// /// /// /// var result = ProductTypeExtraFactory.UpdateExtra(handler : handler, attributeInProductType : attributeInProductType, productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateExtra attributeInProductType : attributeInProductType, productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateExtra } /// - /// Removes an extra attribute definition from the specified product type. + /// /// /// /// var result = ProductTypeExtraFactory.DeleteExtra(handler : handler, productTypeId : productTypeId, attributeFQN : attributeFQN, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteExtra(ServiceClientMessageHandler handler, productTypeId : productTypeId, attributeFQN : attributeFQN, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductTypeOptionFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ProductTypeOptionFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionFactory.cs index 9bca9636..c16da545 --- a/Mozu.Api.Test/Factories/ProductTypeOptionFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Producttypes { /// /// Use the Options subresource to define how an option attribute is used for a specific product type. Product attribute definitions are unique for each associated product type. @@ -30,7 +31,7 @@ public partial class ProductTypeOptionFactory : BaseDataFactory { /// - /// Retrieves a list of option product attributes defined for the specified product type. + /// /// /// /// var result = ProductTypeOptionFactory.GetOptions(handler : handler, productTypeId : productTypeId, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class ProductTypeOptionFactory : BaseDataFactory productTypeId : productTypeId, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class ProductTypeOptionFactory : BaseDataFactory } /// - /// Retrieves the details of an option attribute defined for the specified product type. + /// /// /// /// var result = ProductTypeOptionFactory.GetOption(handler : handler, productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetOption(S productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetOption(S } /// - /// Assigns an option attribute to the product type based on the information supplied in the request. + /// /// /// /// var result = ProductTypeOptionFactory.AddOption(handler : handler, attributeInProductType : attributeInProductType, productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddOption(S attributeInProductType : attributeInProductType, productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddOption(S } /// - /// Updates an option attribute definition for the specified product type. + /// /// /// /// var result = ProductTypeOptionFactory.UpdateOption(handler : handler, attributeInProductType : attributeInProductType, productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateOptio attributeInProductType : attributeInProductType, productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateOptio } /// - /// Removes an option attribute definition for the specified product type. + /// /// /// /// var result = ProductTypeOptionFactory.DeleteOption(handler : handler, productTypeId : productTypeId, attributeFQN : attributeFQN, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteOption(ServiceClientMessageHandler handler, productTypeId : productTypeId, attributeFQN : attributeFQN, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductTypePropertyFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ProductTypePropertyFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyFactory.cs index e23c26a6..742bd9b4 --- a/Mozu.Api.Test/Factories/ProductTypePropertyFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Producttypes { /// /// Use the Properties subresource to define how property product attributes are used for a specific product type. Product attribute definitions are unique for each associated product type. @@ -30,7 +31,7 @@ public partial class ProductTypePropertyFactory : BaseDataFactory { /// - /// Retrieves a list of product property attributes defined for a product type. + /// /// /// /// var result = ProductTypePropertyFactory.GetProperties(handler : handler, productTypeId : productTypeId, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class ProductTypePropertyFactory : BaseDataFactory productTypeId : productTypeId, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class ProductTypePropertyFactory : BaseDataFactory } /// - /// Retrieves a product property attribute definition for the specified product type. + /// /// /// /// var result = ProductTypePropertyFactory.GetProperty(handler : handler, productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetProperty productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetProperty } /// - /// Assigns a property attribute to the specified product type, according to the information defined in the request. + /// /// /// /// var result = ProductTypePropertyFactory.AddProperty(handler : handler, attributeInProductType : attributeInProductType, productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddProperty attributeInProductType : attributeInProductType, productTypeId : productTypeId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddProperty } /// - /// Updates the definition of a property attribute for the specified product type. + /// /// /// /// var result = ProductTypePropertyFactory.UpdateProperty(handler : handler, attributeInProductType : attributeInProductType, productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdatePrope attributeInProductType : attributeInProductType, productTypeId : productTypeId, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdatePrope } /// - /// Removes a property attribute previously defined for the specified product type. + /// /// /// /// var result = ProductTypePropertyFactory.DeleteProperty(handler : handler, productTypeId : productTypeId, attributeFQN : attributeFQN, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteProperty(ServiceClientMessageHandler handler, productTypeId : productTypeId, attributeFQN : attributeFQN, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductTypeVariationFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/ProductTypeVariationFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationFactory.cs index 7aaa062c..36b5da7e --- a/Mozu.Api.Test/Factories/ProductTypeVariationFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Producttypes { /// /// Use the variations resource to preview possible product variations for a specific product type based on the option attributes defined for the product type, such as size or color. @@ -30,7 +31,7 @@ public partial class ProductTypeVariationFactory : BaseDataFactory { /// - /// Generates the variations possible for a product associated with the product type based on the option values supplied in the request. + /// /// /// /// var result = ProductTypeVariationFactory.GenerateProductVariations(handler : handler, productOptionsIn : productOptionsIn, productTypeId : productTypeId, productCode : productCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationPagedCollection Ge productOptionsIn : productOptionsIn, productTypeId : productTypeId, productCode : productCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CategoryFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/CategoryFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/CategoryFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/CategoryFactory.cs index ccbd6ff5..afacff53 --- a/Mozu.Api.Test/Factories/CategoryFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/CategoryFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// /// Use the Categories resource to organize products and control where they appear on the storefront. Create and maintain a hierarchy of categories and subcategories where the site will store properties. @@ -30,7 +31,7 @@ public partial class CategoryFactory : BaseDataFactory { /// - /// Retrieves a list of categories according to any specified filter criteria and sort options. + /// /// /// /// var result = CategoryFactory.GetCategories(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CategoryPagedCollection GetCategor startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CategoryPagedCollection GetCategor } /// - /// Retrieves the list of subcategories within a category. + /// /// /// /// var result = CategoryFactory.GetChildCategories(handler : handler, categoryId : categoryId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CategoryCollection GetChildCategor categoryId : categoryId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CategoryCollection GetChildCategor } /// - /// Retrieves the details of a single category. + /// /// /// /// var result = CategoryFactory.GetCategory(handler : handler, categoryId : categoryId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Category GetCategory(ServiceClient categoryId : categoryId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Category GetCategory(ServiceClient } /// - /// Adds a new category to the site's category hierarchy.Specify a to determine where to place the category in the hierarchy. If no is specified, the new category is a top-level category. + /// /// /// /// var result = CategoryFactory.AddCategory(handler : handler, category : category, incrementSequence : incrementSequence, useProvidedId : useProvidedId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Category AddCategory(ServiceClient category : category, incrementSequence : incrementSequence, useProvidedId : useProvidedId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Category AddCategory(ServiceClient } /// - /// Validate the precomputed dynamic category expression for correctness. + /// /// /// /// var result = CategoryFactory.ValidateDynamicExpression(handler : handler, dynamicExpressionIn : dynamicExpressionIn, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DynamicExpression ValidateDynamicE dynamicExpressionIn : dynamicExpressionIn, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DynamicExpression ValidateDynamicE } /// - /// Validates the readltime dynamic category expression for correctness. + /// /// /// /// var result = CategoryFactory.ValidateRealTimeDynamicExpression(handler : handler, dynamicExpressionIn : dynamicExpressionIn, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DynamicExpression ValidateRealTime dynamicExpressionIn : dynamicExpressionIn, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DynamicExpression ValidateRealTime } /// - /// Update the properties of a defined category or move it to another location in the category hierarchy. Because this operation replaces the defined resource,include all the information to maintain for the category in the request. + /// /// /// /// var result = CategoryFactory.UpdateCategory(handler : handler, category : category, categoryId : categoryId, cascadeVisibility : cascadeVisibility, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Category UpdateCategory(ServiceCli category : category, categoryId : categoryId, cascadeVisibility : cascadeVisibility, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Category UpdateCategory(ServiceCli } /// - /// Deletes the specified category. Use the categoryId parameter to specify the category. + /// /// /// /// var result = CategoryFactory.DeleteCategoryById(handler : handler, categoryId : categoryId, cascadeDelete : cascadeDelete, forceDelete : forceDelete, reassignToParent : reassignToParent, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static void DeleteCategoryById(ServiceClientMessageHandler handler, categoryId : categoryId, cascadeDelete : cascadeDelete, forceDelete : forceDelete, reassignToParent : reassignToParent ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CouponSetFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/CouponSetFactory.cs old mode 100644 new mode 100755 similarity index 88% rename from Mozu.Api.Test/Factories/CouponSetFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/CouponSetFactory.cs index e341a8a0..b3addadd --- a/Mozu.Api.Test/Factories/CouponSetFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/CouponSetFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// - /// Use the Coupon Sets resource to view and create coupon sets. You can use coupon sets to group multiple coupon codes together and associate them with one or more discounts. Use the subresource to manage the coupon codes within manual coupon sets. Use the subresource to mange the discounts assigned to coupon sets. + /// /// public partial class CouponSetFactory : BaseDataFactory { /// - /// Retrieves a list of coupon sets in the catalog according to any specified filter criteria and sort options. + /// /// /// /// var result = CouponSetFactory.GetCouponSets(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, includeCounts : includeCounts, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponSetCollection GetCouponSets( startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, includeCounts : includeCounts, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponSetCollection GetCouponSets( } /// - /// Retrieves the details of a single coupon set. Use the couponSetCode parameter to specify the coupon set. Use the includeCounts parameter to specify whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts. + /// /// /// /// var result = CouponSetFactory.GetCouponSet(handler : handler, couponSetCode : couponSetCode, includeCounts : includeCounts, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponSet GetCouponSet(ServiceClie couponSetCode : couponSetCode, includeCounts : includeCounts, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponSet GetCouponSet(ServiceClie } /// - /// Returns a unique, random four character code to use for the couponSetCode. + /// /// /// /// var result = CouponSetFactory.GetUniqueCouponSetCode(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static string GetUniqueCouponSetCode(ServiceClientMessageHandler handler, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static string GetUniqueCouponSetCode(ServiceClientMessageHandler handler, } /// - /// Adds a single coupon set to the catalog. + /// /// /// /// var result = CouponSetFactory.AddCouponSet(handler : handler, couponSet : couponSet, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponSet AddCouponSet(ServiceClie couponSet : couponSet, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponSet AddCouponSet(ServiceClie } /// - /// Validates the couponSetCode and tests it for uniqueness. + /// /// /// /// var result = CouponSetFactory.ValidateUniqueCouponSetCode(handler : handler, code : code, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void ValidateUniqueCouponSetCode(ServiceClientMessageHandler handl code : code ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -219,7 +220,7 @@ public static void ValidateUniqueCouponSetCode(ServiceClientMessageHandler handl } /// - /// Updates one or more properties of a coupon set in the catalog. + /// /// /// /// var result = CouponSetFactory.UpdateCouponSet(handler : handler, couponSet : couponSet, couponSetCode : couponSetCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -240,7 +241,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponSet UpdateCouponSet(ServiceC couponSet : couponSet, couponSetCode : couponSetCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -257,7 +258,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponSet UpdateCouponSet(ServiceC } /// - /// Deletes a specified coupon set from the catalog. Use the couponSetCode parameter to specify the coupon set to delete. + /// /// /// /// var result = CouponSetFactory.DeleteCouponSet(handler : handler, couponSetCode : couponSetCode, expectedCode: expectedCode, successCode: successCode); @@ -278,7 +279,7 @@ public static void DeleteCouponSet(ServiceClientMessageHandler handler, couponSetCode : couponSetCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AssignedDiscountFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Couponsets/AssignedDiscountFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/AssignedDiscountFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Couponsets/AssignedDiscountFactory.cs index bb40f639..627b0ba8 --- a/Mozu.Api.Test/Factories/AssignedDiscountFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Couponsets/AssignedDiscountFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Couponsets { /// - /// Use the AssignedDiscounts resource to manage the discounts assigned to coupon sets. + /// /// public partial class AssignedDiscountFactory : BaseDataFactory { /// - /// Retrieves the discountIds of any assigned discounts for the specified coupon set. + /// /// /// /// var result = AssignedDiscountFactory.GetAssignedDiscounts(handler : handler, couponSetCode : couponSetCode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class AssignedDiscountFactory : BaseDataFactory couponSetCode : couponSetCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class AssignedDiscountFactory : BaseDataFactory } /// - /// Assigns or associates an existing discount to a specified coupon set. Use the couponSetCode parameter to specify the coupon set. + /// /// /// /// var result = AssignedDiscountFactory.AssignDiscount(handler : handler, assignedDiscount : assignedDiscount, couponSetCode : couponSetCode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static void AssignDiscount(ServiceClientMessageHandler handler, assignedDiscount : assignedDiscount, couponSetCode : couponSetCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -105,7 +106,7 @@ public static void AssignDiscount(ServiceClientMessageHandler handler, } /// - /// Unassigns or disassociates the specified discount with the specified coupon set. + /// /// /// /// var result = AssignedDiscountFactory.UnAssignDiscount(handler : handler, couponSetCode : couponSetCode, discountId : discountId, expectedCode: expectedCode, successCode: successCode); @@ -126,7 +127,7 @@ public static void UnAssignDiscount(ServiceClientMessageHandler handler, couponSetCode : couponSetCode, discountId : discountId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CouponFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Couponsets/CouponFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/CouponFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Couponsets/CouponFactory.cs index 51d58b85..14d00808 --- a/Mozu.Api.Test/Factories/CouponFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Couponsets/CouponFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Couponsets { /// - /// Use the Coupons subresource to manage coupons within manual coupon sets. + /// /// public partial class CouponFactory : BaseDataFactory { /// - /// Retrieves the details of the specified coupon. Use the couponSetCode and the couponCode parameter to specify the coupon within a coupon set. Use the includeCounts paramter to specify whether to return the redemptionCount property in the response body object. + /// /// /// /// var result = CouponFactory.GetCoupon(handler : handler, couponSetCode : couponSetCode, couponCode : couponCode, includeCounts : includeCounts, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Coupon GetCoupon(ServiceClientMess couponSetCode : couponSetCode, couponCode : couponCode, includeCounts : includeCounts, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Coupon GetCoupon(ServiceClientMess } /// - /// Retrieves a list of coupons in a specified coupon set according to any specified filter criteria and sort options. + /// /// /// /// var result = CouponFactory.GetCoupons(handler : handler, couponSetCode : couponSetCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, includeCounts : includeCounts, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponCollection GetCoupons(Servic couponSetCode : couponSetCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, includeCounts : includeCounts, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.CouponCollection GetCoupons(Servic } /// - /// Adds coupons to a specified manual coupon set. Use the couponSetCode parameter to specify the manual coupon set. + /// /// /// /// var result = CouponFactory.AddCoupons(handler : handler, coupons : coupons, couponSetCode : couponSetCode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static void AddCoupons(ServiceClientMessageHandler handler, coupons : coupons, couponSetCode : couponSetCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -143,7 +144,7 @@ public static void AddCoupons(ServiceClientMessageHandler handler, } /// - /// Deletes the specified coupons and removes them from the coupon set. You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. + /// /// /// /// var result = CouponFactory.DeleteCoupons(handler : handler, couponCodes : couponCodes, couponSetCode : couponSetCode, expectedCode: expectedCode, successCode: successCode); @@ -164,7 +165,7 @@ public static void DeleteCoupons(ServiceClientMessageHandler handler, couponCodes : couponCodes, couponSetCode : couponSetCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -180,7 +181,7 @@ public static void DeleteCoupons(ServiceClientMessageHandler handler, } /// - /// Deletes the specified coupon and remove it from the coupon set. You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. + /// /// /// /// var result = CouponFactory.DeleteCoupon(handler : handler, couponSetCode : couponSetCode, couponCode : couponCode, expectedCode: expectedCode, successCode: successCode); @@ -201,7 +202,7 @@ public static void DeleteCoupon(ServiceClientMessageHandler handler, couponSetCode : couponSetCode, couponCode : couponCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DiscountFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/DiscountFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/DiscountFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/DiscountFactory.cs index 2bec585e..8c6a0d8a --- a/Mozu.Api.Test/Factories/DiscountFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/DiscountFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// - /// Use the Discounts resource to define and manage discounts to apply to products, product categories, or orders. The discounts can be a specified amount off the price, percentage off the price, or for free shipping. You can create a coupon code that shoppers can use to redeem the discount. + /// Define and manage discounts to apply to products, product categories, or orders. The discounts can be a specified amount off the price, percentage off the price, or for free shipping. Create a coupon code that shoppers can use to redeem the discount. /// public partial class DiscountFactory : BaseDataFactory { /// - /// Retrieves a list of discounts according to any specified filter criteria and sort options. + /// /// /// /// var result = DiscountFactory.GetDiscounts(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DiscountCollection GetDiscounts(Se startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DiscountCollection GetDiscounts(Se } /// - /// Retrieves the localized content specified for the specified discount. + /// /// /// /// var result = DiscountFactory.GetDiscountContent(handler : handler, discountId : discountId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent GetDiscou discountId : discountId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent GetDiscou } /// - /// Retrieves the details of a single discount. + /// /// /// /// var result = DiscountFactory.GetDiscount(handler : handler, discountId : discountId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Discount GetDiscount(ServiceClient discountId : discountId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Discount GetDiscount(ServiceClient } /// - /// Generates a random code for a coupon. + /// /// /// /// var result = DiscountFactory.GenerateRandomCoupon(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static string GenerateRandomCoupon(ServiceClientMessageHandler handler, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static string GenerateRandomCoupon(ServiceClientMessageHandler handler, } /// - /// Creates a new discount or coupon to apply to a product, category, order, or shipping. + /// /// /// /// var result = DiscountFactory.CreateDiscount(handler : handler, discount : discount, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Discount CreateDiscount(ServiceCli discount : discount, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Discount CreateDiscount(ServiceCli } /// - /// Updates the localizable content for the specified discount or renames the discount without modifying its other properties. + /// /// /// /// var result = DiscountFactory.UpdateDiscountContent(handler : handler, content : content, discountId : discountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent UpdateDis content : content, discountId : discountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent UpdateDis } /// - /// Updates one or more properties of the specified discount. + /// /// /// /// var result = DiscountFactory.UpdateDiscount(handler : handler, discount : discount, discountId : discountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Discount UpdateDiscount(ServiceCli discount : discount, discountId : discountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Discount UpdateDiscount(ServiceCli } /// - /// Deletes a discount specified by its discount ID. + /// /// /// /// var result = DiscountFactory.DeleteDiscount(handler : handler, discountId : discountId, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static void DeleteDiscount(ServiceClientMessageHandler handler, discountId : discountId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/EventFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/DiscountSettingsFactory.cs old mode 100644 new mode 100755 similarity index 59% rename from Mozu.Api.Test/Factories/EventFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/DiscountSettingsFactory.cs index bbd6b5f4..022cd9ac --- a/Mozu.Api.Test/Factories/EventFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/DiscountSettingsFactory.cs @@ -18,40 +18,41 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// - /// Events are notifications Mozu publishes to the application when a create, read, update, or delete operation is performed. If the application subscribes to the event, you can use the Events resource to query for recent events Mozu published to your application or events that were not published successfully. + /// /// - public partial class EventFactory : BaseDataFactory + public partial class DiscountSettingsFactory : BaseDataFactory { /// - /// Retrieves a list of events. + /// /// /// - /// var result = EventFactory.GetEvents(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = DiscountSettingsFactory.GetDiscountSettings(handler : handler, catalogId : catalogId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.Event.EventCollection GetEvents(ServiceClientMessageHandler handler, - int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + public static Mozu.Api.Contracts.ProductAdmin.DiscountSettings GetDiscountSettings(ServiceClientMessageHandler handler, + int catalogId, string responseFields = null, DataViewMode dataViewMode= DataViewMode.Live, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Event.EventNotificationClient.GetEventsClient( - startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountSettingsClient.GetDiscountSettingsClient( + catalogId : catalogId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,28 +69,28 @@ public static Mozu.Api.Contracts.Event.EventCollection GetEvents(ServiceClientMe } /// - /// Retrieves an event by providing the event ID. + /// /// /// - /// var result = EventFactory.GetEvent(handler : handler, eventId : eventId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = DiscountSettingsFactory.UpdateDiscountSettings(handler : handler, discountSettings : discountSettings, catalogId : catalogId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.Event.Event GetEvent(ServiceClientMessageHandler handler, - string eventId, string responseFields = null, + public static Mozu.Api.Contracts.ProductAdmin.DiscountSettings UpdateDiscountSettings(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.ProductAdmin.DiscountSettings discountSettings, int catalogId, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Event.EventNotificationClient.GetEventClient( - eventId : eventId, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountSettingsClient.UpdateDiscountSettingsClient( + discountSettings : discountSettings, catalogId : catalogId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DiscountTargetFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Discounts/DiscountTargetFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/DiscountTargetFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Discounts/DiscountTargetFactory.cs index 7d7802b7..b8c48109 --- a/Mozu.Api.Test/Factories/DiscountTargetFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Discounts/DiscountTargetFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Discounts { /// /// Retrieves and modifies the products, categories, and shipping methods eligible for discounts in the form of a fixed dollar amount, percentage off a product price, or free shipping. @@ -30,7 +31,7 @@ public partial class DiscountTargetFactory : BaseDataFactory { /// - /// Retrieves the discount target, that is which products, categories, or shipping methods are eligible for the discount. + /// /// /// /// var result = DiscountTargetFactory.GetDiscountTarget(handler : handler, discountId : discountId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DiscountTarget GetDiscountTarget(S discountId : discountId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DiscountTarget GetDiscountTarget(S } /// - /// Modifies properties of the discount target, for example, the dollar amount, or precentage off the price. + /// /// /// /// var result = DiscountTargetFactory.UpdateDiscountTarget(handler : handler, discountTarget : discountTarget, discountId : discountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.DiscountTarget UpdateDiscountTarge discountTarget : discountTarget, discountId : discountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/FacetAdminFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/FacetAdminFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/FacetAdminFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/FacetAdminFactory.cs index 3b3cdada..8fc70bd2 --- a/Mozu.Api.Test/Factories/FacetAdminFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/FacetAdminFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// /// Use the Facets resource to manage the facets shoppers use to filter product display results on a storefront. Facets can include categories, product attributes, or prices, and use either a range of values or discrete values. @@ -30,7 +31,7 @@ public partial class FacetAdminFactory : BaseDataFactory { /// - /// Retrieves a facet specified by its unique identifier and displays its properties. + /// /// /// /// var result = FacetFactory.GetFacet(handler : handler, facetId : facetId, validate : validate, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Facet GetFacet(ServiceClientMessag facetId : facetId, validate : validate, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Facet GetFacet(ServiceClientMessag } /// - /// Retrieves a list of the facets defined for the specified category. + /// /// /// /// var result = FacetFactory.GetFacetCategoryList(handler : handler, categoryId : categoryId, includeAvailable : includeAvailable, validate : validate, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.FacetSet GetFacetCategoryList(Serv categoryId : categoryId, includeAvailable : includeAvailable, validate : validate, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.FacetSet GetFacetCategoryList(Serv } /// - /// Creates a new category, price, or attribute facet. Define the category or attribute source to use for the facet values. + /// /// /// /// var result = FacetFactory.AddFacet(handler : handler, facet : facet, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Facet AddFacet(ServiceClientMessag facet : facet, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Facet AddFacet(ServiceClientMessag } /// - /// Modifies one or more properties of a defined facet. + /// /// /// /// var result = FacetFactory.UpdateFacet(handler : handler, facet : facet, facetId : facetId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Facet UpdateFacet(ServiceClientMes facet : facet, facetId : facetId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Facet UpdateFacet(ServiceClientMes } /// - /// Deletes the facet specified by its unique identifier. + /// /// /// /// var result = FacetFactory.DeleteFacetById(handler : handler, facetId : facetId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteFacetById(ServiceClientMessageHandler handler, facetId : facetId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/LocationInventoryFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/LocationInventoryFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/LocationInventoryFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/LocationInventoryFactory.cs index 09c33136..aa5a4f86 --- a/Mozu.Api.Test/Factories/LocationInventoryFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/LocationInventoryFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// /// Use the Location Inventory resource to manage the level of active product inventory maintained at each defined location, at the location level. @@ -30,7 +31,7 @@ public partial class LocationInventoryFactory : BaseDataFactory { /// - /// Retrieves the details of a product's active inventory at the location specified in the request. + /// /// /// /// var result = LocationInventoryFactory.GetLocationInventory(handler : handler, locationCode : locationCode, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInven locationCode : locationCode, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInven } /// - /// Retrieves a list of all product inventory definitions for the location code specified in the request. + /// /// /// /// var result = LocationInventoryFactory.GetLocationInventories(handler : handler, locationCode : locationCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, filterFunctions : filterFunctions, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLoc locationCode : locationCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, filterFunctions : filterFunctions, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLoc } /// - /// Creates an array of product inventory definitions for the location specified in the request. When adding a new inventory definition, you must specify the productCode and stockOnHand value in each array you define. All other properties are system-supplied and read only. + /// /// /// /// var result = LocationInventoryFactory.AddLocationInventory(handler : handler, locationInventoryList : locationInventoryList, locationCode : locationCode, performUpserts : performUpserts, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLoc locationInventoryList : locationInventoryList, locationCode : locationCode, performUpserts : performUpserts, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLoc } /// - /// Updates the active stock on hand inventory of products for the location code specified in the request. + /// /// /// /// var result = LocationInventoryFactory.UpdateLocationInventory(handler : handler, locationInventoryAdjustments : locationInventoryAdjustments, locationCode : locationCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLoc locationInventoryAdjustments : locationInventoryAdjustments, locationCode : locationCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLoc } /// - /// Deletes the product code inventory definition for the location specified in the request. + /// /// /// /// var result = LocationInventoryFactory.DeleteLocationInventory(handler : handler, locationCode : locationCode, productCode : productCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteLocationInventory(ServiceClientMessageHandler handler, locationCode : locationCode, productCode : productCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/MasterCatalogFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/MasterCatalogFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/MasterCatalogFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/MasterCatalogFactory.cs index ee6a798d..033d1107 --- a/Mozu.Api.Test/Factories/MasterCatalogFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/MasterCatalogFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// /// Use the Master Catalog resource to view details of the master catalogs associated with a tenant and to manage the product publishing mode for each master catalog. @@ -30,7 +31,7 @@ public partial class MasterCatalogFactory : BaseDataFactory { /// - /// Retrieve the details of all master catalog associated with a tenant. + /// /// /// /// var result = MasterCatalogFactory.GetMasterCatalogs(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.MasterCatalogCollection GetMasterC responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.MasterCatalogCollection GetMasterC } /// - /// Retrieve the details of the master catalog specified in the request. + /// /// /// /// var result = MasterCatalogFactory.GetMasterCatalog(handler : handler, masterCatalogId : masterCatalogId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.MasterCatalog GetMasterCatalog(Ser masterCatalogId : masterCatalogId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.MasterCatalog GetMasterCatalog(Ser } /// - /// Updates the product publishing mode for the master catalog specified in the request. + /// /// /// /// var result = MasterCatalogFactory.UpdateMasterCatalog(handler : handler, masterCatalog : masterCatalog, masterCatalogId : masterCatalogId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.MasterCatalog UpdateMasterCatalog( masterCatalog : masterCatalog, masterCatalogId : masterCatalogId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PriceListFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/PriceListFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/PriceListFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/PriceListFactory.cs index d16d787c..f4cb320c --- a/Mozu.Api.Test/Factories/PriceListFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/PriceListFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// - /// Use the Price Lists resource to view and create price lists. You can use price lists to override the catalog pricing of products for specific customer segments and/or sites. You can override products' list price, sale price, advanced pricing information such as MSRP, cost, MAP, and the catalog price of any extras associated with the product in a price list. You can also restrict discounts from applying to the overridden product pricing in a price list. Refer to [Price Lists](../../../guides/catalog/price-lists.htm) in the Guides section for more information about price lists. + /// /// public partial class PriceListFactory : BaseDataFactory { /// - /// Retrieves a list of price lists according to any specified facets, filter criteria, and sort options. + /// /// /// /// var result = PriceListFactory.GetPriceLists(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListCollection GetPriceLists( startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListCollection GetPriceLists( } /// - /// Retrieves the details of the specified price list. + /// /// /// /// var result = PriceListFactory.GetPriceList(handler : handler, priceListCode : priceListCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceList GetPriceList(ServiceClie priceListCode : priceListCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceList GetPriceList(ServiceClie } /// - /// Adds a new price list to the tenant. + /// /// /// /// var result = PriceListFactory.AddPriceList(handler : handler, priceList : priceList, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceList AddPriceList(ServiceClie priceList : priceList, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceList AddPriceList(ServiceClie } /// - /// Adds up to 5000 new price list entries in bulk. + /// /// /// /// var result = PriceListFactory.BulkAddPriceListEntries(handler : handler, priceListEntriesIn : priceListEntriesIn, publishEvents : publishEvents, invalidateCache : invalidateCache, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static void BulkAddPriceListEntries(ServiceClientMessageHandler handler, priceListEntriesIn : priceListEntriesIn, publishEvents : publishEvents, invalidateCache : invalidateCache ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -181,7 +182,7 @@ public static void BulkAddPriceListEntries(ServiceClientMessageHandler handler, } /// - /// Deletes up to 5000 price list entries in bulk. + /// /// /// /// var result = PriceListFactory.BulkDeletePriceListEntries(handler : handler, priceListEntriesIn : priceListEntriesIn, publishEvents : publishEvents, invalidateCache : invalidateCache, expectedCode: expectedCode, successCode: successCode); @@ -202,7 +203,7 @@ public static void BulkDeletePriceListEntries(ServiceClientMessageHandler handle priceListEntriesIn : priceListEntriesIn, publishEvents : publishEvents, invalidateCache : invalidateCache ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -218,7 +219,7 @@ public static void BulkDeletePriceListEntries(ServiceClientMessageHandler handle } /// - /// Updates up to 5000 price list entries in bulk. + /// /// /// /// var result = PriceListFactory.BulkUpdatePriceListEntries(handler : handler, priceListEntriesIn : priceListEntriesIn, publishEvents : publishEvents, invalidateCache : invalidateCache, expectedCode: expectedCode, successCode: successCode); @@ -239,7 +240,7 @@ public static void BulkUpdatePriceListEntries(ServiceClientMessageHandler handle priceListEntriesIn : priceListEntriesIn, publishEvents : publishEvents, invalidateCache : invalidateCache ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -255,7 +256,7 @@ public static void BulkUpdatePriceListEntries(ServiceClientMessageHandler handle } /// - /// Updates the details of the specified price list. + /// /// /// /// var result = PriceListFactory.UpdatePriceList(handler : handler, priceList : priceList, priceListCode : priceListCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -276,7 +277,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceList UpdatePriceList(ServiceC priceList : priceList, priceListCode : priceListCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -293,7 +294,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceList UpdatePriceList(ServiceC } /// - /// Deletes the specified price list from the tenant. + /// /// /// /// var result = PriceListFactory.DeletePriceList(handler : handler, priceListCode : priceListCode, cascadeDeleteEntries : cascadeDeleteEntries, expectedCode: expectedCode, successCode: successCode); @@ -314,7 +315,7 @@ public static void DeletePriceList(ServiceClientMessageHandler handler, priceListCode : priceListCode, cascadeDeleteEntries : cascadeDeleteEntries ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PriceListEntryFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Pricelists/PriceListEntryFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/PriceListEntryFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Pricelists/PriceListEntryFactory.cs index 30f1bcb9..21cc9b94 --- a/Mozu.Api.Test/Factories/PriceListEntryFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Pricelists/PriceListEntryFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Pricelists { /// - /// Use the Entries sub-resource to interact with price list entries. Price list entries enable you to override product pricing as well as control what products shoppers can view and purchase when the price list is exclusive. Refer to the [Price Lists](../../../guides/catalog/price-lists.htm) guides topic for more information. + /// /// public partial class PriceListEntryFactory : BaseDataFactory { /// - /// Retrieves the details of a price list entry. + /// /// /// /// var result = PriceListEntryFactory.GetPriceListEntry(handler : handler, priceListCode : priceListCode, productCode : productCode, currencyCode : currencyCode, startDate : startDate, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListEntry GetPriceListEntry(S priceListCode : priceListCode, productCode : productCode, currencyCode : currencyCode, startDate : startDate, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListEntry GetPriceListEntry(S } /// - /// Retrieves a list of price list entries associated with the specified price list according to any specified facets, filter criteria, and sort options. + /// /// /// /// var result = PriceListEntryFactory.GetPriceListEntries(handler : handler, priceListCode : priceListCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListEntryCollection GetPriceL priceListCode : priceListCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListEntryCollection GetPriceL } /// - /// Adds a new price list entry to the specified price list. + /// /// /// /// var result = PriceListEntryFactory.AddPriceListEntry(handler : handler, priceListEntryIn : priceListEntryIn, priceListCode : priceListCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListEntry AddPriceListEntry(S priceListEntryIn : priceListEntryIn, priceListCode : priceListCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListEntry AddPriceListEntry(S } /// - /// Updates the details of a price list entry. + /// /// /// /// var result = PriceListEntryFactory.UpdatePriceListEntry(handler : handler, priceListEntryIn : priceListEntryIn, priceListCode : priceListCode, productCode : productCode, currencyCode : currencyCode, startDate : startDate, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListEntry UpdatePriceListEntr priceListEntryIn : priceListEntryIn, priceListCode : priceListCode, productCode : productCode, currencyCode : currencyCode, startDate : startDate, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PriceListEntry UpdatePriceListEntr } /// - /// Deletes a price list entry. + /// /// /// /// var result = PriceListEntryFactory.DeletePriceListEntry(handler : handler, priceListCode : priceListCode, productCode : productCode, currencyCode : currencyCode, startDate : startDate, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeletePriceListEntry(ServiceClientMessageHandler handler, priceListCode : priceListCode, productCode : productCode, currencyCode : currencyCode, startDate : startDate ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/ProductFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ProductFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/ProductFactory.cs index 75e67a13..5f2d0c7c --- a/Mozu.Api.Test/Factories/ProductFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/ProductFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// /// Use the Product Administration resource to create new product definitions in the master catalog and determine which catalogs will feature products. You can also assign attribute values for defined products, manage product-level location inventory, and configure the variations of a product. @@ -30,7 +31,7 @@ public partial class ProductFactory : BaseDataFactory { /// - /// Retrieves a list of products according to any specified facets, filter criteria, and sort options. + /// /// /// /// var result = ProductFactory.GetProducts(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, noCount : noCount, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductCollection GetProducts(Serv startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, noCount : noCount, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductCollection GetProducts(Serv } /// - /// Retrieves a product that is associated with one or more specific catalogs. + /// /// /// /// var result = ProductFactory.GetProductInCatalogs(handler : handler, productCode : productCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductCollection GetProducts(Serv productCode : productCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductCollection GetProducts(Serv } /// - /// Retrieves the details of a product associated with a specific catalog. + /// /// /// /// var result = ProductFactory.GetProductInCatalog(handler : handler, productCode : productCode, catalogId : catalogId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo GetProductInC productCode : productCode, catalogId : catalogId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo GetProductInC } /// - /// Retrieves the details of a product definition. + /// /// /// /// var result = ProductFactory.GetProduct(handler : handler, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Product GetProduct(ServiceClientMe productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Product GetProduct(ServiceClientMe } /// - /// Creates a new product definition in the specified master catalog. + /// /// /// /// var result = ProductFactory.AddProduct(handler : handler, product : product, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Product AddProduct(ServiceClientMe product : product, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Product AddProduct(ServiceClientMe } /// - /// Associates a new product defined in the master catalog with a specific catalog. + /// /// /// /// var result = ProductFactory.AddProductInCatalog(handler : handler, productInCatalogInfoIn : productInCatalogInfoIn, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo AddProductInC productInCatalogInfoIn : productInCatalogInfoIn, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo AddProductInC } /// - /// Performs an update to a product code by renaming or replacing the current product code with a new one. + /// /// /// /// var result = ProductFactory.RenameProductCodes(handler : handler, productCodeRenames : productCodeRenames, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static void RenameProductCodes(ServiceClientMessageHandler handler, productCodeRenames : productCodeRenames ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -295,7 +296,7 @@ public static void RenameProductCodes(ServiceClientMessageHandler handler, } /// - /// Updates the properties of a product specific to each catalog associated with the product. + /// /// /// /// var result = ProductFactory.UpdateProductInCatalogs(handler : handler, productInCatalogsIn : productInCatalogsIn, productCode : productCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -316,7 +317,7 @@ public static void RenameProductCodes(ServiceClientMessageHandler handler, productInCatalogsIn : productInCatalogsIn, productCode : productCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -333,7 +334,7 @@ public static void RenameProductCodes(ServiceClientMessageHandler handler, } /// - /// Updates one or more properties of a product associated with a specific catalog. + /// /// /// /// var result = ProductFactory.UpdateProductInCatalog(handler : handler, productInCatalogInfoIn : productInCatalogInfoIn, productCode : productCode, catalogId : catalogId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -354,7 +355,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo UpdateProduct productInCatalogInfoIn : productInCatalogInfoIn, productCode : productCode, catalogId : catalogId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -371,7 +372,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo UpdateProduct } /// - /// Updates one or more properties of a product definition in a master catalog. + /// /// /// /// var result = ProductFactory.UpdateProduct(handler : handler, product : product, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -392,7 +393,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Product UpdateProduct(ServiceClien product : product, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -409,7 +410,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Product UpdateProduct(ServiceClien } /// - /// Deletes the specified product from a master catalog. + /// /// /// /// var result = ProductFactory.DeleteProduct(handler : handler, productCode : productCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -430,7 +431,7 @@ public static void DeleteProduct(ServiceClientMessageHandler handler, productCode : productCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -446,7 +447,7 @@ public static void DeleteProduct(ServiceClientMessageHandler handler, } /// - /// Removes the product association defined for a specific catalog. + /// /// /// /// var result = ProductFactory.DeleteProductInCatalog(handler : handler, productCode : productCode, catalogId : catalogId, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -467,7 +468,7 @@ public static void DeleteProductInCatalog(ServiceClientMessageHandler handler, productCode : productCode, catalogId : catalogId, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductReservationFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/ProductReservationFactory.cs old mode 100644 new mode 100755 similarity index 89% rename from Mozu.Api.Test/Factories/ProductReservationFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/ProductReservationFactory.cs index f738b23a..063c9827 --- a/Mozu.Api.Test/Factories/ProductReservationFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/ProductReservationFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// - /// Use the Product Reservations resource to temporarily hold a product from inventory while a shopper is filling out payment information. You can create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete. + /// Temporarily hold a product from inventory while a shopper is filling out payment information. Create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete. /// public partial class ProductReservationFactory : BaseDataFactory { /// - /// Retrieves a list of product reservations according to any specified filter criteria and sort options. + /// /// /// /// var result = ProductReservationFactory.GetProductReservations(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductReservationCollection GetPr startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductReservationCollection GetPr } /// - /// Retrieves the details of a product reservation. + /// /// /// /// var result = ProductReservationFactory.GetProductReservation(handler : handler, productReservationId : productReservationId, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductReservation GetProductReser productReservationId : productReservationId, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductReservation GetProductReser } /// - /// Creates a new product reservation for a product. This action places a hold on the product inventory for the quantity specified during the ordering process. + /// /// /// /// var result = ProductReservationFactory.AddProductReservations(handler : handler, productReservations : productReservations, skipInventoryCheck : skipInventoryCheck, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductReservation GetProductReser productReservations : productReservations, skipInventoryCheck : skipInventoryCheck, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductReservation GetProductReser } /// - /// Commits a product reservation to decrement the product's inventory by the quantity specified then release the reservation once the order process completed successfully. + /// /// /// /// var result = ProductReservationFactory.CommitReservations(handler : handler, productReservations : productReservations, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static void CommitReservations(ServiceClientMessageHandler handler, productReservations : productReservations, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -181,7 +182,7 @@ public static void CommitReservations(ServiceClientMessageHandler handler, } /// - /// Updates an existing product reservation for a product. + /// /// /// /// var result = ProductReservationFactory.UpdateProductReservations(handler : handler, productReservations : productReservations, skipInventoryCheck : skipInventoryCheck, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -202,7 +203,7 @@ public static void CommitReservations(ServiceClientMessageHandler handler, productReservations : productReservations, skipInventoryCheck : skipInventoryCheck, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -219,7 +220,7 @@ public static void CommitReservations(ServiceClientMessageHandler handler, } /// - /// Deletes a product reservation. For example, delete a reservation when an order is not processed to return the product quantity back to inventory. + /// /// /// /// var result = ProductReservationFactory.DeleteProductReservation(handler : handler, productReservationId : productReservationId, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -240,7 +241,7 @@ public static void DeleteProductReservation(ServiceClientMessageHandler handler, productReservationId : productReservationId, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/LocationInventoryProductsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/LocationInventoryProductsFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/LocationInventoryProductsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/LocationInventoryProductsFactory.cs index 1dee1d6b..a4d7c2f6 --- a/Mozu.Api.Test/Factories/LocationInventoryProductsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/LocationInventoryProductsFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Products { /// /// Use the Product Location Inventory resource to manage the levels of active product inventory to maintain across defined locations at the product level. @@ -30,7 +31,7 @@ public partial class LocationInventoryProductsFactory : BaseDataFactory { /// - /// Retrieves all locations for which a product has inventory defined and displays the inventory definition properties of each location. + /// /// /// /// var result = LocationInventoryFactory.GetLocationInventories(handler : handler, productCode : productCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLoc productCode : productCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLoc } /// - /// Retrieves the details of the inventory of the product in the location specified in the request. + /// /// /// /// var result = LocationInventoryFactory.GetLocationInventory(handler : handler, productCode : productCode, locationCode : locationCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInven productCode : productCode, locationCode : locationCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInven } /// - /// Creates a new location inventory definition for the product code specified in the request. + /// /// /// /// var result = LocationInventoryFactory.AddLocationInventory(handler : handler, locationInventoryList : locationInventoryList, productCode : productCode, performUpserts : performUpserts, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInven locationInventoryList : locationInventoryList, productCode : productCode, performUpserts : performUpserts, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInven } /// - /// Updates the current level of stock at each location associated with the product code specified in the request. + /// /// /// /// var result = LocationInventoryFactory.UpdateLocationInventory(handler : handler, locationInventoryAdjustments : locationInventoryAdjustments, productCode : productCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInven locationInventoryAdjustments : locationInventoryAdjustments, productCode : productCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInven } /// - /// Deletes the location inventory definition for the product code specified in the request. + /// /// /// /// var result = LocationInventoryFactory.DeleteLocationInventory(handler : handler, productCode : productCode, locationCode : locationCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteLocationInventory(ServiceClientMessageHandler handler, productCode : productCode, locationCode : locationCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductExtraFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductExtraFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/ProductExtraFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductExtraFactory.cs index 64d5c4c6..03e3f9c9 --- a/Mozu.Api.Test/Factories/ProductExtraFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductExtraFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Products { /// /// Use the Extras resource to configure an extra product attribute for products associated with the product type that uses the extra attribute. @@ -30,7 +31,7 @@ public partial class ProductExtraFactory : BaseDataFactory { /// - /// Retrieves a list of extras configured for the product according to any defined filter and sort criteria. + /// /// /// /// var result = ProductExtraFactory.GetExtras(handler : handler, productCode : productCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class ProductExtraFactory : BaseDataFactory productCode : productCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class ProductExtraFactory : BaseDataFactory } /// - /// Retrieves a collection of all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductExtraFactory.GetExtraValueLocalizedDeltaPrices(handler : handler, productCode : productCode, attributeFQN : attributeFQN, value : value, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public partial class ProductExtraFactory : BaseDataFactory productCode : productCode, attributeFQN : attributeFQN, value : value, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public partial class ProductExtraFactory : BaseDataFactory } /// - /// Retrieves the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductExtraFactory.GetExtraValueLocalizedDeltaPrice(handler : handler, productCode : productCode, attributeFQN : attributeFQN, value : value, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice GetExt productCode : productCode, attributeFQN : attributeFQN, value : value, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice GetExt } /// - /// Retrieves the details of an extra attribute configuration for the product specified in the request. + /// /// /// /// var result = ProductExtraFactory.GetExtra(handler : handler, productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtra GetExtra(ServiceClien productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtra GetExtra(ServiceClien } /// - /// Adds a localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductExtraFactory.AddExtraValueLocalizedDeltaPrice(handler : handler, localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, attributeFQN : attributeFQN, value : value, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice AddExt localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, attributeFQN : attributeFQN, value : value, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice AddExt } /// - /// Configure an extra attribute for the product specified in the request. + /// /// /// /// var result = ProductExtraFactory.AddExtra(handler : handler, productExtra : productExtra, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtra AddExtra(ServiceClien productExtra : productExtra, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtra AddExtra(ServiceClien } /// - /// Updates all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductExtraFactory.UpdateExtraValueLocalizedDeltaPrices(handler : handler, localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, attributeFQN : attributeFQN, value : value, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtra AddExtra(ServiceClien localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, attributeFQN : attributeFQN, value : value, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtra AddExtra(ServiceClien } /// - /// Updates the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductExtraFactory.UpdateExtraValueLocalizedDeltaPrice(handler : handler, localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, attributeFQN : attributeFQN, value : value, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice Update localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, attributeFQN : attributeFQN, value : value, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice Update } /// - /// Updates the configuration of an extra attribute for the product specified in the request. + /// /// /// /// var result = ProductExtraFactory.UpdateExtra(handler : handler, productExtra : productExtra, productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtra UpdateExtra(ServiceCl productExtra : productExtra, productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -372,7 +373,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductExtra UpdateExtra(ServiceCl } /// - /// Delete a product extra configuration for the product specified in the request. + /// /// /// /// var result = ProductExtraFactory.DeleteExtra(handler : handler, productCode : productCode, attributeFQN : attributeFQN, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -393,7 +394,7 @@ public static void DeleteExtra(ServiceClientMessageHandler handler, productCode : productCode, attributeFQN : attributeFQN, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -409,7 +410,7 @@ public static void DeleteExtra(ServiceClientMessageHandler handler, } /// - /// Deletes the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductExtraFactory.DeleteExtraValueLocalizedDeltaPrice(handler : handler, productCode : productCode, attributeFQN : attributeFQN, value : value, currencyCode : currencyCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -430,7 +431,7 @@ public static void DeleteExtraValueLocalizedDeltaPrice(ServiceClientMessageHandl productCode : productCode, attributeFQN : attributeFQN, value : value, currencyCode : currencyCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductOptionFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductOptionFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ProductOptionFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductOptionFactory.cs index 34b621b2..51e60eee --- a/Mozu.Api.Test/Factories/ProductOptionFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductOptionFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Products { /// /// Use the Options resource to configure the option attributes and vocabulary values for an individual product associated with the product type that uses the option attribute. Options are used to generate variations of a product. @@ -30,7 +31,7 @@ public partial class ProductOptionFactory : BaseDataFactory { /// - /// Retrieves a list of all option attributes configured for the product specified in the request. + /// /// /// /// var result = ProductOptionFactory.GetOptions(handler : handler, productCode : productCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class ProductOptionFactory : BaseDataFactory productCode : productCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class ProductOptionFactory : BaseDataFactory } /// - /// Retrieves the details of an option attribute configuration for the specified product. + /// /// /// /// var result = ProductOptionFactory.GetOption(handler : handler, productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductOption GetOption(ServiceCli productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductOption GetOption(ServiceCli } /// - /// Configures an option attribute for the product specified in the request. + /// /// /// /// var result = ProductOptionFactory.AddOption(handler : handler, productOption : productOption, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductOption AddOption(ServiceCli productOption : productOption, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductOption AddOption(ServiceCli } /// - /// Updates one or more properties of an option attribute configured for a product. + /// /// /// /// var result = ProductOptionFactory.UpdateOption(handler : handler, productOption : productOption, productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductOption UpdateOption(Service productOption : productOption, productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductOption UpdateOption(Service } /// - /// Deletes the configuration of an option attribute for the product specified in the request. + /// /// /// /// var result = ProductOptionFactory.DeleteOption(handler : handler, productCode : productCode, attributeFQN : attributeFQN, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteOption(ServiceClientMessageHandler handler, productCode : productCode, attributeFQN : attributeFQN, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductPropertyFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductPropertyFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ProductPropertyFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductPropertyFactory.cs index 4390cb10..1c99557b --- a/Mozu.Api.Test/Factories/ProductPropertyFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductPropertyFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Products { /// /// Use the Properties resource to configure a property attribute for an individual product associated with a product type that uses the property attribute, as well as set property values for the product. @@ -30,7 +31,7 @@ public partial class ProductPropertyFactory : BaseDataFactory { /// - /// Retrieves a list of the property attributes configured for the product specified in the request. + /// /// /// /// var result = ProductPropertyFactory.GetProperties(handler : handler, productCode : productCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class ProductPropertyFactory : BaseDataFactory productCode : productCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class ProductPropertyFactory : BaseDataFactory } /// - /// Retrieves a collection of property values for localized content. This content is set by the locale code. + /// /// /// /// var result = ProductPropertyFactory.GetPropertyValueLocalizedContents(handler : handler, productCode : productCode, attributeFQN : attributeFQN, value : value, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public partial class ProductPropertyFactory : BaseDataFactory productCode : productCode, attributeFQN : attributeFQN, value : value, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public partial class ProductPropertyFactory : BaseDataFactory } /// - /// Retrieves the property value for localized content. This content is set by the locale code. + /// /// /// /// var result = ProductPropertyFactory.GetPropertyValueLocalizedContent(handler : handler, productCode : productCode, attributeFQN : attributeFQN, value : value, localeCode : localeCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedConte productCode : productCode, attributeFQN : attributeFQN, value : value, localeCode : localeCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedConte } /// - /// Retrieves the details of a property attribute configuration for the product specified in the request. + /// /// /// /// var result = ProductPropertyFactory.GetProperty(handler : handler, productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductProperty GetProperty(Servic productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductProperty GetProperty(Servic } /// - /// Adds a property value for localized content. This content is set by the locale code. + /// /// /// /// var result = ProductPropertyFactory.AddPropertyValueLocalizedContent(handler : handler, localizedContent : localizedContent, productCode : productCode, attributeFQN : attributeFQN, value : value, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedConte localizedContent : localizedContent, productCode : productCode, attributeFQN : attributeFQN, value : value, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedConte } /// - /// Configures a property attribute for the product specified in the request. + /// /// /// /// var result = ProductPropertyFactory.AddProperty(handler : handler, productProperty : productProperty, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductProperty AddProperty(Servic productProperty : productProperty, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductProperty AddProperty(Servic } /// - /// Updates all property values for localized content. This content is set by the locale code. + /// /// /// /// var result = ProductPropertyFactory.UpdatePropertyValueLocalizedContents(handler : handler, localizedContent : localizedContent, productCode : productCode, attributeFQN : attributeFQN, value : value, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductProperty AddProperty(Servic localizedContent : localizedContent, productCode : productCode, attributeFQN : attributeFQN, value : value, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductProperty AddProperty(Servic } /// - /// Updates the property value for localized content. This content is set by the locale code. + /// /// /// /// var result = ProductPropertyFactory.UpdatePropertyValueLocalizedContent(handler : handler, localizedContent : localizedContent, productCode : productCode, attributeFQN : attributeFQN, value : value, localeCode : localeCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedConte localizedContent : localizedContent, productCode : productCode, attributeFQN : attributeFQN, value : value, localeCode : localeCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedConte } /// - /// Update one or more details of a property attribute configuration for the product specified in the request. + /// /// /// /// var result = ProductPropertyFactory.UpdateProperty(handler : handler, productProperty : productProperty, productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductProperty UpdateProperty(Ser productProperty : productProperty, productCode : productCode, attributeFQN : attributeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -372,7 +373,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductProperty UpdateProperty(Ser } /// - /// Deletes the configuration of a property attribute for the product specified in the request. + /// /// /// /// var result = ProductPropertyFactory.DeleteProperty(handler : handler, productCode : productCode, attributeFQN : attributeFQN, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -393,7 +394,7 @@ public static void DeleteProperty(ServiceClientMessageHandler handler, productCode : productCode, attributeFQN : attributeFQN, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -409,7 +410,7 @@ public static void DeleteProperty(ServiceClientMessageHandler handler, } /// - /// Deletes the property value for localized content. This content is set by the locale code. + /// /// /// /// var result = ProductPropertyFactory.DeletePropertyValueLocalizedContent(handler : handler, productCode : productCode, attributeFQN : attributeFQN, value : value, localeCode : localeCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -430,7 +431,7 @@ public static void DeletePropertyValueLocalizedContent(ServiceClientMessageHandl productCode : productCode, attributeFQN : attributeFQN, value : value, localeCode : localeCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ProductVariationFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductVariationFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/ProductVariationFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductVariationFactory.cs index c50c8b29..dfa3109c --- a/Mozu.Api.Test/Factories/ProductVariationFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/Products/ProductVariationFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Products { /// /// Use the product variations sub-resource to manage the variations of a product based on its attributes. For example, a t-shirt product could be offered in six variations: Small Black, Medium Black, Large Black, Small White, Medium White, and Large White. @@ -30,7 +31,7 @@ public partial class ProductVariationFactory : BaseDataFactory { /// - /// Retrieves a collection of the localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductVariationFactory.GetProductVariationLocalizedDeltaPrices(handler : handler, productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class ProductVariationFactory : BaseDataFactory productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class ProductVariationFactory : BaseDataFactory } /// - /// Retrieves the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductVariationFactory.GetProductVariationLocalizedDeltaPrice(handler : handler, productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice GetProd productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice GetProd } /// - /// Retrieves a list of details of the localized price values for a product variation. + /// /// /// /// var result = ProductVariationFactory.GetProductVariationLocalizedPrices(handler : handler, productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice GetProd productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice GetProd } /// - /// Retrieves the details of the localized price value for a product variation and a specific localized currency. + /// /// /// /// var result = ProductVariationFactory.GetProductVariationLocalizedPrice(handler : handler, productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice GetProd productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice GetProd } /// - /// Retrieves the details of a product variation based on the supplied product code and variation key. + /// /// /// /// var result = ProductVariationFactory.GetProductVariation(handler : handler, productCode : productCode, variationKey : variationKey, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariation GetProductVariati productCode : productCode, variationKey : variationKey, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariation GetProductVariati } /// - /// Retrieves a list of the product variations configured for the specified product code. + /// /// /// /// var result = ProductVariationFactory.GetProductVariations(handler : handler, productCode : productCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationPagedCollection Ge productCode : productCode, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationPagedCollection Ge } /// - /// Adds the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductVariationFactory.AddProductVariationLocalizedDeltaPrice(handler : handler, localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, variationKey : variationKey, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice AddProd localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, variationKey : variationKey, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice AddProd } /// - /// Adds the localized price value for a product variation and a specific localized currency. + /// /// /// /// var result = ProductVariationFactory.AddProductVariationLocalizedPrice(handler : handler, localizedPrice : localizedPrice, productCode : productCode, variationKey : variationKey, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice AddProd localizedPrice : localizedPrice, productCode : productCode, variationKey : variationKey, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice AddProd } /// - /// Updates all localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductVariationFactory.UpdateProductVariationLocalizedDeltaPrices(handler : handler, localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice AddProd localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -372,7 +373,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice AddProd } /// - /// Updates the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductVariationFactory.UpdateProductVariationLocalizedDeltaPrice(handler : handler, localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -393,7 +394,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice UpdateP localizedDeltaPrice : localizedDeltaPrice, productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -410,7 +411,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice UpdateP } /// - /// Updates a list of localized price values for a product variation. + /// /// /// /// var result = ProductVariationFactory.UpdateProductVariationLocalizedPrices(handler : handler, localizedPrice : localizedPrice, productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -431,7 +432,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice UpdateP localizedPrice : localizedPrice, productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -448,7 +449,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice UpdateP } /// - /// Updates the localized price value for a product variation and a specific localized currency. + /// /// /// /// var result = ProductVariationFactory.UpdateProductVariationLocalizedPrice(handler : handler, localizedPrice : localizedPrice, productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -469,7 +470,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice UpdateP localizedPrice : localizedPrice, productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -486,7 +487,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice UpdateP } /// - /// Modifies the details of a variation, based on the supplied variation key, for the specified product code. + /// /// /// /// var result = ProductVariationFactory.UpdateProductVariation(handler : handler, productVariation : productVariation, productCode : productCode, variationKey : variationKey, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -507,7 +508,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariation UpdateProductVari productVariation : productVariation, productCode : productCode, variationKey : variationKey, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -524,7 +525,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariation UpdateProductVari } /// - /// Modifies the collection of variations for the specified product code. Because this PUT replaces the existing resource, supply all information necessary to maintain for the product variation. + /// /// /// /// var result = ProductVariationFactory.UpdateProductVariations(handler : handler, productVariations : productVariations, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -545,7 +546,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationCollection UpdateP productVariations : productVariations, productCode : productCode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -562,7 +563,7 @@ public static Mozu.Api.Contracts.ProductAdmin.ProductVariationCollection UpdateP } /// - /// Deletes a variation, based on the supplied variation key, for the specified product code. + /// /// /// /// var result = ProductVariationFactory.DeleteProductVariation(handler : handler, productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -583,7 +584,7 @@ public static void DeleteProductVariation(ServiceClientMessageHandler handler, productCode : productCode, variationKey : variationKey, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -599,7 +600,7 @@ public static void DeleteProductVariation(ServiceClientMessageHandler handler, } /// - /// Deletes the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// /// /// var result = ProductVariationFactory.DeleteProductVariationLocalizedDeltaPrice(handler : handler, productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -620,7 +621,7 @@ public static void DeleteProductVariationLocalizedDeltaPrice(ServiceClientMessag productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -636,7 +637,7 @@ public static void DeleteProductVariationLocalizedDeltaPrice(ServiceClientMessag } /// - /// Deletes the localized price value for a product variation and a specific localized currency. + /// /// /// /// var result = ProductVariationFactory.DeleteProductVariationLocalizedPrice(handler : handler, productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -657,7 +658,7 @@ public static void DeleteProductVariationLocalizedPrice(ServiceClientMessageHand productCode : productCode, variationKey : variationKey, currencyCode : currencyCode, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PublishingScopeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/PublishingScopeFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/PublishingScopeFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/PublishingScopeFactory.cs index e1748fcb..9ca61746 --- a/Mozu.Api.Test/Factories/PublishingScopeFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/PublishingScopeFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// - /// Use the Product Publishing resource to publish or discard pending changes to products in a master catalog, or to add or remove pending changes to and from product publish sets.You can use product publish sets to group pending product changes together and publish them all at the same time. + /// Use the Product Publishing resource to publish or discard pending changes to product definitions in the master catalog. /// public partial class PublishingScopeFactory : BaseDataFactory { /// - /// Retrieves the details of the specified product publish set. + /// /// /// /// var result = PublishingScopeFactory.GetPublishSet(handler : handler, publishSetCode : publishSetCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSet GetPublishSet(ServiceCl publishSetCode : publishSetCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSet GetPublishSet(ServiceCl } /// - /// Retrieves a list of product publish sets and their properties, including the amount of pending product changes that are included in each one. + /// /// /// /// var result = PublishingScopeFactory.GetPublishSets(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSetCollection GetPublishSet responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSetCollection GetPublishSet } /// - /// Deletes the draft version of product changes (pending product changes) for each product code specified in the request. + /// /// /// /// var result = PublishingScopeFactory.DiscardDrafts(handler : handler, publishScope : publishScope, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static void DiscardDrafts(ServiceClientMessageHandler handler, publishScope : publishScope, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -143,7 +144,7 @@ public static void DiscardDrafts(ServiceClientMessageHandler handler, } /// - /// Publishes the draft version of product changes (pending product changes) for each product code specified in the request, and changes the product publish state to "live". + /// /// /// /// var result = PublishingScopeFactory.PublishDrafts(handler : handler, publishScope : publishScope, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -164,7 +165,7 @@ public static void PublishDrafts(ServiceClientMessageHandler handler, publishScope : publishScope, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -180,7 +181,7 @@ public static void PublishDrafts(ServiceClientMessageHandler handler, } /// - /// Assigns pending product changes to a specified product publish set. Use the code field to specify the product publish set. + /// /// /// /// var result = PublishingScopeFactory.AssignProductsToPublishSet(handler : handler, publishSet : publishSet, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -201,7 +202,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSet AssignProductsToPublish publishSet : publishSet, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -218,7 +219,7 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSet AssignProductsToPublish } /// - /// Deletes the specified product publish set. If you set the discardDrafts parameter to true, this operation also deletes the product drafts assigned to the publish set. + /// /// /// /// var result = PublishingScopeFactory.DeletePublishSet(handler : handler, publishSetCode : publishSetCode, discardDrafts : discardDrafts, expectedCode: expectedCode, successCode: successCode); @@ -239,7 +240,7 @@ public static void DeletePublishSet(ServiceClientMessageHandler handler, publishSetCode : publishSetCode, discardDrafts : discardDrafts ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/SearchFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/SearchFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/SearchFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/SearchFactory.cs index 95141fd6..d8efef63 --- a/Mozu.Api.Test/Factories/SearchFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/SearchFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// - /// Use the Search resource to manage all settings and options for providing product search on your site, as well as search tuning rules. + /// /// public partial class SearchFactory : BaseDataFactory { /// - /// Retrieves the details of the specified search tuning rule. + /// /// /// /// var result = SearchFactory.GetSearchTuningRule(handler : handler, searchTuningRuleCode : searchTuningRuleCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule GetSearchT searchTuningRuleCode : searchTuningRuleCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule GetSearchT } /// - /// Retrieves a list of search tuning rules and their properties. + /// /// /// /// var result = SearchFactory.GetSearchTuningRules(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleCollection startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleCollection } /// - /// Retrieves the details of the specified search tuning rule sort fields. Sort fields allow you to control the product relevance whenver shoppers sort products on a page. For more information about sort relevance, refer to [Search Tuning Rules and Sorting](../../../developer/api-guides/search-tuning-rules.htm#search_tuning_rules_and_sorting). + /// /// /// /// var result = SearchFactory.GetSearchTuningRuleSortFields(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields } /// - /// Retrieves the search settings for the specified site.Refer to [Search Settings API Overview](../../../../developer/api-guides/search-settings.htm) for more information about 's search settings. + /// /// /// /// var result = SearchFactory.GetSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SearchSettings GetSettings(Service responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SearchSettings GetSettings(Service } /// - /// Retrieves a collection of synonyms definitions for product searches.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// /// /// var result = SearchFactory.GetSynonymDefinitionCollection(handler : handler, localeCode : localeCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollection localeCode : localeCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollection } /// - /// Retrieves a list of synonym definitions according to any specified filter criteria and sort options.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// /// /// var result = SearchFactory.GetSynonymDefinitions(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionPagedColle startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionPagedColle } /// - /// Retrieves the details of the specified synonym defintion.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// /// /// var result = SearchFactory.GetSynonymDefinition(handler : handler, synonymId : synonymId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition GetSynony synonymId : synonymId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition GetSynony } /// - /// Creates a search tuning rule for your site. You can use search tuning rules to fine tune the product search results that appear when a shopper searches for a specific keyword, or navigates to a category page.For more information on search tuning rules, refer to [Search Tuning Rules](../../../../developer/api-guides/search-tuning-rules.htm). + /// /// /// /// var result = SearchFactory.AddSearchTuningRule(handler : handler, searchTuningRuleIn : searchTuningRuleIn, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule AddSearchT searchTuningRuleIn : searchTuningRuleIn, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule AddSearchT } /// - /// Updates the details of the search tuning rule sort fields. + /// /// /// /// var result = SearchFactory.UpdateSearchTuningRuleSortFields(handler : handler, searchTuningRuleSortFieldsIn : searchTuningRuleSortFieldsIn, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields searchTuningRuleSortFieldsIn : searchTuningRuleSortFieldsIn, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -372,7 +373,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields } /// - /// Updates a collection of synonym definitions.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// /// /// var result = SearchFactory.UpdateSynonymDefinitionCollection(handler : handler, collection : collection, localeCode : localeCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -393,7 +394,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollection collection : collection, localeCode : localeCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -410,7 +411,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollection } /// - /// Creates a new synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// /// /// var result = SearchFactory.AddSynonymDefinition(handler : handler, synonymDefinition : synonymDefinition, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -431,7 +432,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition AddSynony synonymDefinition : synonymDefinition, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -448,7 +449,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition AddSynony } /// - /// Updates the details of the specified search tuning rule. + /// /// /// /// var result = SearchFactory.UpdateSearchTuningRule(handler : handler, searchTuningRuleIn : searchTuningRuleIn, searchTuningRuleCode : searchTuningRuleCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -469,7 +470,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule UpdateSear searchTuningRuleIn : searchTuningRuleIn, searchTuningRuleCode : searchTuningRuleCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -486,7 +487,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule UpdateSear } /// - /// Updates the search setting properties for a specific site.Refer to [Search Settings API Overview](../../../../developer/api-guides/search-settings.htm) for more information about 's search settings. + /// /// /// /// var result = SearchFactory.UpdateSettings(handler : handler, settings : settings, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -507,7 +508,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SearchSettings UpdateSettings(Serv settings : settings, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -524,7 +525,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SearchSettings UpdateSettings(Serv } /// - /// Updates the details of a synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// /// /// var result = SearchFactory.UpdateSynonymDefinition(handler : handler, synonymDefinition : synonymDefinition, synonymId : synonymId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -545,7 +546,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition UpdateSyn synonymDefinition : synonymDefinition, synonymId : synonymId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -562,7 +563,7 @@ public static Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition UpdateSyn } /// - /// Deletes the specified search tuning rule from the site. + /// /// /// /// var result = SearchFactory.DeleteSearchTuningRule(handler : handler, searchTuningRuleCode : searchTuningRuleCode, expectedCode: expectedCode, successCode: successCode); @@ -583,7 +584,7 @@ public static void DeleteSearchTuningRule(ServiceClientMessageHandler handler, searchTuningRuleCode : searchTuningRuleCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -599,7 +600,7 @@ public static void DeleteSearchTuningRule(ServiceClientMessageHandler handler, } /// - /// Deletes the specified synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// /// /// var result = SearchFactory.DeleteSynonymDefinition(handler : handler, synonymId : synonymId, expectedCode: expectedCode, successCode: successCode); @@ -620,7 +621,7 @@ public static void DeleteSynonymDefinition(ServiceClientMessageHandler handler, synonymId : synonymId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/SoftAllocationFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/SoftAllocationFactory.cs old mode 100644 new mode 100755 similarity index 88% rename from Mozu.Api.Test/Factories/SoftAllocationFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Admin/SoftAllocationFactory.cs index 85177305..c794943e --- a/Mozu.Api.Test/Factories/SoftAllocationFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Admin/SoftAllocationFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Admin { /// - /// The Soft Allocations resource allows you to temporarily hold a product from inventory while a shopper is filling out payment information. You create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete. + /// /// public partial class SoftAllocationFactory : BaseDataFactory { /// - /// Retrieves a list of sof allocations according to any specified filter criteria and sort options. + /// /// /// /// var result = SoftAllocationFactory.GetSoftAllocations(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocationCollection GetSoftAl startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocationCollection GetSoftAl } /// - /// Retrieves the details of a soft allocation. + /// /// /// /// var result = SoftAllocationFactory.GetSoftAllocation(handler : handler, softAllocationId : softAllocationId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S softAllocationId : softAllocationId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S } /// - /// Creates a new soft allocation for a product. This places a hold on the product inventory for the quantity specified during the ordering process. + /// /// /// /// var result = SoftAllocationFactory.AddSoftAllocations(handler : handler, softAllocationsIn : softAllocationsIn, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S softAllocationsIn : softAllocationsIn ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S } /// - /// Converts a set of existing soft product allocations into product reservations. + /// /// /// /// var result = SoftAllocationFactory.ConvertToProductReservation(handler : handler, softAllocations : softAllocations, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S softAllocations : softAllocations ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S } /// - /// Updates the expiration time for a set of soft allocations in a non-transactional batch. + /// /// /// /// var result = SoftAllocationFactory.RenewSoftAllocations(handler : handler, softAllocationRenew : softAllocationRenew, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S softAllocationRenew : softAllocationRenew ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S } /// - /// Updates a soft allocation. This updates a hold on the product inventory for the quantity specified during the ordering process. + /// /// /// /// var result = SoftAllocationFactory.UpdateSoftAllocations(handler : handler, softAllocations : softAllocations, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S softAllocations : softAllocations ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(S } /// - /// Deletes a soft allocation. You might delete a soft allocation when an order or cart is not processed in order to return the product quantity back to inventory. + /// /// /// /// var result = SoftAllocationFactory.DeleteSoftAllocation(handler : handler, softAllocationId : softAllocationId, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static void DeleteSoftAllocation(ServiceClientMessageHandler handler, softAllocationId : softAllocationId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/StorefrontCategoryFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontCategoryFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/StorefrontCategoryFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontCategoryFactory.cs index 4a650817..3ad8c9b2 --- a/Mozu.Api.Test/Factories/StorefrontCategoryFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontCategoryFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Storefront { /// /// Use the Storefront Categories resource to view the product category hierarchy as it appears to shoppers who are browsing the storefront. The hierarchy can be returned as a flat list or as a category tree. @@ -30,7 +31,7 @@ public partial class StorefrontCategoryFactory : BaseDataFactory { /// - /// Retrieves a list of categories according to any specified filter criteria and sort options. + /// /// /// /// var result = CategoryFactory.GetCategories(handler : handler, filter : filter, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductRuntime.CategoryPagedCollection GetCateg filter : filter, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductRuntime.CategoryPagedCollection GetCateg } /// - /// Retrieves the details of a single category. + /// /// /// /// var result = CategoryFactory.GetCategory(handler : handler, categoryId : categoryId, allowInactive : allowInactive, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductRuntime.Category GetCategory(ServiceClie categoryId : categoryId, allowInactive : allowInactive, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductRuntime.Category GetCategory(ServiceClie } /// - /// Retrieves the list of product categories that appear on the storefront organized in a hierarchical format. Hidden categories do not appear in the list. + /// /// /// /// var result = CategoryFactory.GetCategoryTree(handler : handler, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductRuntime.CategoryCollection GetCategoryTr responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/StorefrontOrderTaxContextFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontOrderTaxContextFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/StorefrontOrderTaxContextFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontOrderTaxContextFactory.cs index 53fa3691..96279115 --- a/Mozu.Api.Test/Factories/StorefrontOrderTaxContextFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontOrderTaxContextFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Storefront { /// - /// Use the Storefront Tax resource to retrieve tax information from the storefront. + /// /// public partial class StorefrontOrderTaxContextFactory : BaseDataFactory { /// - /// Retrieves tax information applicable to the site. + /// /// /// /// var result = OrderTaxContextFactory.EstimateTaxes(handler : handler, taxableOrder : taxableOrder, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.PricingRuntime.OrderTaxContext EstimateTaxes(Se taxableOrder : taxableOrder, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/StorefrontPriceListFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontPriceListFactory.cs old mode 100644 new mode 100755 similarity index 86% rename from Mozu.Api.Test/Factories/StorefrontPriceListFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontPriceListFactory.cs index 56d13637..8d5ffb19 --- a/Mozu.Api.Test/Factories/StorefrontPriceListFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontPriceListFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Storefront { /// - /// Retrieves the details of a price list. The details may contain a hierarchy of ancestor and/or descendant price lists dependening on your configuration. + /// /// public partial class StorefrontPriceListFactory : BaseDataFactory { /// - /// Retrieves the details of the specified price list. + /// /// /// /// var result = PriceListFactory.GetPriceList(handler : handler, priceListCode : priceListCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductRuntime.PriceList GetPriceList(ServiceCl priceListCode : priceListCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductRuntime.PriceList GetPriceList(ServiceCl } /// - /// Retrieves the details of a price list to which the specified customer resolves. This is primarly used when creating an offline order for a shopper.You can use this operation alongside custom Arc.js actions to alter the price list to which a shopper resolves. + /// /// /// /// var result = PriceListFactory.GetResolvedPriceList(handler : handler, customerAccountId : customerAccountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ResolvedPriceList GetResolvedPri customerAccountId : customerAccountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/StorefrontProductFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontProductFactory.cs old mode 100644 new mode 100755 similarity index 86% rename from Mozu.Api.Test/Factories/StorefrontProductFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontProductFactory.cs index a4bad7cf..1f41970d --- a/Mozu.Api.Test/Factories/StorefrontProductFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontProductFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Storefront { /// - /// Use the Storefront Products resource to manage the shopper product selection process during a visit to the web storefront. You can update product options as shoppers pick and choose their product choices. A shopper cannot add a product to a cart until all of its required options have been selected. + /// Use the Storefront Products resource to manage the shopper product selection process during a visit to the web storefront. You can update product options as shoppers pick and choose their product choices. A shopper cannot add a product to a cart until all of its required options have been selected. /// public partial class StorefrontProductFactory : BaseDataFactory { /// - /// Retrieves a list of products that appear on the web storefront according to any specified filter criteria and sort options. + /// /// /// /// var result = ProductFactory.GetProducts(handler : handler, filter : filter, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseOptions : responseOptions, cursorMark : cursorMark, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductCollection GetProducts(Se filter : filter, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseOptions : responseOptions, cursorMark : cursorMark, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductCollection GetProducts(Se } /// - /// Retrieves the active inventory level information associated with the product or location specified in the request. + /// /// /// /// var result = ProductFactory.GetProductInventory(handler : handler, productCode : productCode, locationCodes : locationCodes, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductRuntime.LocationInventoryCollection GetP productCode : productCode, locationCodes : locationCodes, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,17 +107,17 @@ public static Mozu.Api.Contracts.ProductRuntime.LocationInventoryCollection GetP } /// - /// Retrieves information about a single product given its product code. + /// /// /// - /// var result = ProductFactory.GetProduct(handler : handler, productCode : productCode, variationProductCode : variationProductCode, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, supressOutOfStock404 : supressOutOfStock404, quantity : quantity, acceptVariantProductCode : acceptVariantProductCode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); + /// var result = ProductFactory.GetProduct(handler : handler, productCode : productCode, variationProductCode : variationProductCode, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, supressOutOfStock404 : supressOutOfStock404, quantity : quantity, acceptVariantProductCode : acceptVariantProductCode, purchaseLocation : purchaseLocation, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.ProductRuntime.Product GetProduct(ServiceClientMessageHandler handler, - string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, int? quantity = null, bool? acceptVariantProductCode = null, string responseFields = null, DataViewMode dataViewMode= DataViewMode.Live, + string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, int? quantity = null, bool? acceptVariantProductCode = null, string purchaseLocation = null, string responseFields = null, DataViewMode dataViewMode= DataViewMode.Live, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -124,10 +125,10 @@ public static Mozu.Api.Contracts.ProductRuntime.Product GetProduct(ServiceClient var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductClient( - productCode : productCode, variationProductCode : variationProductCode, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, supressOutOfStock404 : supressOutOfStock404, quantity : quantity, acceptVariantProductCode : acceptVariantProductCode, responseFields : responseFields, dataViewMode: dataViewMode ); + productCode : productCode, variationProductCode : variationProductCode, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, supressOutOfStock404 : supressOutOfStock404, quantity : quantity, acceptVariantProductCode : acceptVariantProductCode, purchaseLocation : purchaseLocation, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ProductRuntime.Product GetProduct(ServiceClient } /// - /// Retrieves information about a single product given its product code for to index in the search engine + /// /// /// /// var result = ProductFactory.GetProductForIndexing(handler : handler, productCode : productCode, productVersion : productVersion, lastModifiedDate : lastModifiedDate, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ProductRuntime.Product GetProductForIndexing(Se productCode : productCode, productVersion : productVersion, lastModifiedDate : lastModifiedDate, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,17 +183,17 @@ public static Mozu.Api.Contracts.ProductRuntime.Product GetProductForIndexing(Se } /// - /// Creates a new product configuration each time a shopper selects a product option value. After the shopper defines values for all required product options, the shopper can add the product configuration to a cart. + /// /// /// - /// var result = ProductFactory.ConfiguredProduct(handler : handler, productOptionSelections : productOptionSelections, productCode : productCode, includeOptionDetails : includeOptionDetails, skipInventoryCheck : skipInventoryCheck, quantity : quantity, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = ProductFactory.ConfiguredProduct(handler : handler, productOptionSelections : productOptionSelections, productCode : productCode, includeOptionDetails : includeOptionDetails, skipInventoryCheck : skipInventoryCheck, quantity : quantity, purchaseLocation : purchaseLocation, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.ProductRuntime.ConfiguredProduct ConfiguredProduct(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, int? quantity = null, string responseFields = null, + Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, int? quantity = null, string purchaseLocation = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -200,10 +201,10 @@ public static Mozu.Api.Contracts.ProductRuntime.ConfiguredProduct ConfiguredProd var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ConfiguredProductClient( - productOptionSelections : productOptionSelections, productCode : productCode, includeOptionDetails : includeOptionDetails, skipInventoryCheck : skipInventoryCheck, quantity : quantity, responseFields : responseFields ); + productOptionSelections : productOptionSelections, productCode : productCode, includeOptionDetails : includeOptionDetails, skipInventoryCheck : skipInventoryCheck, quantity : quantity, purchaseLocation : purchaseLocation, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,17 +221,17 @@ public static Mozu.Api.Contracts.ProductRuntime.ConfiguredProduct ConfiguredProd } /// - /// Validate the final state of shopper-selected options. + /// /// /// - /// var result = ProductFactory.ValidateProduct(handler : handler, productOptionSelections : productOptionSelections, productCode : productCode, skipInventoryCheck : skipInventoryCheck, quantity : quantity, skipDefaults : skipDefaults, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = ProductFactory.ValidateProduct(handler : handler, productOptionSelections : productOptionSelections, productCode : productCode, skipInventoryCheck : skipInventoryCheck, quantity : quantity, skipDefaults : skipDefaults, purchaseLocation : purchaseLocation, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.ProductRuntime.ProductValidationSummary ValidateProduct(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? skipInventoryCheck = null, int? quantity = null, bool? skipDefaults = null, string responseFields = null, + Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? skipInventoryCheck = null, int? quantity = null, bool? skipDefaults = null, string purchaseLocation = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -238,10 +239,10 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductValidationSummary Validat var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ValidateProductClient( - productOptionSelections : productOptionSelections, productCode : productCode, skipInventoryCheck : skipInventoryCheck, quantity : quantity, skipDefaults : skipDefaults, responseFields : responseFields ); + productOptionSelections : productOptionSelections, productCode : productCode, skipInventoryCheck : skipInventoryCheck, quantity : quantity, skipDefaults : skipDefaults, purchaseLocation : purchaseLocation, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductValidationSummary Validat } /// - /// Evaluates whether a collection of discounts specified in the request can be redeemed for the supplied product code. + /// /// /// /// var result = ProductFactory.ValidateDiscounts(handler : handler, discountSelections : discountSelections, productCode : productCode, variationProductCode : variationProductCode, customerAccountId : customerAccountId, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.ProductRuntime.DiscountValidationSummary Valida discountSelections : discountSelections, productCode : productCode, variationProductCode : variationProductCode, customerAccountId : customerAccountId, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.ProductRuntime.DiscountValidationSummary Valida } /// - /// Retrieves the product cost based on a list of product codes. The product cost is the amount the merchant pays for the product—it is not the price that the shopper sees on the storefront (which is usually higher). + /// /// /// /// var result = ProductFactory.GetProductCosts(handler : handler, query : query, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductCostCollection GetProduct query : query, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductCostCollection GetProduct } /// - /// Retrieves product inventories for the storefront displayed products. + /// /// /// /// var result = ProductFactory.GetProductInventories(handler : handler, query : query, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static Mozu.Api.Contracts.ProductRuntime.LocationInventoryCollection GetP query : query, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/StorefrontProductSearchResultFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontProductSearchResultFactory.cs old mode 100644 new mode 100755 similarity index 89% rename from Mozu.Api.Test/Factories/StorefrontProductSearchResultFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontProductSearchResultFactory.cs index 5c738c11..58c317f1 --- a/Mozu.Api.Test/Factories/StorefrontProductSearchResultFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontProductSearchResultFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Storefront { /// /// Use the Product Search resource to provide dynamic search results to shoppers as they browse and search for products on the web storefront, and to suggest possible search terms as the shopper enters text. @@ -30,7 +31,7 @@ public partial class StorefrontProductSearchResultFactory : BaseDataFactory { /// - /// Random access paging computes a set of , which can each then be provided to the operation in the resource or the operation in the resource. You can provide the computed groups in any order to the operations, and can therefore parallelize calls to retrieve products more quickly. To generate the set of , call this () operation, in which you can optionally provide query and/or filter parameters to limit the products matched by the cursor. After executing this operation, pass one of the returned to the parameter of the or operations. + /// /// /// /// var result = ProductSearchResultFactory.GetRandomAccessCursor(handler : handler, query : query, filter : filter, pageSize : pageSize, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductSearchRandomAccessCursor query : query, filter : filter, pageSize : pageSize, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductSearchRandomAccessCursor } /// - /// Searches the categories displayed on the web storefront for products or product options that the shopper types in a search query. + /// /// /// /// var result = ProductSearchResultFactory.Search(handler : handler, query : query, filter : filter, facetTemplate : facetTemplate, facetTemplateSubset : facetTemplateSubset, facet : facet, facetFieldRangeQuery : facetFieldRangeQuery, facetHierPrefix : facetHierPrefix, facetHierValue : facetHierValue, facetHierDepth : facetHierDepth, facetStartIndex : facetStartIndex, facetPageSize : facetPageSize, facetSettings : facetSettings, facetValueFilter : facetValueFilter, sortBy : sortBy, pageSize : pageSize, startIndex : startIndex, searchSettings : searchSettings, enableSearchTuningRules : enableSearchTuningRules, searchTuningRuleContext : searchTuningRuleContext, searchTuningRuleCode : searchTuningRuleCode, facetTemplateExclude : facetTemplateExclude, facetPrefix : facetPrefix, responseOptions : responseOptions, cursorMark : cursorMark, facetValueSort : facetValueSort, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductSearchResult Search(Servi query : query, filter : filter, facetTemplate : facetTemplate, facetTemplateSubset : facetTemplateSubset, facet : facet, facetFieldRangeQuery : facetFieldRangeQuery, facetHierPrefix : facetHierPrefix, facetHierValue : facetHierValue, facetHierDepth : facetHierDepth, facetStartIndex : facetStartIndex, facetPageSize : facetPageSize, facetSettings : facetSettings, facetValueFilter : facetValueFilter, sortBy : sortBy, pageSize : pageSize, startIndex : startIndex, searchSettings : searchSettings, enableSearchTuningRules : enableSearchTuningRules, searchTuningRuleContext : searchTuningRuleContext, searchTuningRuleCode : searchTuningRuleCode, facetTemplateExclude : facetTemplateExclude, facetPrefix : facetPrefix, responseOptions : responseOptions, cursorMark : cursorMark, facetValueSort : facetValueSort, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ProductRuntime.ProductSearchResult Search(Servi } /// - /// Suggests possible search terms as the shopper enters search text. + /// /// /// /// var result = ProductSearchResultFactory.Suggest(handler : handler, query : query, groups : groups, pageSize : pageSize, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ProductRuntime.SearchSuggestionResult Suggest(S query : query, groups : groups, pageSize : pageSize, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ExtensionsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontShippingFactory.cs old mode 100644 new mode 100755 similarity index 58% rename from Mozu.Api.Test/Factories/ExtensionsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontShippingFactory.cs index 7f6a674c..8e1221aa --- a/Mozu.Api.Test/Factories/ExtensionsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Catalog/Storefront/StorefrontShippingFactory.cs @@ -18,40 +18,41 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Catalog.Storefront { /// - /// platform/extensions related resources. DOCUMENT_HERE + /// Use the Storefront Shipping resource to retrieve shipping rate information from the website. /// - public partial class ExtensionsFactory : BaseDataFactory + public partial class StorefrontShippingFactory : BaseDataFactory { /// - /// platform-extensions Get GetExtensions description DOCUMENT_HERE + /// /// /// - /// var result = ExtensionsFactory.GetExtensions(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = ShippingFactory.GetMultiRates(handler : handler, rateRequestGroupList : rateRequestGroupList, includeRawResponse : includeRawResponse, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.InstalledApplications.TenantExtensions GetExtensions(ServiceClientMessageHandler handler, - string responseFields = null, + public static List GetMultiRates(ServiceClientMessageHandler handler, + List rateRequestGroupList, bool? includeRawResponse = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ExtensionsClient.GetExtensionsClient( - responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ShippingClient.GetMultiRatesClient( + rateRequestGroupList : rateRequestGroupList, includeRawResponse : includeRawResponse ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,28 +69,28 @@ public static Mozu.Api.Contracts.InstalledApplications.TenantExtensions GetExten } /// - /// platform-extensions Put UpdateExtensions description DOCUMENT_HERE + /// /// /// - /// var result = ExtensionsFactory.UpdateExtensions(handler : handler, extensions : extensions, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = ShippingFactory.GetRates(handler : handler, rateRequest : rateRequest, includeRawResponse : includeRawResponse, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.InstalledApplications.TenantExtensions UpdateExtensions(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.InstalledApplications.TenantExtensions extensions, string responseFields = null, + public static Mozu.Api.Contracts.ShippingRuntime.RatesResponse GetRates(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.ShippingRuntime.RateRequest rateRequest, bool? includeRawResponse = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ExtensionsClient.UpdateExtensionsClient( - extensions : extensions, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ShippingClient.GetRatesClient( + rateRequest : rateRequest, includeRawResponse : includeRawResponse, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ChannelFactory.cs b/Mozu.Api.Test/Factories/Commerce/ChannelFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/ChannelFactory.cs rename to Mozu.Api.Test/Factories/Commerce/ChannelFactory.cs index 8ee22dd8..c4afd47d --- a/Mozu.Api.Test/Factories/ChannelFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/ChannelFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce { /// /// Use the Channels resource to manage the channels a company uses to create logical commercial business divisions based on region or types of sales, such as "US Online," "Amazon," or "EMEA Retail." All orders include a channel association that enables the company to perform financial reporting for each defined channel. Because channels are managed at the tenant level, you must associate all the tenant's sites with a channel. Sites that do not have a defined channel association cannot successfully submit orders. @@ -30,7 +31,7 @@ public partial class ChannelFactory : BaseDataFactory { /// - /// Retrieves a list of channels defined for a tenant according to any filter or sort criteria specified in the request. + /// /// /// /// var result = ChannelFactory.GetChannels(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelCollection GetC startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelCollection GetC } /// - /// Retrieves the details of the channel specified in the request. + /// /// /// /// var result = ChannelFactory.GetChannel(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.Channel GetChannel(Ser code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.Channel GetChannel(Ser } /// - /// Creates a new channel that defines a new logical business division to use for financial reporting. + /// /// /// /// var result = ChannelFactory.CreateChannel(handler : handler, channel : channel, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.Channel CreateChannel( channel : channel, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.Channel CreateChannel( } /// - /// Updates one or more details of a defined channel, including the associated sites. + /// /// /// /// var result = ChannelFactory.UpdateChannel(handler : handler, channel : channel, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.Channel UpdateChannel( channel : channel, code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.Channel UpdateChannel( } /// - /// Deletes a defined channel for the tenant and removes the defined site associations. After deleting this channel, assign its associated sites to another channel. + /// /// /// /// var result = ChannelFactory.DeleteChannel(handler : handler, code : code, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteChannel(ServiceClientMessageHandler handler, code : code ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ChannelGroupFactory.cs b/Mozu.Api.Test/Factories/Commerce/ChannelGroupFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/ChannelGroupFactory.cs rename to Mozu.Api.Test/Factories/Commerce/ChannelGroupFactory.cs index 5a34bcd2..bdc3e418 --- a/Mozu.Api.Test/Factories/ChannelGroupFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/ChannelGroupFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce { /// /// Use the Channel Groups resource to manage groups of channels with common information. @@ -30,7 +31,7 @@ public partial class ChannelGroupFactory : BaseDataFactory { /// - /// Retrieves a list of defined channel groups according to any filter and sort criteria specified in the request. + /// /// /// /// var result = ChannelGroupFactory.GetChannelGroups(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroupCollection startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroupCollection } /// - /// Retrieves the details of a defined channel group. + /// /// /// /// var result = ChannelGroupFactory.GetChannelGroup(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup GetChanne code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup GetChanne } /// - /// Creates a new group of channels with common information. + /// /// /// /// var result = ChannelGroupFactory.CreateChannelGroup(handler : handler, channelGroup : channelGroup, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup CreateCha channelGroup : channelGroup, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup CreateCha } /// - /// Updates one or more properties of a defined channel group. + /// /// /// /// var result = ChannelGroupFactory.UpdateChannelGroup(handler : handler, channelGroup : channelGroup, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup UpdateCha channelGroup : channelGroup, code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup UpdateCha } /// - /// Deletes a defined group of channels, which removes the group association with each channel in the group but does not delete the channel definitions themselves. + /// /// /// /// var result = ChannelGroupFactory.DeleteChannelGroup(handler : handler, code : code, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteChannelGroup(ServiceClientMessageHandler handler, code : code ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/Commerce/CheckoutFactory.cs b/Mozu.Api.Test/Factories/Commerce/CheckoutFactory.cs new file mode 100755 index 00000000..275f50fd --- /dev/null +++ b/Mozu.Api.Test/Factories/Commerce/CheckoutFactory.cs @@ -0,0 +1,455 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#region Usings Setup + +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Net; +using Mozu.Api; +using Mozu.Api.Security; +using Mozu.Api.Test.Helpers; +using System.Diagnostics; +using Newtonsoft.Json.Linq; +using System.Threading; + +#endregion + +namespace Mozu.Api.Test.Factories.Commerce +{ + /// + /// + /// + public partial class CheckoutFactory : BaseDataFactory + { + + /// + /// + /// + /// + /// var result = CheckoutFactory.GetCheckouts(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.CheckoutCollection GetCheckouts(ServiceClientMessageHandler handler, + int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.GetCheckoutsClient( + startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.GetAvailableActions(handler : handler, checkoutId : checkoutId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); + /// return optionalCasting; + /// + /// + /// + public static List GetAvailableActions(ServiceClientMessageHandler handler, + string checkoutId, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.GetAvailableActionsClient( + checkoutId : checkoutId ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.GetAvailableShippingMethods(handler : handler, checkoutId : checkoutId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); + /// return optionalCasting; + /// + /// + /// + public static List GetAvailableShippingMethods(ServiceClientMessageHandler handler, + string checkoutId, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.GetAvailableShippingMethodsClient( + checkoutId : checkoutId ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.GetCheckout(handler : handler, checkoutId : checkoutId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout GetCheckout(ServiceClientMessageHandler handler, + string checkoutId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.GetCheckoutClient( + checkoutId : checkoutId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.CreateCheckoutFromCart(handler : handler, cartId : cartId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout CreateCheckoutFromCart(ServiceClientMessageHandler handler, + string cartId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.CreateCheckoutFromCartClient( + cartId : cartId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.PerformCheckoutAction(handler : handler, action : action, checkoutId : checkoutId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout PerformCheckoutAction(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Checkouts.CheckoutAction action, string checkoutId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.PerformCheckoutActionClient( + action : action, checkoutId : checkoutId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.ResendCheckoutConfirmationEmail(handler : handler, checkoutId : checkoutId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static void ResendCheckoutConfirmationEmail(ServiceClientMessageHandler handler, + string checkoutId, + HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.ResendCheckoutConfirmationEmailClient( + checkoutId : checkoutId ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + } + var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.SetShippingMethods(handler : handler, groupShippingMethods : groupShippingMethods, checkoutId : checkoutId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout SetShippingMethods(ServiceClientMessageHandler handler, + List groupShippingMethods, string checkoutId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.SetShippingMethodsClient( + groupShippingMethods : groupShippingMethods, checkoutId : checkoutId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.UpdateCheckout(handler : handler, checkout : checkout, checkoutId : checkoutId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout UpdateCheckout(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout checkout, string checkoutId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.UpdateCheckoutClient( + checkout : checkout, checkoutId : checkoutId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.ProcessDigitalWallet(handler : handler, digitalWallet : digitalWallet, checkoutId : checkoutId, digitalWalletType : digitalWalletType, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout ProcessDigitalWallet(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Orders.DigitalWallet digitalWallet, string checkoutId, string digitalWalletType, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.ProcessDigitalWalletClient( + digitalWallet : digitalWallet, checkoutId : checkoutId, digitalWalletType : digitalWalletType, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = CheckoutFactory.ChangeCheckoutPriceList(handler : handler, priceListCode : priceListCode, checkoutId : checkoutId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout ChangeCheckoutPriceList(ServiceClientMessageHandler handler, + string priceListCode, string checkoutId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.CheckoutClient.ChangeCheckoutPriceListClient( + priceListCode : priceListCode, checkoutId : checkoutId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + + } + +} + + diff --git a/Mozu.Api.Test/Factories/CustomerAttributeDefinitionFactory.cs b/Mozu.Api.Test/Factories/Commerce/Checkouts/AppliedDiscountOrdersFactory.cs old mode 100644 new mode 100755 similarity index 56% rename from Mozu.Api.Test/Factories/CustomerAttributeDefinitionFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Checkouts/AppliedDiscountOrdersFactory.cs index efa657d8..5af40d61 --- a/Mozu.Api.Test/Factories/CustomerAttributeDefinitionFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Checkouts/AppliedDiscountOrdersFactory.cs @@ -18,40 +18,41 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Checkouts { /// - /// Use the Customer Attribute Definition resource to manage the attributes to define for your shoppers. + /// /// - public partial class CustomerAttributeDefinitionFactory : BaseDataFactory + public partial class AppliedDiscountOrdersFactory : BaseDataFactory { /// - /// Retrieves a list of customer attributes according to any filter and sort criteria specified in the request. + /// /// /// - /// var result = CustomerAttributeDefinitionFactory.GetAttributes(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = AppliedDiscountFactory.ApplyCoupon(handler : handler, checkoutId : checkoutId, couponCode : couponCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttributes(ServiceClientMessageHandler handler, - int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout ApplyCoupon(ServiceClientMessageHandler handler, + string checkoutId, string couponCode, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributesClient( - startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.AppliedDiscountClient.ApplyCouponClient( + checkoutId : checkoutId, couponCode : couponCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,28 +69,28 @@ public static Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttribut } /// - /// Retrieve a list of the vocabulary values defined for the customer attribute specified in the request. + /// /// /// - /// var result = CustomerAttributeDefinitionFactory.GetAttributeVocabularyValues(handler : handler, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass/>(result); + /// var result = AppliedDiscountFactory.RemoveCoupons(handler : handler, checkoutId : checkoutId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static List GetAttributeVocabularyValues(ServiceClientMessageHandler handler, - string attributeFQN, + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout RemoveCoupons(ServiceClientMessageHandler handler, + string checkoutId, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributeVocabularyValuesClient( - attributeFQN : attributeFQN ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.AppliedDiscountClient.RemoveCouponsClient( + checkoutId : checkoutId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,28 +107,28 @@ public static Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttribut } /// - /// Retrieve a customer attribute definition by supplying its fully qualified name. + /// /// /// - /// var result = CustomerAttributeDefinitionFactory.GetAttribute(handler : handler, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = AppliedDiscountFactory.RemoveCoupon(handler : handler, checkoutId : checkoutId, couponCode : couponCode, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.Core.Extensible.Attribute GetAttribute(ServiceClientMessageHandler handler, - string attributeFQN, string responseFields = null, + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout RemoveCoupon(ServiceClientMessageHandler handler, + string checkoutId, string couponCode, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributeClient( - attributeFQN : attributeFQN, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.AppliedDiscountClient.RemoveCouponClient( + checkoutId : checkoutId, couponCode : couponCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/Commerce/Checkouts/DestinationFactory.cs b/Mozu.Api.Test/Factories/Commerce/Checkouts/DestinationFactory.cs new file mode 100755 index 00000000..b2bcb8b4 --- /dev/null +++ b/Mozu.Api.Test/Factories/Commerce/Checkouts/DestinationFactory.cs @@ -0,0 +1,227 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#region Usings Setup + +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Net; +using Mozu.Api; +using Mozu.Api.Security; +using Mozu.Api.Test.Helpers; +using System.Diagnostics; +using Newtonsoft.Json.Linq; +using System.Threading; + +#endregion + +namespace Mozu.Api.Test.Factories.Commerce.Checkouts +{ + /// + /// + /// + public partial class DestinationFactory : BaseDataFactory + { + + /// + /// + /// + /// + /// var result = DestinationFactory.GetDestinations(handler : handler, checkoutId : checkoutId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); + /// return optionalCasting; + /// + /// + /// + public static List GetDestinations(ServiceClientMessageHandler handler, + string checkoutId, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.GetDestinationsClient( + checkoutId : checkoutId ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = DestinationFactory.GetDestination(handler : handler, checkoutId : checkoutId, destinationId : destinationId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Destination GetDestination(ServiceClientMessageHandler handler, + string checkoutId, string destinationId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.GetDestinationClient( + checkoutId : checkoutId, destinationId : destinationId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = DestinationFactory.AddDestination(handler : handler, destination : destination, checkoutId : checkoutId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Destination AddDestination(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Destination destination, string checkoutId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.AddDestinationClient( + destination : destination, checkoutId : checkoutId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = DestinationFactory.UpdateDestination(handler : handler, destination : destination, checkoutId : checkoutId, destinationId : destinationId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Destination UpdateDestination(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Destination destination, string checkoutId, string destinationId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.UpdateDestinationClient( + destination : destination, checkoutId : checkoutId, destinationId : destinationId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = DestinationFactory.RemoveDestination(handler : handler, checkoutId : checkoutId, destinationId : destinationId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static void RemoveDestination(ServiceClientMessageHandler handler, + string checkoutId, string destinationId, + HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.RemoveDestinationClient( + checkoutId : checkoutId, destinationId : destinationId ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + } + var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + + } + +} + + diff --git a/Mozu.Api.Test/Factories/PublicCardsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Checkouts/OrderAttributeFactory.cs old mode 100644 new mode 100755 similarity index 55% rename from Mozu.Api.Test/Factories/PublicCardsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Checkouts/OrderAttributeFactory.cs index c44e9424..b9b24b88 --- a/Mozu.Api.Test/Factories/PublicCardsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Checkouts/OrderAttributeFactory.cs @@ -18,40 +18,41 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Checkouts { /// - /// commerce/payments/cards related resources. DOCUMENT_HERE + /// /// - public partial class PublicCardsFactory : BaseDataFactory + public partial class OrderAttributeFactory : BaseDataFactory { /// - /// payments-cards Post Create description DOCUMENT_HERE + /// /// /// - /// var result = PublicCardsFactory.Create(handler : handler, request : request, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderAttributeFactory.GetCheckoutAttributes(handler : handler, checkoutId : checkoutId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.PaymentService.Response.SyncResponse Create(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.PaymentService.PublicCard request, - HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + public static List GetCheckoutAttributes(ServiceClientMessageHandler handler, + string checkoutId, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Payments.PublicCardsClient.CreateClient( - request : request ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.OrderAttributeClient.GetCheckoutAttributesClient( + checkoutId : checkoutId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,28 +69,28 @@ public static Mozu.Api.Contracts.PaymentService.Response.SyncResponse Create(Ser } /// - /// payments-cards Put Update description DOCUMENT_HERE + /// /// /// - /// var result = PublicCardsFactory.Update(handler : handler, request : request, cardId : cardId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderAttributeFactory.CreateCheckoutAttributes(handler : handler, checkoutAttributes : checkoutAttributes, checkoutId : checkoutId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.PaymentService.Response.SyncResponse Update(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.PaymentService.PublicCard request, string cardId, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + public static List CreateCheckoutAttributes(ServiceClientMessageHandler handler, + List checkoutAttributes, string checkoutId, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Payments.PublicCardsClient.UpdateClient( - request : request, cardId : cardId ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.OrderAttributeClient.CreateCheckoutAttributesClient( + checkoutAttributes : checkoutAttributes, checkoutId : checkoutId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,28 +107,28 @@ public static Mozu.Api.Contracts.PaymentService.Response.SyncResponse Update(Ser } /// - /// payments-cards Delete Delete description DOCUMENT_HERE + /// /// /// - /// var result = PublicCardsFactory.Delete(handler : handler, cardId : cardId, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderAttributeFactory.UpdateCheckoutAttribute(handler : handler, checkoutAttributes : checkoutAttributes, checkoutId : checkoutId, removeMissing : removeMissing, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); /// return optionalCasting; /// /// /// - public static void Delete(ServiceClientMessageHandler handler, - string cardId, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) + public static List UpdateCheckoutAttribute(ServiceClientMessageHandler handler, + List checkoutAttributes, string checkoutId, bool? removeMissing = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Payments.PublicCardsClient.DeleteClient( - cardId : cardId ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.OrderAttributeClient.UpdateCheckoutAttributeClient( + checkoutAttributes : checkoutAttributes, checkoutId : checkoutId, removeMissing : removeMissing ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -135,8 +136,9 @@ public static void Delete(ServiceClientMessageHandler handler, Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); if (customException != null) throw customException; + return null; } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) ? (apiClient.Result()) : null; diff --git a/Mozu.Api.Test/Factories/StorefrontProductCategoryRuntimeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Checkouts/OrderItemFactory.cs old mode 100644 new mode 100755 similarity index 56% rename from Mozu.Api.Test/Factories/StorefrontProductCategoryRuntimeFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Checkouts/OrderItemFactory.cs index 5fb5c2a8..8a69c527 --- a/Mozu.Api.Test/Factories/StorefrontProductCategoryRuntimeFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Checkouts/OrderItemFactory.cs @@ -18,40 +18,41 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Checkouts { /// - /// Use the Storefront Categories resource to view the product category hierarchy as it appears to shoppers who are browsing the storefront. The hierarchy can be returned as a flat list or as a category tree. + /// /// - public partial class StorefrontProductCategoryRuntimeFactory : BaseDataFactory + public partial class OrderItemFactory : BaseDataFactory { /// - /// Retrieves a list of categories according to any specified filter criteria and sort options. + /// /// /// - /// var result = ProductCategoryRuntimeFactory.GetCategories(handler : handler, filter : filter, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderItemFactory.SplitItem(handler : handler, checkoutId : checkoutId, itemId : itemId, quantity : quantity, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.ProductRuntime.CategoryPagedCollection GetCategories(ServiceClientMessageHandler handler, - string filter = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null, + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout SplitItem(ServiceClientMessageHandler handler, + string checkoutId, string itemId, int? quantity = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.CategoryClient.GetCategoriesClient( - filter : filter, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.OrderItemClient.SplitItemClient( + checkoutId : checkoutId, itemId : itemId, quantity : quantity, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,28 +69,28 @@ public static Mozu.Api.Contracts.ProductRuntime.CategoryPagedCollection GetCateg } /// - /// Retrieves the details of a single category. + /// /// /// - /// var result = ProductCategoryRuntimeFactory.GetCategory(handler : handler, categoryId : categoryId, allowInactive : allowInactive, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderItemFactory.BulkUpdateItemDestinations(handler : handler, itemsForDestination : itemsForDestination, checkoutId : checkoutId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.ProductRuntime.Category GetCategory(ServiceClientMessageHandler handler, - int categoryId, bool? allowInactive = null, string responseFields = null, + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout BulkUpdateItemDestinations(ServiceClientMessageHandler handler, + List itemsForDestination, string checkoutId, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.CategoryClient.GetCategoryClient( - categoryId : categoryId, allowInactive : allowInactive, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.OrderItemClient.BulkUpdateItemDestinationsClient( + itemsForDestination : itemsForDestination, checkoutId : checkoutId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,28 +107,28 @@ public static Mozu.Api.Contracts.ProductRuntime.Category GetCategory(ServiceClie } /// - /// Retrieves the list of product categories that appear on the storefront organized in a hierarchical format. Hidden categories do not appear in the list. + /// /// /// - /// var result = ProductCategoryRuntimeFactory.GetCategoryTree(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderItemFactory.UpdateItemDestination(handler : handler, checkoutId : checkoutId, itemId : itemId, destinationId : destinationId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.ProductRuntime.CategoryCollection GetCategoryTree(ServiceClientMessageHandler handler, - string responseFields = null, + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout UpdateItemDestination(ServiceClientMessageHandler handler, + string checkoutId, string itemId, string destinationId, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.CategoryClient.GetCategoryTreeClient( - responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.OrderItemClient.UpdateItemDestinationClient( + checkoutId : checkoutId, itemId : itemId, destinationId : destinationId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/GeneralSettingFactory.cs b/Mozu.Api.Test/Factories/Commerce/Checkouts/PaymentFactory.cs old mode 100644 new mode 100755 similarity index 58% rename from Mozu.Api.Test/Factories/GeneralSettingFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Checkouts/PaymentFactory.cs index d4616929..e7f46cf7 --- a/Mozu.Api.Test/Factories/GeneralSettingFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Checkouts/PaymentFactory.cs @@ -18,40 +18,41 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Checkouts { /// - /// Define global site settings such as the site name, shipping and email addresses, and logo images. Block undesirable IP addresses using this resource. + /// /// - public partial class GeneralSettingFactory : BaseDataFactory + public partial class PaymentFactory : BaseDataFactory { /// - /// Retrieve a site's general global settings. + /// /// /// - /// var result = GeneralSettingFactory.GetGeneralSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = PaymentFactory.PerformPaymentAction(handler : handler, action : action, checkoutId : checkoutId, paymentId : paymentId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.SiteSettings.General.GeneralSettings GetGeneralSettings(ServiceClientMessageHandler handler, - string responseFields = null, + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout PerformPaymentAction(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string checkoutId, string paymentId, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.GeneralSettingsClient.GetGeneralSettingsClient( - responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.PaymentClient.PerformPaymentActionClient( + action : action, checkoutId : checkoutId, paymentId : paymentId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,28 +69,28 @@ public static Mozu.Api.Contracts.SiteSettings.General.GeneralSettings GetGeneral } /// - /// Updates a site's general global settings. + /// /// /// - /// var result = GeneralSettingFactory.UpdateGeneralSettings(handler : handler, generalSettings : generalSettings, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = PaymentFactory.CreatePaymentAction(handler : handler, action : action, checkoutId : checkoutId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.SiteSettings.General.GeneralSettings UpdateGeneralSettings(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.SiteSettings.General.GeneralSettings generalSettings, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + public static Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout CreatePaymentAction(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string checkoutId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.GeneralSettingsClient.UpdateGeneralSettingsClient( - generalSettings : generalSettings, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Checkouts.PaymentClient.CreatePaymentActionClient( + action : action, checkoutId : checkoutId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CardFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CardFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/CardFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CardFactory.cs index 9eaf054e..6768169e --- a/Mozu.Api.Test/Factories/CardFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CardFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Accounts { /// - /// Use the Cards subresource to manage stored credit cards for customer accounts. stores limited card data in the Customer service for expedited ordering purposes; however, the complete card data is stored in the Payment service. + /// Use the Cards subresource to manage stored credit cards for customer accounts. Mozu stores limited card data in the Customer service for expedited ordering purposes; however, the complete card data is stored in the Payment service. /// public partial class CardFactory : BaseDataFactory { /// - /// Retrieves the details of a credit card stored with a customer account billing contact. + /// /// /// /// var result = CardFactory.GetAccountCard(handler : handler, accountId : accountId, cardId : cardId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.Card GetAccountCard(ServiceClientMessa accountId : accountId, cardId : cardId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.Card GetAccountCard(ServiceClientMessa } /// - /// Retrieves all stored credit cards for the customer account. + /// /// /// /// var result = CardFactory.GetAccountCards(handler : handler, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.CardCollection GetAccountCards(Service accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.CardCollection GetAccountCards(Service } /// - /// Creates a new credit card record and stores it for the customer account. + /// /// /// /// var result = CardFactory.AddAccountCard(handler : handler, card : card, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.Card AddAccountCard(ServiceClientMessa card : card, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.Card AddAccountCard(ServiceClientMessa } /// - /// Update one or more properties of a credit card defined for a customer account. + /// /// /// /// var result = CardFactory.UpdateAccountCard(handler : handler, card : card, accountId : accountId, cardId : cardId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Customer.Card UpdateAccountCard(ServiceClientMe card : card, accountId : accountId, cardId : cardId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Customer.Card UpdateAccountCard(ServiceClientMe } /// - /// Removes a stored credit card from a customer account. + /// /// /// /// var result = CardFactory.DeleteAccountCard(handler : handler, accountId : accountId, cardId : cardId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteAccountCard(ServiceClientMessageHandler handler, accountId : accountId, cardId : cardId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerAttributeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerAttributeFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/CustomerAttributeFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerAttributeFactory.cs index 1ae0573c..707fbcd7 --- a/Mozu.Api.Test/Factories/CustomerAttributeFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerAttributeFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Accounts { /// /// Use the Attributes subresource to manage the attributes used to uniquely identify shopper accounts, such as gender or age. @@ -30,7 +31,7 @@ public partial class CustomerAttributeFactory : BaseDataFactory { /// - /// Retrieves the contents of an attribute associated with the specified customer account. + /// /// /// /// var result = CustomerAttributeFactory.GetAccountAttribute(handler : handler, accountId : accountId, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAttribute GetAccountAttribute( accountId : accountId, attributeFQN : attributeFQN, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAttribute GetAccountAttribute( } /// - /// Retrieves the list of customer account attributes. + /// /// /// /// var result = CustomerAttributeFactory.GetAccountAttributes(handler : handler, accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAttributeCollection GetAccount accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAttributeCollection GetAccount } /// - /// Applies a defined attribute to the customer account specified in the request and assigns a value to the customer attribute. + /// /// /// /// var result = CustomerAttributeFactory.AddAccountAttribute(handler : handler, attribute : attribute, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAttribute AddAccountAttribute( attribute : attribute, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAttribute AddAccountAttribute( } /// - /// Updates one or more details of a customer account attribute. + /// /// /// /// var result = CustomerAttributeFactory.UpdateAccountAttribute(handler : handler, attribute : attribute, accountId : accountId, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAttribute UpdateAccountAttribu attribute : attribute, accountId : accountId, attributeFQN : attributeFQN, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAttribute UpdateAccountAttribu } /// - /// Removes the attribute specified in the request from the customer account. + /// /// /// /// var result = CustomerAttributeFactory.DeleteAccountAttribute(handler : handler, accountId : accountId, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteAccountAttribute(ServiceClientMessageHandler handler, accountId : accountId, attributeFQN : attributeFQN ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerAuditEntryFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerAuditEntryFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/CustomerAuditEntryFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerAuditEntryFactory.cs index 7985cc9d..bb1c2b8c --- a/Mozu.Api.Test/Factories/CustomerAuditEntryFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerAuditEntryFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Accounts { /// - /// Use the Audit Log resource to retrieve audit logs for customer accounts. + /// /// public partial class CustomerAuditEntryFactory : BaseDataFactory { /// - /// Retrieves audit log entries for the specified customer account. + /// /// /// /// var result = CustomerAuditEntryFactory.GetAccountAuditLog(handler : handler, accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuditEntryCollection GetAccoun accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerContactFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerContactFactory.cs old mode 100644 new mode 100755 similarity index 79% rename from Mozu.Api.Test/Factories/CustomerContactFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerContactFactory.cs index 0afaeeae..a7cd18f5 --- a/Mozu.Api.Test/Factories/CustomerContactFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerContactFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Accounts { /// /// Merchants and customers can create, view, update, and delete a contact for a customer account. A customer account may have multiple contacts for billing and shipping addresses. @@ -30,7 +31,7 @@ public partial class CustomerContactFactory : BaseDataFactory { /// - /// Retrieves the specified contact for a customer account such as a billing or shipping contact. + /// /// /// /// var result = CustomerContactFactory.GetAccountContact(handler : handler, accountId : accountId, contactId : contactId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerContact GetAccountContact(Serv accountId : accountId, contactId : contactId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.CustomerContact GetAccountContact(Serv } /// - /// Retrieves a list of contacts for a customer according to any specified filter criteria and sort options. + /// /// /// /// var result = CustomerContactFactory.GetAccountContacts(handler : handler, accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.CustomerContactCollection GetAccountCo accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.CustomerContactCollection GetAccountCo } /// - /// Creates a new contact for a customer account such as a new shipping address. + /// /// /// /// var result = CustomerContactFactory.AddAccountContact(handler : handler, contact : contact, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.CustomerContact AddAccountContact(Serv contact : contact, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.CustomerContact AddAccountContact(Serv } /// - /// Updates a contact for a specified customer account such as to update addresses or change which contact is the primary contact for billing. + /// /// /// /// var result = CustomerContactFactory.UpdateAccountContact(handler : handler, contact : contact, accountId : accountId, contactId : contactId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Customer.CustomerContact UpdateAccountContact(S contact : contact, accountId : accountId, contactId : contactId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,45 @@ public static Mozu.Api.Contracts.Customer.CustomerContact UpdateAccountContact(S } /// - /// Deletes a contact for the specified customer account. + /// + /// + /// + /// var result = CustomerContactFactory.AddAccountContactList(handler : handler, contactList : contactList, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Customer.CustomerContactCollection AddAccountContactList(ServiceClientMessageHandler handler, + List contactList, int accountId, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.AddAccountContactListClient( + contactList : contactList, accountId : accountId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// /// /// /// var result = CustomerContactFactory.DeleteAccountContact(handler : handler, accountId : accountId, contactId : contactId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +242,7 @@ public static void DeleteAccountContact(ServiceClientMessageHandler handler, accountId : accountId, contactId : contactId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerNoteFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerNoteFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/CustomerNoteFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerNoteFactory.cs index f3c712b9..57f7db54 --- a/Mozu.Api.Test/Factories/CustomerNoteFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerNoteFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Accounts { /// - /// This resources manages notes for a customer account. For example, a client can track a shopper's interests or complaints. Only clients can add and view notes. Shoppers cannot view these notes from the My Account page. + /// Tenant administrators can add and view internal notes for a customer account. For example, a client can track a shopper's interests or complaints. Only clients can add and view notes. Shoppers cannot view these notes from the My Account page. /// public partial class CustomerNoteFactory : BaseDataFactory { /// - /// Retrieves the contents of a particular note attached to a specified customer account. + /// /// /// /// var result = CustomerNoteFactory.GetAccountNote(handler : handler, accountId : accountId, noteId : noteId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerNote GetAccountNote(ServiceCli accountId : accountId, noteId : noteId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.CustomerNote GetAccountNote(ServiceCli } /// - /// Retrieves a list of notes added to a customer account according to any specified filter criteria and sort options. + /// /// /// /// var result = CustomerNoteFactory.GetAccountNotes(handler : handler, accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.CustomerNoteCollection GetAccountNotes accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.CustomerNoteCollection GetAccountNotes } /// - /// Adds a new note to the specified customer account. + /// /// /// /// var result = CustomerNoteFactory.AddAccountNote(handler : handler, note : note, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.CustomerNote AddAccountNote(ServiceCli note : note, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.CustomerNote AddAccountNote(ServiceCli } /// - /// Modifies an existing note for a customer account. + /// /// /// /// var result = CustomerNoteFactory.UpdateAccountNote(handler : handler, note : note, accountId : accountId, noteId : noteId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Customer.CustomerNote UpdateAccountNote(Service note : note, accountId : accountId, noteId : noteId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Customer.CustomerNote UpdateAccountNote(Service } /// - /// Removes a note from the specified customer account. + /// /// /// /// var result = CustomerNoteFactory.DeleteAccountNote(handler : handler, accountId : accountId, noteId : noteId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteAccountNote(ServiceClientMessageHandler handler, accountId : accountId, noteId : noteId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerPurchaseOrderAccountFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/CustomerPurchaseOrderAccountFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountFactory.cs index da904808..1c81e510 --- a/Mozu.Api.Test/Factories/CustomerPurchaseOrderAccountFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Accounts { /// - /// Use the Customer Account Purchase Order resource to manage purchase order details for specific customer acocunts. + /// /// public partial class CustomerPurchaseOrderAccountFactory : BaseDataFactory { /// - /// Retrieves the details of the specified customer purchase order account. + /// /// /// /// var result = CustomerPurchaseOrderAccountFactory.GetCustomerPurchaseOrderAccount(handler : handler, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount GetCustom accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount GetCustom } /// - /// Retrieves a list of purchase order transactions for the specified customer account according to any specified sort options. + /// /// /// /// var result = CustomerPurchaseOrderAccountFactory.GetCustomerPurchaseOrderTransactions(handler : handler, accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.PurchaseOrderTransactionCollection Get accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.PurchaseOrderTransactionCollection Get } /// - /// Adds a purchase order account to the specified customer account.This adds the ability for the specified customer account to use the purchase order payment method. + /// /// /// /// var result = CustomerPurchaseOrderAccountFactory.CreateCustomerPurchaseOrderAccount(handler : handler, customerPurchaseOrderAccount : customerPurchaseOrderAccount, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount CreateCus customerPurchaseOrderAccount : customerPurchaseOrderAccount, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount CreateCus } /// - /// Creates a purchase order transaction on the specified customer purchase order account. + /// /// /// /// var result = CustomerPurchaseOrderAccountFactory.CreatePurchaseOrderTransaction(handler : handler, purchaseOrderTransaction : purchaseOrderTransaction, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Customer.PurchaseOrderTransaction CreatePurchas purchaseOrderTransaction : purchaseOrderTransaction, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Customer.PurchaseOrderTransaction CreatePurchas } /// - /// Updates the details of the purchase order account for the specified customer account. + /// /// /// /// var result = CustomerPurchaseOrderAccountFactory.UpdateCustomerPurchaseOrderAccount(handler : handler, customerPurchaseOrderAccount : customerPurchaseOrderAccount, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount UpdateCus customerPurchaseOrderAccount : customerPurchaseOrderAccount, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount UpdateCus } /// - /// Deletes the specified customer purchase order account.This removes the ability for the specified customer account to use the purchase order payment method. + /// /// /// /// var result = CustomerPurchaseOrderAccountFactory.DeleteCustomerPurchaseOrderAccount(handler : handler, accountId : accountId, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static void DeleteCustomerPurchaseOrderAccount(ServiceClientMessageHandle accountId : accountId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerSegmentAccountsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerSegmentAccountsFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/CustomerSegmentAccountsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerSegmentAccountsFactory.cs index f5677a0b..92d53afd --- a/Mozu.Api.Test/Factories/CustomerSegmentAccountsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/CustomerSegmentAccountsFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Accounts { /// /// Use the Customer Account Segments subresource to view the customer segments associated with a customer account. @@ -30,7 +31,7 @@ public partial class CustomerSegmentAccountsFactory : BaseDataFactory { /// - /// Retrieves the list of segments associated with a customer account. + /// /// /// /// var result = CustomerSegmentFactory.GetAccountSegments(handler : handler, accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSegmentCollection GetAccountSe accountId : accountId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/TransactionFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/TransactionFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/TransactionFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Accounts/TransactionFactory.cs index 0ee9933e..dfb8e8e1 --- a/Mozu.Api.Test/Factories/TransactionFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Accounts/TransactionFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Accounts { /// /// Use the Customer Account Transactions resource to manage the transactions associated with a customer account. @@ -30,7 +31,7 @@ public partial class TransactionFactory : BaseDataFactory { /// - /// Retrieves a list of transactions associated with the customer account specified in the request. + /// /// /// /// var result = TransactionFactory.GetTransactions(handler : handler, accountId : accountId, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class TransactionFactory : BaseDataFactory accountId : accountId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class TransactionFactory : BaseDataFactory } /// - /// Creates a new transaction for the customer account specified in the request. + /// /// /// /// var result = TransactionFactory.AddTransaction(handler : handler, transaction : transaction, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.Transaction AddTransaction(ServiceClie transaction : transaction, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.Transaction AddTransaction(ServiceClie } /// - /// Deletes a transaction from the customer account specified in the request. + /// /// /// /// var result = TransactionFactory.RemoveTransaction(handler : handler, accountId : accountId, transactionId : transactionId, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static void RemoveTransaction(ServiceClientMessageHandler handler, accountId : accountId, transactionId : transactionId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AddressValidationRequestFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/AddressValidationRequestFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/AddressValidationRequestFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/AddressValidationRequestFactory.cs index 65ed9db8..8cda1366 --- a/Mozu.Api.Test/Factories/AddressValidationRequestFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/AddressValidationRequestFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer { /// /// Use the Address Validation resource to validate addresses associated with a customer account contact. @@ -30,7 +31,7 @@ public partial class AddressValidationRequestFactory : BaseDataFactory { /// - /// Validates the customer address supplied in the request. + /// /// /// /// var result = AddressValidationRequestFactory.ValidateAddress(handler : handler, addressValidationRequest : addressValidationRequest, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.AddressValidationResponse ValidateAddr addressValidationRequest : addressValidationRequest, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/Commerce/Customer/Attributedefinition/AttributeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Attributedefinition/AttributeFactory.cs new file mode 100755 index 00000000..14d256ae --- /dev/null +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Attributedefinition/AttributeFactory.cs @@ -0,0 +1,228 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#region Usings Setup + +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Net; +using Mozu.Api; +using Mozu.Api.Security; +using Mozu.Api.Test.Helpers; +using System.Diagnostics; +using Newtonsoft.Json.Linq; +using System.Threading; + +#endregion + +namespace Mozu.Api.Test.Factories.Commerce.Customer.Attributedefinition +{ + /// + /// Use the Customer Attribute Definition resource to manage the attributes to define for your shoppers. + /// + public partial class AttributeFactory : BaseDataFactory + { + + /// + /// + /// + /// + /// var result = AttributeFactory.GetAttributes(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttributes(ServiceClientMessageHandler handler, + int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributesClient( + startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.GetAttributeVocabularyValues(handler : handler, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); + /// return optionalCasting; + /// + /// + /// + public static List GetAttributeVocabularyValues(ServiceClientMessageHandler handler, + string attributeFQN, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributeVocabularyValuesClient( + attributeFQN : attributeFQN ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.GetAttribute(handler : handler, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.Attribute GetAttribute(ServiceClientMessageHandler handler, + string attributeFQN, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributeClient( + attributeFQN : attributeFQN, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.CreateAttribute(handler : handler, attribute : attribute, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.Attribute CreateAttribute(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.CreateAttributeClient( + attribute : attribute, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.UpdateAttribute(handler : handler, attribute : attribute, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.Attribute UpdateAttribute(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.UpdateAttributeClient( + attribute : attribute, attributeFQN : attributeFQN, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + + } + +} + + diff --git a/Mozu.Api.Test/Factories/CreditFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/CreditFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/CreditFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/CreditFactory.cs index 3ac4bb97..04db5198 --- a/Mozu.Api.Test/Factories/CreditFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/CreditFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer { /// /// Use the Customer Credits resource to manage the store credit associated with a customer account. Store credit can represent a static amount the customer can redeem at any of the tenant's sites, or a gift card registered for a customer account. At this time, gift card functionality is reserved for future use. @@ -30,7 +31,7 @@ public partial class CreditFactory : BaseDataFactory { /// - /// Retrieves a list of store credits applied to customer accounts, according any filter and sort criteria specified in the request. + /// /// /// /// var result = CreditFactory.GetCredits(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.Credit.CreditCollection GetCredits(Ser startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.Credit.CreditCollection GetCredits(Ser } /// - /// Retrieves the details of a store credit applied to a customer account. + /// /// /// /// var result = CreditFactory.GetCredit(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.Credit.Credit GetCredit(ServiceClientM code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.Credit.Credit GetCredit(ServiceClientM } /// - /// Creates a new store credit for the customer account specified in the request. + /// /// /// /// var result = CreditFactory.AddCredit(handler : handler, credit : credit, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.Credit.Credit AddCredit(ServiceClientM credit : credit, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.Credit.Credit AddCredit(ServiceClientM } /// - /// Associates an unclaimed customer credit with the shopper user authenticated in the request header. + /// /// /// /// var result = CreditFactory.AssociateCreditToShopper(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Customer.Credit.Credit AssociateCreditToShopper code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Customer.Credit.Credit AssociateCreditToShopper } /// - /// Resend the notification email that informs a shopper that a credit has been created. + /// /// /// /// var result = CreditFactory.ResendCreditCreatedEmail(handler : handler, code : code, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void ResendCreditCreatedEmail(ServiceClientMessageHandler handler, code : code ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -219,7 +220,7 @@ public static void ResendCreditCreatedEmail(ServiceClientMessageHandler handler, } /// - /// Updates one or more properties of a defined store credit applied to a customer account. + /// /// /// /// var result = CreditFactory.UpdateCredit(handler : handler, credit : credit, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -240,7 +241,7 @@ public static Mozu.Api.Contracts.Customer.Credit.Credit UpdateCredit(ServiceClie credit : credit, code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -257,7 +258,7 @@ public static Mozu.Api.Contracts.Customer.Credit.Credit UpdateCredit(ServiceClie } /// - /// Deletes a store credit previously applied to a customer account. + /// /// /// /// var result = CreditFactory.DeleteCredit(handler : handler, code : code, expectedCode: expectedCode, successCode: successCode); @@ -278,7 +279,7 @@ public static void DeleteCredit(ServiceClientMessageHandler handler, code : code ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CreditAuditEntryFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Credits/CreditAuditEntryFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/CreditAuditEntryFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Credits/CreditAuditEntryFactory.cs index 3775b41a..3a4c212c --- a/Mozu.Api.Test/Factories/CreditAuditEntryFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Credits/CreditAuditEntryFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Credits { /// /// Use the Customer Credit Audit Entries subresource to retrieve entries logged in the audit report of a store credit or gift card applied to a customer account. The system creates a new audit entry when the credit is created, deleted, activated, or deactivated. The system then creates a new audit entry each time the credit is updated or redeemed in a transaction. @@ -30,7 +31,7 @@ public partial class CreditAuditEntryFactory : BaseDataFactory { /// - /// Retrieves the list of audit entries for the credit, according to any filter or sort criteria specified in the request. + /// /// /// /// var result = CreditAuditEntryFactory.GetAuditEntries(handler : handler, code : code, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.Credit.CreditAuditEntryCollection GetA code : code, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CreditTransactionFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/Credits/CreditTransactionFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/CreditTransactionFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/Credits/CreditTransactionFactory.cs index 272fa854..d19fbba9 --- a/Mozu.Api.Test/Factories/CreditTransactionFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/Credits/CreditTransactionFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer.Credits { /// /// Use the Customer Credit Transactions subresource to manage the individual transactions performed using a store credit or gift card. @@ -30,7 +31,7 @@ public partial class CreditTransactionFactory : BaseDataFactory { /// - /// Retrieves a list of the transactions performed using a customer credit that update the balance of the credit. + /// /// /// /// var result = CreditTransactionFactory.GetTransactions(handler : handler, code : code, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.Credit.CreditTransactionCollection Get code : code, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.Credit.CreditTransactionCollection Get } /// - /// Creates a new transaction and updates the amount of a store credit or gift card. + /// /// /// /// var result = CreditTransactionFactory.AddTransaction(handler : handler, creditTransaction : creditTransaction, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.Credit.CreditTransaction AddTransactio creditTransaction : creditTransaction, code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerAccountFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/CustomerAccountFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/CustomerAccountFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/CustomerAccountFactory.cs index e4c85c8f..1ace6e09 --- a/Mozu.Api.Test/Factories/CustomerAccountFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/CustomerAccountFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer { /// /// Use the Customer Accounts resource to manage the components of shopper accounts, including attributes, contact information, company notes, and groups associated with the customer account. @@ -30,7 +31,7 @@ public partial class CustomerAccountFactory : BaseDataFactory { /// - /// Retrieves a list of customer accounts. + /// /// /// /// var result = CustomerAccountFactory.GetAccounts(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, fields : fields, q : q, qLimit : qLimit, isAnonymous : isAnonymous, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccountCollection GetAccounts( startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, fields : fields, q : q, qLimit : qLimit, isAnonymous : isAnonymous, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccountCollection GetAccounts( } /// - /// Retrieves the current login state of the customer account specified in the request. + /// /// /// /// var result = CustomerAccountFactory.GetLoginState(handler : handler, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.LoginState GetLoginState(ServiceClient accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.LoginState GetLoginState(ServiceClient } /// - /// Retrieve details of a customer account. + /// /// /// /// var result = CustomerAccountFactory.GetAccount(handler : handler, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccount GetAccount(ServiceClie accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccount GetAccount(ServiceClie } /// - /// Creates a new customer account based on the information specified in the request. + /// /// /// /// var result = CustomerAccountFactory.AddAccount(handler : handler, account : account, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccount AddAccount(ServiceClie account : account, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccount AddAccount(ServiceClie } /// - /// Modifies the password associated with a customer account. + /// /// /// /// var result = CustomerAccountFactory.ChangePassword(handler : handler, passwordInfo : passwordInfo, accountId : accountId, unlockAccount : unlockAccount, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void ChangePassword(ServiceClientMessageHandler handler, passwordInfo : passwordInfo, accountId : accountId, unlockAccount : unlockAccount ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -219,7 +220,7 @@ public static void ChangePassword(ServiceClientMessageHandler handler, } /// - /// Adds a new user login to a defined customer account. + /// /// /// /// var result = CustomerAccountFactory.AddLoginToExistingCustomer(handler : handler, customerAuthInfo : customerAuthInfo, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -240,7 +241,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuthTicket AddLoginToExistingC customerAuthInfo : customerAuthInfo, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -257,7 +258,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuthTicket AddLoginToExistingC } /// - /// Updates the customer lifetime value of the specified customer account in the event of an order import or a lifetime value calculation error. + /// /// /// /// var result = CustomerAccountFactory.RecomputeCustomerLifetimeValue(handler : handler, accountId : accountId, expectedCode: expectedCode, successCode: successCode); @@ -278,7 +279,7 @@ public static void RecomputeCustomerLifetimeValue(ServiceClientMessageHandler ha accountId : accountId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -294,7 +295,7 @@ public static void RecomputeCustomerLifetimeValue(ServiceClientMessageHandler ha } /// - /// Lock or unlock a customer account. + /// /// /// /// var result = CustomerAccountFactory.SetLoginLocked(handler : handler, isLocked : isLocked, accountId : accountId, expectedCode: expectedCode, successCode: successCode); @@ -315,7 +316,7 @@ public static void SetLoginLocked(ServiceClientMessageHandler handler, isLocked : isLocked, accountId : accountId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -331,7 +332,7 @@ public static void SetLoginLocked(ServiceClientMessageHandler handler, } /// - /// Requires the password for the customer account to be changed. + /// /// /// /// var result = CustomerAccountFactory.SetPasswordChangeRequired(handler : handler, isPasswordChangeRequired : isPasswordChangeRequired, accountId : accountId, expectedCode: expectedCode, successCode: successCode); @@ -352,7 +353,7 @@ public static void SetPasswordChangeRequired(ServiceClientMessageHandler handler isPasswordChangeRequired : isPasswordChangeRequired, accountId : accountId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -368,7 +369,7 @@ public static void SetPasswordChangeRequired(ServiceClientMessageHandler handler } /// - /// Creates a new customer account and logs the user associated with the customer account into the site. + /// /// /// /// var result = CustomerAccountFactory.AddAccountAndLogin(handler : handler, accountAndAuthInfo : accountAndAuthInfo, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -389,7 +390,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuthTicket AddAccountAndLogin( accountAndAuthInfo : accountAndAuthInfo, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -406,7 +407,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuthTicket AddAccountAndLogin( } /// - /// Creates multiple customer accounts based on the information specified in the request. + /// /// /// /// var result = CustomerAccountFactory.AddAccounts(handler : handler, customers : customers, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -427,7 +428,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccountCollection AddAccounts( customers : customers, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -444,7 +445,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccountCollection AddAccounts( } /// - /// Changes a collection of customer account passwords. + /// /// /// /// var result = CustomerAccountFactory.ChangePasswords(handler : handler, accountPasswordInfos : accountPasswordInfos, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -465,7 +466,7 @@ public static Mozu.Api.Contracts.Customer.ChangePasswordResultCollection ChangeP accountPasswordInfos : accountPasswordInfos, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -482,7 +483,7 @@ public static Mozu.Api.Contracts.Customer.ChangePasswordResultCollection ChangeP } /// - /// Retrieves the current login state of a customer account by providing the customer's email address. + /// /// /// /// var result = CustomerAccountFactory.GetLoginStateByEmailAddress(handler : handler, emailAddress : emailAddress, customerSetCode : customerSetCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -503,7 +504,7 @@ public static Mozu.Api.Contracts.Customer.LoginState GetLoginStateByEmailAddress emailAddress : emailAddress, customerSetCode : customerSetCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -520,7 +521,7 @@ public static Mozu.Api.Contracts.Customer.LoginState GetLoginStateByEmailAddress } /// - /// Retrieves the current login state of a customer account by providing the user name associated with the customer account. + /// /// /// /// var result = CustomerAccountFactory.GetLoginStateByUserName(handler : handler, userName : userName, customerSetCode : customerSetCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -541,7 +542,7 @@ public static Mozu.Api.Contracts.Customer.LoginState GetLoginStateByUserName(Ser userName : userName, customerSetCode : customerSetCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -558,7 +559,7 @@ public static Mozu.Api.Contracts.Customer.LoginState GetLoginStateByUserName(Ser } /// - /// Retrieves a list of customer purchase order accounts according to according to any specified sort options. + /// /// /// /// var result = CustomerAccountFactory.GetCustomersPurchaseOrderAccounts(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -579,7 +580,7 @@ public static Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccountCollection startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -596,7 +597,7 @@ public static Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccountCollection } /// - /// Resets the password for a customer account. + /// /// /// /// var result = CustomerAccountFactory.ResetPassword(handler : handler, resetPasswordInfo : resetPasswordInfo, expectedCode: expectedCode, successCode: successCode); @@ -617,7 +618,7 @@ public static void ResetPassword(ServiceClientMessageHandler handler, resetPasswordInfo : resetPasswordInfo ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -633,7 +634,7 @@ public static void ResetPassword(ServiceClientMessageHandler handler, } /// - /// Updates a customer account. + /// /// /// /// var result = CustomerAccountFactory.UpdateAccount(handler : handler, account : account, accountId : accountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -654,7 +655,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccount UpdateAccount(ServiceC account : account, accountId : accountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -671,7 +672,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAccount UpdateAccount(ServiceC } /// - /// Deletes a customer account. A customer account cannot be deleted if any orders exist, past or present. + /// /// /// /// var result = CustomerAccountFactory.DeleteAccount(handler : handler, accountId : accountId, expectedCode: expectedCode, successCode: successCode); @@ -692,7 +693,7 @@ public static void DeleteAccount(ServiceClientMessageHandler handler, accountId : accountId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerAuthTicketFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/CustomerAuthTicketFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/CustomerAuthTicketFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/CustomerAuthTicketFactory.cs index 75c6a257..09e98ed1 --- a/Mozu.Api.Test/Factories/CustomerAuthTicketFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/CustomerAuthTicketFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer { /// /// Use the Customer Authentication Tickets resource to generate and refresh authentication tickets for customer accounts. @@ -30,7 +31,7 @@ public partial class CustomerAuthTicketFactory : BaseDataFactory { /// - /// Creates an authentication ticket for an anonymous shopper user. + /// /// /// /// var result = CustomerAuthTicketFactory.CreateAnonymousShopperAuthTicket(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuthTicket CreateAnonymousShop responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuthTicket CreateAnonymousShop } /// - /// Generates a new authentication ticket for a customer account. + /// /// /// /// var result = CustomerAuthTicketFactory.CreateUserAuthTicket(handler : handler, userAuthInfo : userAuthInfo, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuthTicket CreateUserAuthTicke userAuthInfo : userAuthInfo, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuthTicket CreateUserAuthTicke } /// - /// Refreshes an existing authentication ticket for a customer account by providing the refresh token string. + /// /// /// /// var result = CustomerAuthTicketFactory.RefreshUserAuthTicket(handler : handler, refreshToken : refreshToken, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.CustomerAuthTicket RefreshUserAuthTick refreshToken : refreshToken, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerSegmentFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/CustomerSegmentFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/CustomerSegmentFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/CustomerSegmentFactory.cs index faa68fb0..12d1454b --- a/Mozu.Api.Test/Factories/CustomerSegmentFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/CustomerSegmentFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer { /// /// Use the Customer Segments resource to manage the segments that enable a client to manage groups of customers and target discounts for these segments. After a customer segment is defined, you can associate any number of customer accounts with it. @@ -30,7 +31,7 @@ public partial class CustomerSegmentFactory : BaseDataFactory { /// - /// Retrieves a list of defined customer segments according to any filter and sort criteria. + /// /// /// /// var result = CustomerSegmentFactory.GetSegments(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSegmentCollection GetSegments( startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSegmentCollection GetSegments( } /// - /// Retrieves the details of the customer segment specified in the request. This operation does not return a list of the customer accounts associated with the segment. + /// /// /// /// var result = CustomerSegmentFactory.GetSegment(handler : handler, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSegment GetSegment(ServiceClie id : id, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSegment GetSegment(ServiceClie } /// - /// Creates a new customer segments. New customer segments do not have any associated customer accounts. + /// /// /// /// var result = CustomerSegmentFactory.AddSegment(handler : handler, segment : segment, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSegment AddSegment(ServiceClie segment : segment, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSegment AddSegment(ServiceClie } /// - /// Adds one or more customer accounts to a defined customer segment. + /// /// /// /// var result = CustomerSegmentFactory.AddSegmentAccounts(handler : handler, accountIds : accountIds, id : id, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static void AddSegmentAccounts(ServiceClientMessageHandler handler, accountIds : accountIds, id : id ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -181,7 +182,7 @@ public static void AddSegmentAccounts(ServiceClientMessageHandler handler, } /// - /// Updates the details of the customer segment specified in the request. + /// /// /// /// var result = CustomerSegmentFactory.UpdateSegment(handler : handler, segment : segment, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -202,7 +203,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSegment UpdateSegment(ServiceC segment : segment, id : id, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -219,7 +220,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSegment UpdateSegment(ServiceC } /// - /// Deletes a customer segment specified by its unique identifier. Deleting a segment removes any customer account associations, but does not delete the customer account itself. + /// /// /// /// var result = CustomerSegmentFactory.DeleteSegment(handler : handler, id : id, expectedCode: expectedCode, successCode: successCode); @@ -240,7 +241,7 @@ public static void DeleteSegment(ServiceClientMessageHandler handler, id : id ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -256,7 +257,7 @@ public static void DeleteSegment(ServiceClientMessageHandler handler, } /// - /// Removes single account from a segment. + /// /// /// /// var result = CustomerSegmentFactory.RemoveSegmentAccount(handler : handler, id : id, accountId : accountId, expectedCode: expectedCode, successCode: successCode); @@ -277,7 +278,7 @@ public static void RemoveSegmentAccount(ServiceClientMessageHandler handler, id : id, accountId : accountId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerSetFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/CustomerSetFactory.cs old mode 100644 new mode 100755 similarity index 85% rename from Mozu.Api.Test/Factories/CustomerSetFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/CustomerSetFactory.cs index 3f67bbf6..06d33761 --- a/Mozu.Api.Test/Factories/CustomerSetFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/CustomerSetFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer { /// - /// Use the Customer Sets resource to manage your customer sets. You can use customer sets to control the specific sites your customers can access using the same login credentials, as well as what customer My Account information is shared between sites.Refer to [Customer Sets](../../../guides/settings/customer-sets.htm) in the Guides section for more information. + /// /// public partial class CustomerSetFactory : BaseDataFactory { /// - /// Retrieves a collection of customer sets according to any specified filter criteria. + /// /// /// /// var result = CustomerSetFactory.GetCustomerSets(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSetCollection GetCustomerSets( startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSetCollection GetCustomerSets( } /// - /// Retrieves the details of the specified customer set. + /// /// /// /// var result = CustomerSetFactory.GetCustomerSet(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.CustomerSet GetCustomerSet(ServiceClie code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/VisitFactory.cs b/Mozu.Api.Test/Factories/Commerce/Customer/VisitFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/VisitFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Customer/VisitFactory.cs index 86ec9187..fabf7916 --- a/Mozu.Api.Test/Factories/VisitFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Customer/VisitFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Customer { /// /// Use the Visits resource to manage all visits a customer makes to a tenant's sites and measure the level of transactions a customer performs during a unique visit for customer account analytics. Clients can track customer visits by site (including online and in-person interactions), the transactions a customer performs during the visit, and the device type associated with the visit, if any. @@ -30,7 +31,7 @@ public partial class VisitFactory : BaseDataFactory { /// - /// Retrieves a list of customer visits according to any filter or sort criteria specified in the request. + /// /// /// /// var result = VisitFactory.GetVisits(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.VisitCollection GetVisits(ServiceClien startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.VisitCollection GetVisits(ServiceClien } /// - /// Retrieves the details of the customer visit specified in the request. + /// /// /// /// var result = VisitFactory.GetVisit(handler : handler, visitId : visitId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.Visit GetVisit(ServiceClientMessageHan visitId : visitId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.Visit GetVisit(ServiceClientMessageHan } /// - /// Creates a new visit for the customer account specified in the request. + /// /// /// /// var result = VisitFactory.AddVisit(handler : handler, visit : visit, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.Visit AddVisit(ServiceClientMessageHan visit : visit, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.Visit AddVisit(ServiceClientMessageHan } /// - /// Updates one or more properties of a defined customer visit. + /// /// /// /// var result = VisitFactory.UpdateVisit(handler : handler, visit : visit, visitId : visitId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Customer.Visit UpdateVisit(ServiceClientMessage visit : visit, visitId : visitId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/InStockNotificationSubscriptionFactory.cs b/Mozu.Api.Test/Factories/Commerce/InStockNotificationSubscriptionFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/InStockNotificationSubscriptionFactory.cs rename to Mozu.Api.Test/Factories/Commerce/InStockNotificationSubscriptionFactory.cs index 8d6adcb5..4be80b43 --- a/Mozu.Api.Test/Factories/InStockNotificationSubscriptionFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/InStockNotificationSubscriptionFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce { /// /// Use the Customer In-Stock Notification Subscription resource to manage the subscriptions customer accounts use to send product notifications. This resource can send a notification when a product in a catalog returns to a site's active inventory after it is out of stock, or when a new product becomes available for the first time. @@ -30,7 +31,7 @@ public partial class InStockNotificationSubscriptionFactory : BaseDataFactory { /// - /// Retrieves a list of in-stock notification subscriptions. + /// /// /// /// var result = InStockNotificationSubscriptionFactory.GetInStockNotificationSubscriptions(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Customer.InStockNotificationSubscriptionCollect startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Customer.InStockNotificationSubscriptionCollect } /// - /// Retrieves the details of a subscription that sends a push notification when a product is available in a site's active stock. + /// /// /// /// var result = InStockNotificationSubscriptionFactory.GetInStockNotificationSubscription(handler : handler, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Customer.InStockNotificationSubscription GetInS id : id, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Customer.InStockNotificationSubscription GetInS } /// - /// Creates a new subscription that notifies the customer when the product specified in the request is available in the active inventory of the defined location. + /// /// /// /// var result = InStockNotificationSubscriptionFactory.AddInStockNotificationSubscription(handler : handler, inStockNotificationSubscription : inStockNotificationSubscription, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Customer.InStockNotificationSubscription AddInS inStockNotificationSubscription : inStockNotificationSubscription, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Customer.InStockNotificationSubscription AddInS } /// - /// Deletes a subscription for a customer in-stock notification. + /// /// /// /// var result = InStockNotificationSubscriptionFactory.DeleteInStockNotificationSubscription(handler : handler, id : id, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static void DeleteInStockNotificationSubscription(ServiceClientMessageHan id : id ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/LocationFactory.cs b/Mozu.Api.Test/Factories/Commerce/LocationFactory.cs old mode 100644 new mode 100755 similarity index 73% rename from Mozu.Api.Test/Factories/LocationFactory.cs rename to Mozu.Api.Test/Factories/Commerce/LocationFactory.cs index 01c2ec82..c7f11739 --- a/Mozu.Api.Test/Factories/LocationFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/LocationFactory.cs @@ -18,29 +18,30 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce { /// - /// Use the Location resource to retrieve details about a location from a hosted storefront. + /// Use the Location resource to retrieve details about a location from a Mozu hosted storefront. /// public partial class LocationFactory : BaseDataFactory { /// - /// Retrieves the details of the location specified in the request. + /// /// /// - /// var result = LocationFactory.GetLocation(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = LocationFactory.GetLocation(handler : handler, locationCode : locationCode, includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.Location.Location GetLocation(ServiceClientMessageHandler handler, - string code, string responseFields = null, + string locationCode, bool? includeAttributeDefinition = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -48,10 +49,10 @@ public static Mozu.Api.Contracts.Location.Location GetLocation(ServiceClientMess var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetLocationClient( - code : code, responseFields : responseFields ); + locationCode : locationCode, includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,17 +69,17 @@ public static Mozu.Api.Contracts.Location.Location GetLocation(ServiceClientMess } /// - /// Retrieves a list of the locations configured for a specified location usage type for the specified site, according to any defined filter or sort criteria. + /// /// /// - /// var result = LocationFactory.GetLocationsInUsageType(handler : handler, locationUsageType : locationUsageType, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = LocationFactory.GetLocationsInUsageType(handler : handler, locationUsageType : locationUsageType, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.Location.LocationCollection GetLocationsInUsageType(ServiceClientMessageHandler handler, - string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeAttributeDefinition = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -86,10 +87,10 @@ public static Mozu.Api.Contracts.Location.LocationCollection GetLocationsInUsage var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetLocationsInUsageTypeClient( - locationUsageType : locationUsageType, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + locationUsageType : locationUsageType, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,17 +107,17 @@ public static Mozu.Api.Contracts.Location.LocationCollection GetLocationsInUsage } /// - /// Retrieves the details of the location configured for the direct shipping (DS) location usage type for the site specified in the request. This location acts as an origin address from which order packages will ship, as well as the location where product reservations are created when order items are submitted with the direct ship fulfillment type (DS). If the direct ship location usage type is not configured for this site, the operation returns an error. + /// /// /// - /// var result = LocationFactory.GetDirectShipLocation(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = LocationFactory.GetDirectShipLocation(handler : handler, includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.Location.Location GetDirectShipLocation(ServiceClientMessageHandler handler, - string responseFields = null, + bool? includeAttributeDefinition = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -124,10 +125,10 @@ public static Mozu.Api.Contracts.Location.Location GetDirectShipLocation(Service var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetDirectShipLocationClient( - responseFields : responseFields ); + includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,17 +145,17 @@ public static Mozu.Api.Contracts.Location.Location GetDirectShipLocation(Service } /// - /// Retrieves the details of the location configured for the in-store pickup (SP) location usage type for the site specified in the request. If the location is not associated with a location type configured for the in-store pickup location usage type (SP), the operation returns an error. + /// /// /// - /// var result = LocationFactory.GetInStorePickupLocation(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = LocationFactory.GetInStorePickupLocation(handler : handler, locationCode : locationCode, includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.Location.Location GetInStorePickupLocation(ServiceClientMessageHandler handler, - string code, string responseFields = null, + string locationCode, bool? includeAttributeDefinition = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -162,10 +163,10 @@ public static Mozu.Api.Contracts.Location.Location GetInStorePickupLocation(Serv var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationClient( - code : code, responseFields : responseFields ); + locationCode : locationCode, includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,17 +183,17 @@ public static Mozu.Api.Contracts.Location.Location GetInStorePickupLocation(Serv } /// - /// Retrieves a list of locations valid for in-store pickup of an item in an order according to any filter and sort criteria. For example, an application could use this operation to provide a store finder feature based on the shopper's GPS coordinates. If the location types for the in-store pickup location usage type are not configured for the site, this operation returns an error. + /// /// /// - /// var result = LocationFactory.GetInStorePickupLocations(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = LocationFactory.GetInStorePickupLocations(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.Location.LocationCollection GetInStorePickupLocations(ServiceClientMessageHandler handler, - int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeAttributeDefinition = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -200,10 +201,10 @@ public static Mozu.Api.Contracts.Location.LocationCollection GetInStorePickupLoc var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationsClient( - startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, includeAttributeDefinition : includeAttributeDefinition, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/OrderFactory.cs b/Mozu.Api.Test/Factories/Commerce/OrderFactory.cs old mode 100644 new mode 100755 similarity index 85% rename from Mozu.Api.Test/Factories/OrderFactory.cs rename to Mozu.Api.Test/Factories/Commerce/OrderFactory.cs index d43a695a..50e9fe26 --- a/Mozu.Api.Test/Factories/OrderFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/OrderFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce { /// /// Use the Orders resource to manage all components of order processing, payment, and fulfillment. @@ -30,17 +31,17 @@ public partial class OrderFactory : BaseDataFactory { /// - /// Retrieves a list of orders according to any specified filter criteria and sort options. + /// /// /// - /// var result = OrderFactory.GetOrders(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = OrderFactory.GetOrders(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, includeBin : includeBin, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderCollection GetOrders(ServiceClientMessageHandler handler, - int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null, + int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, bool? includeBin = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -48,10 +49,10 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderCollection GetOrder var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.OrderClient.GetOrdersClient( - startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, responseFields : responseFields ); + startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, includeBin : includeBin, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderCollection GetOrder } /// - /// Retrieves the actions available to perform for an order based on its current status. + /// /// /// /// var result = OrderFactory.GetAvailableActions(handler : handler, orderId : orderId, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static List GetAvailableActions(ServiceClientMessageHandler handl orderId : orderId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static List GetAvailableActions(ServiceClientMessageHandler handl } /// - /// Retrieves an order for the purpose of splitting it into multiple taxable orders in order to fulfill the order in multiple locations. + /// /// /// /// var result = OrderFactory.GetTaxableOrders(handler : handler, orderId : orderId, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static List GetAvailableActions(ServiceClientMessageHandler handl orderId : orderId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,17 +145,17 @@ public static List GetAvailableActions(ServiceClientMessageHandler handl } /// - /// Retrieves the details of an order specified by the order ID. + /// /// /// - /// var result = OrderFactory.GetOrder(handler : handler, orderId : orderId, draft : draft, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = OrderFactory.GetOrder(handler : handler, orderId : orderId, draft : draft, includeBin : includeBin, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order GetOrder(ServiceClientMessageHandler handler, - string orderId, bool? draft = null, string responseFields = null, + string orderId, bool? draft = null, bool? includeBin = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -162,10 +163,10 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order GetOrder(ServiceCl var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Commerce.OrderClient.GetOrderClient( - orderId : orderId, draft : draft, responseFields : responseFields ); + orderId : orderId, draft : draft, includeBin : includeBin, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order GetOrder(ServiceCl } /// - /// Creates a new order from an existing cart when the customer chooses to proceed to checkout. + /// /// /// /// var result = OrderFactory.CreateOrderFromCart(handler : handler, cartId : cartId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrderFromCar cartId : cartId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrderFromCar } /// - /// Creates a new order for no-cart quick-ordering scenarios. + /// /// /// /// var result = OrderFactory.CreateOrder(handler : handler, order : order, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrder(Servic order : order, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrder(Servic } /// - /// Perform the specified action for an order. The actions you can perform depend on the current status of the order. + /// /// /// /// var result = OrderFactory.PerformOrderAction(handler : handler, action : action, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformOrderAction action : action, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,45 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformOrderAction } /// - /// Processes a digital wallet (used to hold 3rd party payment and shipping information). + /// + /// + /// + /// var result = OrderFactory.PriceOrder(handler : handler, order : order, refreshShipping : refreshShipping, couponCodeToApply : couponCodeToApply, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order PriceOrder(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Orders.Order order, bool refreshShipping, string couponCodeToApply = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.OrderClient.PriceOrderClient( + order : order, refreshShipping : refreshShipping, couponCodeToApply : couponCodeToApply, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// /// /// /// var result = OrderFactory.ProcessDigitalWallet(handler : handler, digitalWallet : digitalWallet, orderId : orderId, digitalWalletType : digitalWalletType, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +356,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ProcessDigitalWall digitalWallet : digitalWallet, orderId : orderId, digitalWalletType : digitalWalletType, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +373,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ProcessDigitalWall } /// - /// Update the properties of a discount applied to an order. + /// /// /// /// var result = OrderFactory.UpdateOrderDiscount(handler : handler, discount : discount, orderId : orderId, discountId : discountId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +394,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrderDiscoun discount : discount, orderId : orderId, discountId : discountId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -372,7 +411,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrderDiscoun } /// - /// Deletes the current draft version of the order, which also deletes any uncommitted changes made to the order in draft mode. + /// /// /// /// var result = OrderFactory.DeleteOrderDraft(handler : handler, orderId : orderId, version : version, expectedCode: expectedCode, successCode: successCode); @@ -393,7 +432,7 @@ public static void DeleteOrderDraft(ServiceClientMessageHandler handler, orderId : orderId, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -409,7 +448,7 @@ public static void DeleteOrderDraft(ServiceClientMessageHandler handler, } /// - /// Triggers an order confirmation email to be resent. + /// /// /// /// var result = OrderFactory.ResendOrderConfirmationEmail(handler : handler, action : action, orderId : orderId, expectedCode: expectedCode, successCode: successCode); @@ -430,7 +469,7 @@ public static void ResendOrderConfirmationEmail(ServiceClientMessageHandler hand action : action, orderId : orderId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -446,7 +485,7 @@ public static void ResendOrderConfirmationEmail(ServiceClientMessageHandler hand } /// - /// Changes the price list associated with an order. The desired price list code should be specified in the ApiContext. + /// /// /// /// var result = OrderFactory.ChangeOrderPriceList(handler : handler, priceListCode : priceListCode, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -467,7 +506,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ChangeOrderPriceLi priceListCode : priceListCode, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -484,7 +523,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ChangeOrderPriceLi } /// - /// Updates the user ID of the shopper who placed the order to the current user. + /// /// /// /// var result = OrderFactory.ChangeOrderUserId(handler : handler, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -505,7 +544,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ChangeOrderUserId( orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -522,7 +561,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ChangeOrderUserId( } /// - /// Updates the specified order when additional order information, such as shipping or billing information, is modified during the checkout process. + /// /// /// /// var result = OrderFactory.UpdateOrder(handler : handler, order : order, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -543,7 +582,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrder(Servic order : order, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AdjustmentFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/AdjustmentFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/AdjustmentFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/AdjustmentFactory.cs index 1c58607c..bee93b48 --- a/Mozu.Api.Test/Factories/AdjustmentFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/AdjustmentFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use this subresource to manage ad-hoc order level price adjustments. @@ -30,7 +31,7 @@ public partial class AdjustmentFactory : BaseDataFactory { /// - /// Updates the order handling adjustment. + /// /// /// /// var result = AdjustmentFactory.ApplyHandlingAdjustment(handler : handler, adjustment : adjustment, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyHandlingAdjus adjustment : adjustment, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyHandlingAdjus } /// - /// Applies a shipping adjustment to the specified order. + /// /// /// /// var result = AdjustmentFactory.ApplyShippingAdjustment(handler : handler, adjustment : adjustment, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyShippingAdjus adjustment : adjustment, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyShippingAdjus } /// - /// Applies a price adjustment to the specified order. + /// /// /// /// var result = AdjustmentFactory.ApplyAdjustment(handler : handler, adjustment : adjustment, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyAdjustment(Se adjustment : adjustment, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyAdjustment(Se } /// - /// Removes an adjustment to the order handling fee. + /// /// /// /// var result = AdjustmentFactory.RemoveHandlingAdjustment(handler : handler, orderId : orderId, updateMode : updateMode, version : version, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveHandlingAdju orderId : orderId, updateMode : updateMode, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveHandlingAdju } /// - /// Removes a shipping adjustment previously applied to an order or draft. + /// /// /// /// var result = AdjustmentFactory.RemoveShippingAdjustment(handler : handler, orderId : orderId, updateMode : updateMode, version : version, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveShippingAdju orderId : orderId, updateMode : updateMode, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveShippingAdju } /// - /// Removes a price adjustment from the specified order. + /// /// /// /// var result = AdjustmentFactory.RemoveAdjustment(handler : handler, orderId : orderId, updateMode : updateMode, version : version, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveAdjustment(S orderId : orderId, updateMode : updateMode, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AppliedDiscountOrdersFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/AppliedDiscountOrdersFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/AppliedDiscountOrdersFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/AppliedDiscountOrdersFactory.cs index 10d10c22..b24f27b0 --- a/Mozu.Api.Test/Factories/AppliedDiscountOrdersFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/AppliedDiscountOrdersFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use this subresource to apply coupons to or remove coupons from an order based on a supplied coupon code. @@ -30,7 +31,7 @@ public partial class AppliedDiscountOrdersFactory : BaseDataFactory { /// - /// Apply a coupon to the order. + /// /// /// /// var result = AppliedDiscountFactory.ApplyCoupon(handler : handler, orderId : orderId, couponCode : couponCode, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyCoupon(Servic orderId : orderId, couponCode : couponCode, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyCoupon(Servic } /// - /// Removes a coupon previously applied to the order. + /// /// /// /// var result = AppliedDiscountFactory.RemoveCoupon(handler : handler, orderId : orderId, couponCode : couponCode, updateMode : updateMode, version : version, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveCoupon(Servi orderId : orderId, couponCode : couponCode, updateMode : updateMode, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveCoupon(Servi } /// - /// Removes all coupons previously applied to the order. + /// /// /// /// var result = AppliedDiscountFactory.RemoveCoupons(handler : handler, orderId : orderId, updateMode : updateMode, version : version, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveCoupons(Serv orderId : orderId, updateMode : updateMode, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/Commerce/Orders/Attributedefinition/AttributeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/Attributedefinition/AttributeFactory.cs new file mode 100755 index 00000000..5dceed5c --- /dev/null +++ b/Mozu.Api.Test/Factories/Commerce/Orders/Attributedefinition/AttributeFactory.cs @@ -0,0 +1,228 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#region Usings Setup + +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Net; +using Mozu.Api; +using Mozu.Api.Security; +using Mozu.Api.Test.Helpers; +using System.Diagnostics; +using Newtonsoft.Json.Linq; +using System.Threading; + +#endregion + +namespace Mozu.Api.Test.Factories.Commerce.Orders.Attributedefinition +{ + /// + /// Use the Order Attribute Definition resource to manage the attributes that uniquely describe orders, such as the associated shopping season or "How did you hear about us?". Merchants can display order attributes on the order summary, the order confirmation page, invoices, or packing slips. + /// + public partial class AttributeFactory : BaseDataFactory + { + + /// + /// + /// + /// + /// var result = AttributeFactory.GetAttributes(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttributes(ServiceClientMessageHandler handler, + int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.GetAttributesClient( + startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.GetAttributeVocabularyValues(handler : handler, attributeFQN : attributeFQN, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); + /// return optionalCasting; + /// + /// + /// + public static List GetAttributeVocabularyValues(ServiceClientMessageHandler handler, + string attributeFQN, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.GetAttributeVocabularyValuesClient( + attributeFQN : attributeFQN ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.GetAttribute(handler : handler, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.Attribute GetAttribute(ServiceClientMessageHandler handler, + string attributeFQN, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.GetAttributeClient( + attributeFQN : attributeFQN, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.CreateAttribute(handler : handler, attribute : attribute, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.Attribute CreateAttribute(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.CreateAttributeClient( + attribute : attribute, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AttributeFactory.UpdateAttribute(handler : handler, attribute : attribute, attributeFQN : attributeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.Core.Extensible.Attribute UpdateAttribute(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.UpdateAttributeClient( + attribute : attribute, attributeFQN : attributeFQN, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + + } + +} + + diff --git a/Mozu.Api.Test/Factories/BillingInfoFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/BillingInfoFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/BillingInfoFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/BillingInfoFactory.cs index ca1e7e48..cba7ba6d --- a/Mozu.Api.Test/Factories/BillingInfoFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/BillingInfoFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use the Billing Info subresource to manage the billing information stored for an order. @@ -30,7 +31,7 @@ public partial class BillingInfoFactory : BaseDataFactory { /// - /// Retrieves the billing information associated with an order. + /// /// /// /// var result = BillingInfoFactory.GetBillingInfo(handler : handler, orderId : orderId, draft : draft, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo GetBilling orderId : orderId, draft : draft, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo GetBilling } /// - /// Updates the billing information supplied for an order. + /// /// /// /// var result = BillingInfoFactory.SetBillingInfo(handler : handler, billingInfo : billingInfo, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo SetBilling billingInfo : billingInfo, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DigitalPackageFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/DigitalPackageFactory.cs old mode 100644 new mode 100755 similarity index 89% rename from Mozu.Api.Test/Factories/DigitalPackageFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/DigitalPackageFactory.cs index ab2c45fc..075056f4 --- a/Mozu.Api.Test/Factories/DigitalPackageFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/DigitalPackageFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// A digital package is a package in a digital format. @@ -30,7 +31,7 @@ public partial class DigitalPackageFactory : BaseDataFactory { /// - /// Retrieves a collection of fulfillment options for digital packages. Options may include emailed files/links or provided links. + /// /// /// /// var result = DigitalPackageFactory.GetAvailableDigitalPackageFulfillmentActions(handler : handler, orderId : orderId, digitalPackageId : digitalPackageId, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static List GetAvailableDigitalPackageFulfillmentActions(ServiceC orderId : orderId, digitalPackageId : digitalPackageId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static List GetAvailableDigitalPackageFulfillmentActions(ServiceC } /// - /// This operation retreives a digital package within an order and it requires two parameters: orderId and digitalPackageId. + /// /// /// /// var result = DigitalPackageFactory.GetDigitalPackage(handler : handler, orderId : orderId, digitalPackageId : digitalPackageId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage GetD orderId : orderId, digitalPackageId : digitalPackageId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage GetD } /// - /// Lets you apply a digital package to the order using the orderId and digitalPackage parameters. + /// /// /// /// var result = DigitalPackageFactory.CreateDigitalPackage(handler : handler, digitalPackage : digitalPackage, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage Crea digitalPackage : digitalPackage, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage Crea } /// - /// This method operates on one digital package, specified by the id given. This method ensures that the digital package ID provided is in the order with the id given, and then updates the properties of that package with the properties of the one passed in using the ‘digitalpackage’ parameter. + /// /// /// /// var result = DigitalPackageFactory.UpdateDigitalPackage(handler : handler, digitalPackage : digitalPackage, orderId : orderId, digitalPackageId : digitalPackageId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage Upda digitalPackage : digitalPackage, orderId : orderId, digitalPackageId : digitalPackageId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage Upda } /// - /// This operation deletes a digital package from an order. This operation requires three parameters: orderId, digitalPackageId, and digitalPackage. + /// /// /// /// var result = DigitalPackageFactory.DeleteDigitalPackage(handler : handler, orderId : orderId, digitalPackageId : digitalPackageId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteDigitalPackage(ServiceClientMessageHandler handler, orderId : orderId, digitalPackageId : digitalPackageId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PublishingFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/ExtendedPropertyFactory.cs old mode 100644 new mode 100755 similarity index 54% rename from Mozu.Api.Test/Factories/PublishingFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/ExtendedPropertyFactory.cs index 409e61b6..c4ca5dd3 --- a/Mozu.Api.Test/Factories/PublishingFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/ExtendedPropertyFactory.cs @@ -18,40 +18,41 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// - /// Use the Product Publishing resource to publish or discard pending changes to product definitions in the master catalog. + /// /// - public partial class PublishingFactory : BaseDataFactory + public partial class ExtendedPropertyFactory : BaseDataFactory { /// /// /// /// - /// var result = PublishingFactory.GetPublishSet(handler : handler, publishSetCode : publishSetCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = ExtendedPropertyFactory.GetExtendedProperties(handler : handler, orderId : orderId, draft : draft, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.ProductAdmin.PublishSet GetPublishSet(ServiceClientMessageHandler handler, - string publishSetCode, string responseFields = null, + public static List GetExtendedProperties(ServiceClientMessageHandler handler, + string orderId, bool? draft = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.GetPublishSetClient( - publishSetCode : publishSetCode, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.GetExtendedPropertiesClient( + orderId : orderId, draft : draft ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -71,25 +72,25 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSet GetPublishSet(ServiceCl /// /// /// - /// var result = PublishingFactory.GetPublishSets(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = ExtendedPropertyFactory.AddExtendedProperties(handler : handler, extendedProperties : extendedProperties, orderId : orderId, updateMode : updateMode, version : version, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.ProductAdmin.PublishSetCollection GetPublishSets(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + public static List AddExtendedProperties(ServiceClientMessageHandler handler, + List extendedProperties, string orderId, string updateMode = null, string version = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.GetPublishSetsClient( - responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.AddExtendedPropertiesClient( + extendedProperties : extendedProperties, orderId : orderId, updateMode : updateMode, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,28 +107,28 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSetCollection GetPublishSet } /// - /// Deletes the draft version of product changes for each product code specified in the request. + /// /// /// - /// var result = PublishingFactory.DiscardDrafts(handler : handler, publishScope : publishScope, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = ExtendedPropertyFactory.UpdateExtendedProperty(handler : handler, extendedProperty : extendedProperty, orderId : orderId, key : key, updateMode : updateMode, version : version, upsert : upsert, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static void DiscardDrafts(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ProductAdmin.PublishingScope publishScope, DataViewMode dataViewMode= DataViewMode.Live, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) + public static Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty UpdateExtendedProperty(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty extendedProperty, string orderId, string key, string updateMode = null, string version = null, bool? upsert = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.DiscardDraftsClient( - publishScope : publishScope, dataViewMode: dataViewMode ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.UpdateExtendedPropertyClient( + extendedProperty : extendedProperty, orderId : orderId, key : key, updateMode : updateMode, version : version, upsert : upsert, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -135,36 +136,37 @@ public static void DiscardDrafts(ServiceClientMessageHandler handler, Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); if (customException != null) throw customException; + return null; } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) ? (apiClient.Result()) : null; } /// - /// Publishes the draft version of product changes for each product code specified in the request, and changes the product publish state to "live". + /// /// /// - /// var result = PublishingFactory.PublishDrafts(handler : handler, publishScope : publishScope, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = ExtendedPropertyFactory.UpdateExtendedProperties(handler : handler, extendedProperties : extendedProperties, orderId : orderId, updateMode : updateMode, version : version, upsert : upsert, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); /// return optionalCasting; /// /// /// - public static void PublishDrafts(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ProductAdmin.PublishingScope publishScope, DataViewMode dataViewMode= DataViewMode.Live, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) + public static List UpdateExtendedProperties(ServiceClientMessageHandler handler, + List extendedProperties, string orderId, string updateMode = null, string version = null, bool? upsert = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.PublishDraftsClient( - publishScope : publishScope, dataViewMode: dataViewMode ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.UpdateExtendedPropertiesClient( + extendedProperties : extendedProperties, orderId : orderId, updateMode : updateMode, version : version, upsert : upsert ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -172,8 +174,9 @@ public static void PublishDrafts(ServiceClientMessageHandler handler, Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); if (customException != null) throw customException; + return null; } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) ? (apiClient.Result()) : null; @@ -183,25 +186,25 @@ public static void PublishDrafts(ServiceClientMessageHandler handler, /// /// /// - /// var result = PublishingFactory.AssignProductsToPublishSet(handler : handler, publishSet : publishSet, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = ExtendedPropertyFactory.DeleteExtendedProperty(handler : handler, orderId : orderId, key : key, updateMode : updateMode, version : version, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.ProductAdmin.PublishSet AssignProductsToPublishSet(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ProductAdmin.PublishSet publishSet, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + public static void DeleteExtendedProperty(ServiceClientMessageHandler handler, + string orderId, string key, string updateMode = null, string version = null, + HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.AssignProductsToPublishSetClient( - publishSet : publishSet, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.DeleteExtendedPropertyClient( + orderId : orderId, key : key, updateMode : updateMode, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -209,9 +212,8 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSet AssignProductsToPublish Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); if (customException != null) throw customException; - return null; } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) ? (apiClient.Result()) : null; @@ -221,25 +223,25 @@ public static Mozu.Api.Contracts.ProductAdmin.PublishSet AssignProductsToPublish /// /// /// - /// var result = PublishingFactory.DeletePublishSet(handler : handler, publishSetCode : publishSetCode, discardDrafts : discardDrafts, expectedCode: expectedCode, successCode: successCode); + /// var result = ExtendedPropertyFactory.DeleteExtendedProperties(handler : handler, keys : keys, orderId : orderId, updateMode : updateMode, version : version, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static void DeletePublishSet(ServiceClientMessageHandler handler, - string publishSetCode, bool? discardDrafts = null, + public static void DeleteExtendedProperties(ServiceClientMessageHandler handler, + List keys, string orderId, string updateMode = null, string version = null, HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.DeletePublishSetClient( - publishSetCode : publishSetCode, discardDrafts : discardDrafts ); + var apiClient = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.DeleteExtendedPropertiesClient( + keys : keys, orderId : orderId, updateMode : updateMode, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/FulfillmentActionFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/FulfillmentActionFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/FulfillmentActionFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/FulfillmentActionFactory.cs index 10ff2a61..8c8bc97c --- a/Mozu.Api.Test/Factories/FulfillmentActionFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/FulfillmentActionFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use the Fulfillment resource to manage shipments or pickups of collections of packages for an order. @@ -30,7 +31,7 @@ public partial class FulfillmentActionFactory : BaseDataFactory { /// - /// Sets the fulfillment action to "Ship" or "PickUp". To ship an order or prepare it for in-store pickup, the order must have a customer name, the "Open" or "OpenAndProcessing" status. To ship the order, it must also have the full shipping address and shipping method. Shipping all packages or picking up all pickups for an order will complete a paid order. + /// /// /// /// var result = FulfillmentActionFactory.PerformFulfillmentAction(handler : handler, action : action, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformFulfillment action : action, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformFulfillment } /// - /// Resends an email with details about the package fulfillment to the shopper. + /// /// /// /// var result = FulfillmentActionFactory.ResendPackageFulfillmentEmail(handler : handler, action : action, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order ResendPackageFulfi action : action, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/FulfillmentInfoFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/FulfillmentInfoFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/FulfillmentInfoFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/FulfillmentInfoFactory.cs index 2abdf765..025e5758 --- a/Mozu.Api.Test/Factories/FulfillmentInfoFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/FulfillmentInfoFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use the Fulfillment Information resource to manage shipping or pickup information for orders. @@ -30,7 +31,7 @@ public partial class FulfillmentInfoFactory : BaseDataFactory { /// - /// Retrieves a list of the fulfillment information for the specified order. + /// /// /// /// var result = FulfillmentInfoFactory.GetFulfillmentInfo(handler : handler, orderId : orderId, draft : draft, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo Get orderId : orderId, draft : draft, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo Get } /// - /// Updates one or more properties of fulfillment information for the specified order. + /// /// /// /// var result = FulfillmentInfoFactory.SetFulFillmentInfo(handler : handler, fulfillmentInfo : fulfillmentInfo, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo Set fulfillmentInfo : fulfillmentInfo, orderId : orderId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/OrderAttributeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/OrderAttributeFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/OrderAttributeFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/OrderAttributeFactory.cs index 9ccd3f05..618db75d --- a/Mozu.Api.Test/Factories/OrderAttributeFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/OrderAttributeFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use the Order Attributes resource to define how an order attribute definition applies to a specific order. @@ -30,7 +31,7 @@ public partial class OrderAttributeFactory : BaseDataFactory { /// - /// Retrieves a list of the attributes defined for the order specified in the request. + /// /// /// /// var result = OrderAttributeFactory.GetOrderAttributes(handler : handler, orderId : orderId, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class OrderAttributeFactory : BaseDataFactory orderId : orderId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class OrderAttributeFactory : BaseDataFactory } /// - /// Applies a list of attributes to the order specified in the request and defines a value for each attribute in the request body. + /// /// /// /// var result = OrderAttributeFactory.CreateOrderAttributes(handler : handler, orderAttributes : orderAttributes, orderId : orderId, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public partial class OrderAttributeFactory : BaseDataFactory orderAttributes : orderAttributes, orderId : orderId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public partial class OrderAttributeFactory : BaseDataFactory } /// - /// Updates one or more properties of an attribute defined for the order specified in the request. + /// /// /// /// var result = OrderAttributeFactory.UpdateOrderAttributes(handler : handler, orderAttributes : orderAttributes, orderId : orderId, removeMissing : removeMissing, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public partial class OrderAttributeFactory : BaseDataFactory orderAttributes : orderAttributes, orderId : orderId, removeMissing : removeMissing ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/OrderItemFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/OrderItemFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/OrderItemFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/OrderItemFactory.cs index 9f5fbc19..267fc721 --- a/Mozu.Api.Test/Factories/OrderItemFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/OrderItemFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use this subresource to retrieve details about items in an active order. @@ -30,7 +31,7 @@ public partial class OrderItemFactory : BaseDataFactory { /// - /// Retrieves an order item with the order line ID. + /// /// /// /// var result = OrderItemFactory.GetOrderItemViaLineId(handler : handler, orderId : orderId, lineId : lineId, draft : draft, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem GetOrderItemVi orderId : orderId, lineId : lineId, draft : draft, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem GetOrderItemVi } /// - /// Retrieves the details of a single order item. + /// /// /// /// var result = OrderItemFactory.GetOrderItem(handler : handler, orderId : orderId, orderItemId : orderItemId, draft : draft, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem GetOrderItem(S orderId : orderId, orderItemId : orderItemId, draft : draft, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem GetOrderItem(S } /// - /// Retrieves the details of all items in an order. + /// /// /// /// var result = OrderItemFactory.GetOrderItems(handler : handler, orderId : orderId, draft : draft, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItemCollection GetO orderId : orderId, draft : draft, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItemCollection GetO } /// - /// Adds a new item to a defined order. + /// /// /// /// var result = OrderItemFactory.CreateOrderItem(handler : handler, orderItem : orderItem, orderId : orderId, updateMode : updateMode, version : version, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrderItem(Se orderItem : orderItem, orderId : orderId, updateMode : updateMode, version : version, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrderItem(Se } /// - /// Update the discount applied to an item in an order. + /// /// /// /// var result = OrderItemFactory.UpdateOrderItemDiscount(handler : handler, discount : discount, orderId : orderId, orderItemId : orderItemId, discountId : discountId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrderItemDis discount : discount, orderId : orderId, orderItemId : orderItemId, discountId : discountId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrderItemDis } /// - /// Update the duty fee information for an order item. + /// /// /// /// var result = OrderItemFactory.UpdateItemDuty(handler : handler, orderId : orderId, orderItemId : orderItemId, dutyAmount : dutyAmount, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemDuty(Ser orderId : orderId, orderItemId : orderItemId, dutyAmount : dutyAmount, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemDuty(Ser } /// - /// Updates the item fulfillment information for the order specified in the request. + /// /// /// /// var result = OrderItemFactory.UpdateItemFulfillment(handler : handler, orderItem : orderItem, orderId : orderId, orderItemId : orderItemId, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemFulfillm orderItem : orderItem, orderId : orderId, orderItemId : orderItemId, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemFulfillm } /// - /// Override the price of an individual product on a line item in the specified order. + /// /// /// /// var result = OrderItemFactory.UpdateItemProductPrice(handler : handler, orderId : orderId, orderItemId : orderItemId, price : price, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemProductP orderId : orderId, orderItemId : orderItemId, price : price, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemProductP } /// - /// Update the quantity of an item in an order. + /// /// /// /// var result = OrderItemFactory.UpdateItemQuantity(handler : handler, orderId : orderId, orderItemId : orderItemId, quantity : quantity, updateMode : updateMode, version : version, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemQuantity orderId : orderId, orderItemId : orderItemId, quantity : quantity, updateMode : updateMode, version : version, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -372,7 +373,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemQuantity } /// - /// Removes a previously added item from a defined order. + /// /// /// /// var result = OrderItemFactory.DeleteOrderItem(handler : handler, orderId : orderId, orderItemId : orderItemId, updateMode : updateMode, version : version, expectedCode: expectedCode, successCode: successCode); @@ -393,7 +394,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order DeleteOrderItem(Se orderId : orderId, orderItemId : orderItemId, updateMode : updateMode, version : version ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/OrderNoteFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/OrderNoteFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/OrderNoteFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/OrderNoteFactory.cs index 86d8458a..d8c065dc --- a/Mozu.Api.Test/Factories/OrderNoteFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/OrderNoteFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use the Order Notes subresource to manage merchant-level notes associated with an active order. @@ -30,7 +31,7 @@ public partial class OrderNoteFactory : BaseDataFactory { /// - /// Retrieves a list of all notes for an order. + /// /// /// /// var result = OrderNoteFactory.GetOrderNotes(handler : handler, orderId : orderId, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class OrderNoteFactory : BaseDataFactory orderId : orderId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class OrderNoteFactory : BaseDataFactory } /// - /// Retrieves the details of a specific order note. + /// /// /// /// var result = OrderNoteFactory.GetOrderNote(handler : handler, orderId : orderId, noteId : noteId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote GetOrderNote(S orderId : orderId, noteId : noteId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote GetOrderNote(S } /// - /// Creates a new merchant note for the specified order. + /// /// /// /// var result = OrderNoteFactory.CreateOrderNote(handler : handler, orderNote : orderNote, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote CreateOrderNot orderNote : orderNote, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote CreateOrderNot } /// - /// Updates a specific note for an order. + /// /// /// /// var result = OrderNoteFactory.UpdateOrderNote(handler : handler, orderNote : orderNote, orderId : orderId, noteId : noteId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote UpdateOrderNot orderNote : orderNote, orderId : orderId, noteId : noteId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote UpdateOrderNot } /// - /// Deletes the specified order note. + /// /// /// /// var result = OrderNoteFactory.DeleteOrderNote(handler : handler, orderId : orderId, noteId : noteId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteOrderNote(ServiceClientMessageHandler handler, orderId : orderId, noteId : noteId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/OrderReturnableItemFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/OrderReturnableItemFactory.cs old mode 100644 new mode 100755 similarity index 88% rename from Mozu.Api.Test/Factories/OrderReturnableItemFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/OrderReturnableItemFactory.cs index 8b057dc6..1dd85990 --- a/Mozu.Api.Test/Factories/OrderReturnableItemFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/OrderReturnableItemFactory.cs @@ -18,22 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// - /// Use this subresource to view which order items are eligible for return. + /// /// public partial class OrderReturnableItemFactory : BaseDataFactory { /// - /// Retrieves information about which items are eligible for return on an order.Each item displays the following information: - - - + /// /// /// /// var result = OrderReturnableItemFactory.GetOrderReturnableItems(handler : handler, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -54,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderReturnableItemColle orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/OrderValidationResultFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/OrderValidationResultFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/OrderValidationResultFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/OrderValidationResultFactory.cs index 2a6b511b..995eeace --- a/Mozu.Api.Test/Factories/OrderValidationResultFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/OrderValidationResultFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Manage the results of order validation. @@ -30,7 +31,7 @@ public partial class OrderValidationResultFactory : BaseDataFactory { /// - /// Retrieves a list of the validation results associated with the order. + /// /// /// /// var result = OrderValidationResultFactory.GetValidationResults(handler : handler, orderId : orderId, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class OrderValidationResultFactory : BaseDataFactory orderId : orderId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class OrderValidationResultFactory : BaseDataFactory } /// - /// Add a new order validation result to a submitted order. + /// /// /// /// var result = OrderValidationResultFactory.AddValidationResult(handler : handler, validationResult : validationResult, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderValidationResult Ad validationResult : validationResult, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PaymentFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/PaymentFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/PaymentFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/PaymentFactory.cs index 95c16487..d0e878d3 --- a/Mozu.Api.Test/Factories/PaymentFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/PaymentFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use the Payments subresource to manage payment transactions for orders. Each transaction performed for an order represents an individual payment. For example, if an order totals $75.00 but the shopper has a $50.00 gift certificate, both the gift certificate transaction and the credit card transaction for the remaining $25.00 are recorded as payments for the order. @@ -30,7 +31,7 @@ public partial class PaymentFactory : BaseDataFactory { /// - /// Retrieves information about all payment transactions submitted for the specified order. + /// /// /// /// var result = PaymentFactory.GetPayments(handler : handler, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentCollection GetP orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentCollection GetP } /// - /// Retrieves the list of all available payment actions dependent on the order payment status by specifying the order ID. + /// /// /// /// var result = PaymentFactory.GetAvailablePaymentActions(handler : handler, orderId : orderId, paymentId : paymentId, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static List GetAvailablePaymentActions(ServiceClientMessageHandle orderId : orderId, paymentId : paymentId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static List GetAvailablePaymentActions(ServiceClientMessageHandle } /// - /// Retrieves information about a specific payment transaction submitted for the specified order. + /// /// /// /// var result = PaymentFactory.GetPayment(handler : handler, orderId : orderId, paymentId : paymentId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.Payment GetPayment(Ser orderId : orderId, paymentId : paymentId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.Payment GetPayment(Ser } /// - /// Performs the specified action for an individual order payment transaction. + /// /// /// /// var result = PaymentFactory.PerformPaymentAction(handler : handler, action : action, orderId : orderId, paymentId : paymentId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformPaymentActi action : action, orderId : orderId, paymentId : paymentId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformPaymentActi } /// - /// Creates a new payment transaction for the specified order and performs the specified action. + /// /// /// /// var result = PaymentFactory.CreatePaymentAction(handler : handler, action : action, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreatePaymentActio action : action, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PickupFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/PickupFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/PickupFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/PickupFactory.cs index df07616e..5d7e1534 --- a/Mozu.Api.Test/Factories/PickupFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/PickupFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use the Pickups resource to organize items submitted in an order into pickups that enable the shopper to fulfill the order items using the in-store pickup method. @@ -30,7 +31,7 @@ public partial class PickupFactory : BaseDataFactory { /// - /// Retrieves a list of the actions available to perform for the pickup specified in the request. + /// /// /// /// var result = PickupFactory.GetAvailablePickupFulfillmentActions(handler : handler, orderId : orderId, pickupId : pickupId, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static List GetAvailablePickupFulfillmentActions(ServiceClientMes orderId : orderId, pickupId : pickupId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static List GetAvailablePickupFulfillmentActions(ServiceClientMes } /// - /// Retrieves the details of the in-store pickup specified in the request. + /// /// /// /// var result = PickupFactory.GetPickup(handler : handler, orderId : orderId, pickupId : pickupId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup GetPickup(Se orderId : orderId, pickupId : pickupId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup GetPickup(Se } /// - /// Create a new pickup for the order specified in the request for in-store fufillment. + /// /// /// /// var result = PickupFactory.CreatePickup(handler : handler, pickup : pickup, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup CreatePickup pickup : pickup, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup CreatePickup } /// - /// Updates one or more details of a defined in-store pickup. + /// /// /// /// var result = PickupFactory.UpdatePickup(handler : handler, pickup : pickup, orderId : orderId, pickupId : pickupId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup UpdatePickup pickup : pickup, orderId : orderId, pickupId : pickupId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup UpdatePickup } /// - /// Removes a pickup previously defined for order item in-store pickup fulfillment. + /// /// /// /// var result = PickupFactory.DeletePickup(handler : handler, orderId : orderId, pickupId : pickupId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeletePickup(ServiceClientMessageHandler handler, orderId : orderId, pickupId : pickupId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/RefundFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/RefundFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/RefundFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/RefundFactory.cs index 69475021..bbff3943 --- a/Mozu.Api.Test/Factories/RefundFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/RefundFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// - /// Use the refunds resource to create a refund. + /// /// public partial class RefundFactory : BaseDataFactory { /// - /// Creates a refund based on the information supplied in the request. + /// /// /// /// var result = RefundFactory.CreateRefund(handler : handler, refund : refund, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Refunds.Refund CreateRefund(Ser refund : refund, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Refunds.Refund CreateRefund(Ser } /// - /// Resends the order refund email previously sent to the shopper. + /// /// /// /// var result = RefundFactory.ResendRefundEmail(handler : handler, orderId : orderId, refundId : refundId, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static void ResendRefundEmail(ServiceClientMessageHandler handler, orderId : orderId, refundId : refundId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/StorefrontPackageFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/StorefrontPackageFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/StorefrontPackageFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/StorefrontPackageFactory.cs index 0badf14d..4ec2e099 --- a/Mozu.Api.Test/Factories/StorefrontPackageFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/StorefrontPackageFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use the Packages subresource to manage the physical packages to ship for an order. @@ -30,7 +31,7 @@ public partial class StorefrontPackageFactory : BaseDataFactory { /// - /// Retrieves a list of the actions available to perform for a package associated with order fulfillment. + /// /// /// /// var result = PackageFactory.GetAvailablePackageFulfillmentActions(handler : handler, orderId : orderId, packageId : packageId, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static List GetAvailablePackageFulfillmentActions(ServiceClientMe orderId : orderId, packageId : packageId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static List GetAvailablePackageFulfillmentActions(ServiceClientMe } /// - /// Retrieves the package label image supplied by the carrier. + /// /// /// /// var result = PackageFactory.GetPackageLabel(handler : handler, orderId : orderId, packageId : packageId, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static System.IO.Stream GetPackageLabel(ServiceClientMessageHandler handl orderId : orderId, packageId : packageId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static System.IO.Stream GetPackageLabel(ServiceClientMessageHandler handl } /// - /// Retrieves the details of a package of order items. + /// /// /// /// var result = PackageFactory.GetPackage(handler : handler, orderId : orderId, packageId : packageId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package GetPackage( orderId : orderId, packageId : packageId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package GetPackage( } /// - /// Creates a new physical package of order items. + /// /// /// /// var result = PackageFactory.CreatePackage(handler : handler, pkg : pkg, orderId : orderId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package CreatePacka pkg : pkg, orderId : orderId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package CreatePacka } /// - /// Updates one or more properties of a physical package of order items. + /// /// /// /// var result = PackageFactory.UpdatePackage(handler : handler, pkg : pkg, orderId : orderId, packageId : packageId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package UpdatePacka pkg : pkg, orderId : orderId, packageId : packageId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package UpdatePacka } /// - /// Removes a physical package of items from the specified order. + /// /// /// /// var result = PackageFactory.DeletePackage(handler : handler, orderId : orderId, packageId : packageId, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static void DeletePackage(ServiceClientMessageHandler handler, orderId : orderId, packageId : packageId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/StorefrontShipmentFactory.cs b/Mozu.Api.Test/Factories/Commerce/Orders/StorefrontShipmentFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/StorefrontShipmentFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Orders/StorefrontShipmentFactory.cs index 68da430e..b75bd8e0 --- a/Mozu.Api.Test/Factories/StorefrontShipmentFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Orders/StorefrontShipmentFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Orders { /// /// Use the shipments resource to manage shipments of collections of packages for an order. @@ -30,7 +31,7 @@ public partial class StorefrontShipmentFactory : BaseDataFactory { /// - /// Retrieves the details of the order shipment specified in the request. + /// /// /// /// var result = ShipmentFactory.GetShipment(handler : handler, orderId : orderId, shipmentId : shipmentId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen orderId : orderId, shipmentId : shipmentId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen } /// - /// Retrieves the available shipping methods applicable to the order. Typically used to display available shipping method options on the checkout page. + /// /// /// /// var result = ShipmentFactory.GetAvailableShipmentMethods(handler : handler, orderId : orderId, draft : draft, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen orderId : orderId, draft : draft ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen } /// - /// Creates a shipment from one or more package associated with an order and assign a label and tracking number to an order shipment. + /// /// /// /// var result = ShipmentFactory.CreatePackageShipments(handler : handler, packageIds : packageIds, orderId : orderId, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen packageIds : packageIds, orderId : orderId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen } /// - /// Deletes the shipment specified in the request. + /// /// /// /// var result = ShipmentFactory.DeleteShipment(handler : handler, orderId : orderId, shipmentId : shipmentId, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static void DeleteShipment(ServiceClientMessageHandler handler, orderId : orderId, shipmentId : shipmentId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/FraudScreenFactory.cs b/Mozu.Api.Test/Factories/Commerce/Payments/FraudScreenFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/FraudScreenFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Payments/FraudScreenFactory.cs index cbec2830..5b38676c --- a/Mozu.Api.Test/Factories/FraudScreenFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Payments/FraudScreenFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Payments { /// - /// commerce/payments/fraudscreen related resources. DOCUMENT_HERE + /// /// public partial class FraudScreenFactory : BaseDataFactory { /// - /// payments-fraudscreen Post Screen description DOCUMENT_HERE + /// /// /// /// var result = FraudScreenFactory.Screen(handler : handler, request : request, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.PaymentService.Response.FraudScreen Screen(Serv request : request, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PublicCardFactory.cs b/Mozu.Api.Test/Factories/Commerce/Payments/PublicCardFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/PublicCardFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Payments/PublicCardFactory.cs index 4e874a6b..95ead004 --- a/Mozu.Api.Test/Factories/PublicCardFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Payments/PublicCardFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Payments { /// - /// commerce/payments/cards related resources. DOCUMENT_HERE + /// /// public partial class PublicCardFactory : BaseDataFactory { /// - /// payments-cards Post Create description DOCUMENT_HERE + /// /// /// /// var result = PublicCardFactory.Create(handler : handler, request : request, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.PaymentService.Response.SyncResponse Create(Ser request : request, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.PaymentService.Response.SyncResponse Create(Ser } /// - /// payments-cards Put Update description DOCUMENT_HERE + /// /// /// /// var result = PublicCardFactory.Update(handler : handler, request : request, cardId : cardId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.PaymentService.Response.SyncResponse Update(Ser request : request, cardId : cardId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.PaymentService.Response.SyncResponse Update(Ser } /// - /// payments-cards Delete Delete description DOCUMENT_HERE + /// /// /// /// var result = PublicCardFactory.Delete(handler : handler, cardId : cardId, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static void Delete(ServiceClientMessageHandler handler, cardId : cardId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ReturnFactory.cs b/Mozu.Api.Test/Factories/Commerce/ReturnFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/ReturnFactory.cs rename to Mozu.Api.Test/Factories/Commerce/ReturnFactory.cs index d318981f..9f86751e --- a/Mozu.Api.Test/Factories/ReturnFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/ReturnFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce { /// - /// Use the Returns resource to manage returned items that were previously fufilled. Returns can include any number of items associated with an original order. Each return must either be associated with an original order or a product definition to represent each returned item.Refer to the [Returns API](https://www.mozu.com/docs/developer/api-guides/returns.htm) topic for more information about creating and processing returns using the API. + /// Use the Returns resource to manage returned items that were previously fufilled. Returns can include any number of items associated with an original Mozu order. Each return must either be associated with an original order or a product definition to represent each returned item. /// public partial class ReturnFactory : BaseDataFactory { /// - /// Retrieves a list of all returns according to any filter and sort criteria. + /// /// /// /// var result = ReturnFactory.GetReturns(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnCollection GetRet startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnCollection GetRet } /// - /// Retrieves a list of the actions available to perform for the specified return based on its current state. + /// /// /// /// var result = ReturnFactory.GetAvailableReturnActions(handler : handler, returnId : returnId, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static List GetAvailableReturnActions(ServiceClientMessageHandler returnId : returnId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static List GetAvailableReturnActions(ServiceClientMessageHandler } /// - /// Retrieves the details of a single return item. + /// /// /// /// var result = ReturnFactory.GetReturnItem(handler : handler, returnId : returnId, returnItemId : returnItemId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItem GetReturnIte returnId : returnId, returnItemId : returnItemId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItem GetReturnIte } /// - /// Retrieves the details of all return items in an order. + /// /// /// /// var result = ReturnFactory.GetReturnItems(handler : handler, returnId : returnId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItemCollection Ge returnId : returnId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItemCollection Ge } /// - /// Retrieves a list of the payment actions available to perform for the specified return when a return results in a refund to the customer. + /// /// /// /// var result = ReturnFactory.GetAvailablePaymentActionsForReturn(handler : handler, returnId : returnId, paymentId : paymentId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static List GetAvailablePaymentActionsForReturn(ServiceClientMess returnId : returnId, paymentId : paymentId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static List GetAvailablePaymentActionsForReturn(ServiceClientMess } /// - /// Retrieves the details of a payment submitted as part of a refund associated with a customer return. + /// /// /// /// var result = ReturnFactory.GetPayment(handler : handler, returnId : returnId, paymentId : paymentId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.Payment GetPayment(Ser returnId : returnId, paymentId : paymentId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.Payment GetPayment(Ser } /// - /// Retrieves a list of all payments submitted as part of a refund associated with a customer return. + /// /// /// /// var result = ReturnFactory.GetPayments(handler : handler, returnId : returnId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentCollection GetP returnId : returnId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentCollection GetP } /// - /// Retrieves a list of properties for the specified return. + /// /// /// /// var result = ReturnFactory.GetReturn(handler : handler, returnId : returnId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return GetReturn(Servic returnId : returnId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return GetReturn(Servic } /// - /// Returns a list of reasons for a return. + /// /// /// /// var result = ReturnFactory.GetReasons(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReasonCollection GetRea responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -372,10 +373,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReasonCollection GetRea } /// - /// Creates a return for previously fulfilled items. Each return must either be associated with an original order or a product definition to represent each returned item.When you create a return, you must specify the following fields: - - - + /// /// /// /// var result = ReturnFactory.CreateReturn(handler : handler, ret : ret, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -396,7 +394,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreateReturn(Ser ret : ret, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -413,7 +411,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreateReturn(Ser } /// - /// Adds a return item to the return. + /// /// /// /// var result = ReturnFactory.CreateReturnItem(handler : handler, returnItem : returnItem, returnId : returnId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -434,7 +432,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreateReturnItem returnItem : returnItem, returnId : returnId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -451,7 +449,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreateReturnItem } /// - /// Updates a refund payment associated with a customer return by performing the specified action. + /// /// /// /// var result = ReturnFactory.PerformPaymentActionForReturn(handler : handler, action : action, returnId : returnId, paymentId : paymentId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -472,7 +470,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return PerformPaymentAc action : action, returnId : returnId, paymentId : paymentId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -489,7 +487,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return PerformPaymentAc } /// - /// Creates a new payment for a return that results in a refund to the customer. + /// /// /// /// var result = ReturnFactory.CreatePaymentActionForReturn(handler : handler, action : action, returnId : returnId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -510,7 +508,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreatePaymentAct action : action, returnId : returnId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -527,7 +525,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreatePaymentAct } /// - /// Creates a replacement order for the return. + /// /// /// /// var result = ReturnFactory.CreateReturnShippingOrder(handler : handler, itemQuantities : itemQuantities, returnId : returnId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -548,7 +546,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateReturnShippi itemQuantities : itemQuantities, returnId : returnId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -565,7 +563,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateReturnShippi } /// - /// Updates the return by performing the action specified in the request. + /// /// /// /// var result = ReturnFactory.PerformReturnActions(handler : handler, action : action, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -586,7 +584,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnCollection Perfor action : action, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -603,7 +601,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnCollection Perfor } /// - /// Updates one or more properties of a return for items previously shipped in a completed order. + /// /// /// /// var result = ReturnFactory.UpdateReturn(handler : handler, ret : ret, returnId : returnId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -624,7 +622,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return UpdateReturn(Ser ret : ret, returnId : returnId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -641,7 +639,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return UpdateReturn(Ser } /// - /// Resend the email notification to a shopper that a return has been created. + /// /// /// /// var result = ReturnFactory.ResendReturnEmail(handler : handler, action : action, expectedCode: expectedCode, successCode: successCode); @@ -662,7 +660,7 @@ public static void ResendReturnEmail(ServiceClientMessageHandler handler, action : action ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -678,7 +676,7 @@ public static void ResendReturnEmail(ServiceClientMessageHandler handler, } /// - /// Removes a particular order item from the order of the current shopper. + /// /// /// /// var result = ReturnFactory.DeleteOrderItem(handler : handler, returnId : returnId, returnItemId : returnItemId, expectedCode: expectedCode, successCode: successCode); @@ -699,7 +697,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return DeleteOrderItem( returnId : returnId, returnItemId : returnItemId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -716,7 +714,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Returns.Return DeleteOrderItem( } /// - /// Deletes the return specified in the request. + /// /// /// /// var result = ReturnFactory.DeleteReturn(handler : handler, returnId : returnId, expectedCode: expectedCode, successCode: successCode); @@ -737,7 +735,7 @@ public static void DeleteReturn(ServiceClientMessageHandler handler, returnId : returnId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/EntityListsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Returns/OrderNoteFactory.cs old mode 100644 new mode 100755 similarity index 57% rename from Mozu.Api.Test/Factories/EntityListsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Returns/OrderNoteFactory.cs index 3ecf3238..82235a26 --- a/Mozu.Api.Test/Factories/EntityListsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Returns/OrderNoteFactory.cs @@ -18,40 +18,41 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Returns { /// - /// The Entity Lists resource manages all dynamic entities in your Mozu document store of the Mozu cloud. The content is JSON and can have up to five indexed properties (integer, decimal, string, date, and boolean) with support for additional customized elements as needed. Every document in the entity list has a validated unique ID. + /// /// - public partial class EntityListsFactory : BaseDataFactory + public partial class OrderNoteFactory : BaseDataFactory { /// - /// Get a filtered list of EntityLists for a specific tenant. + /// /// /// - /// var result = EntityListsFactory.GetEntityLists(handler : handler, pageSize : pageSize, startIndex : startIndex, filter : filter, sortBy : sortBy, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderNoteFactory.GetReturnNotes(handler : handler, returnId : returnId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.MZDB.EntityListCollection GetEntityLists(ServiceClientMessageHandler handler, - int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null, + public static List GetReturnNotes(ServiceClientMessageHandler handler, + string returnId, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.EntityLists.EntityListsClient.GetEntityListsClient( - pageSize : pageSize, startIndex : startIndex, filter : filter, sortBy : sortBy, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.GetReturnNotesClient( + returnId : returnId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,28 +69,28 @@ public static Mozu.Api.Contracts.MZDB.EntityListCollection GetEntityLists(Servic } /// - /// Get an existing EntityList definition for a specific tenant + /// /// /// - /// var result = EntityListsFactory.GetEntityList(handler : handler, entityListFullName : entityListFullName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderNoteFactory.GetReturnNote(handler : handler, returnId : returnId, noteId : noteId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.MZDB.EntityList GetEntityList(ServiceClientMessageHandler handler, - string entityListFullName, string responseFields = null, + public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote GetReturnNote(ServiceClientMessageHandler handler, + string returnId, string noteId, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.EntityLists.EntityListsClient.GetEntityListClient( - entityListFullName : entityListFullName, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.GetReturnNoteClient( + returnId : returnId, noteId : noteId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,28 +107,28 @@ public static Mozu.Api.Contracts.MZDB.EntityList GetEntityList(ServiceClientMess } /// - /// Create a new EntityList for a specific tenant. + /// /// /// - /// var result = EntityListsFactory.CreateEntityList(handler : handler, entityList : entityList, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderNoteFactory.CreateReturnNote(handler : handler, returnNote : returnNote, returnId : returnId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.MZDB.EntityList CreateEntityList(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.MZDB.EntityList entityList, string responseFields = null, + public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote CreateReturnNote(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote returnNote, string returnId, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.EntityLists.EntityListsClient.CreateEntityListClient( - entityList : entityList, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.CreateReturnNoteClient( + returnNote : returnNote, returnId : returnId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,28 +145,28 @@ public static Mozu.Api.Contracts.MZDB.EntityList CreateEntityList(ServiceClientM } /// - /// Update an existing Entitylist for a specific tenant. + /// /// /// - /// var result = EntityListsFactory.UpdateEntityList(handler : handler, entityList : entityList, entityListFullName : entityListFullName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); + /// var result = OrderNoteFactory.UpdateReturnNote(handler : handler, returnNote : returnNote, returnId : returnId, noteId : noteId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static Mozu.Api.Contracts.MZDB.EntityList UpdateEntityList(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.MZDB.EntityList entityList, string entityListFullName, string responseFields = null, + public static Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote UpdateReturnNote(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote returnNote, string returnId, string noteId, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.EntityLists.EntityListsClient.UpdateEntityListClient( - entityList : entityList, entityListFullName : entityListFullName, responseFields : responseFields ); + var apiClient = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.UpdateReturnNoteClient( + returnNote : returnNote, returnId : returnId, noteId : noteId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,28 +183,28 @@ public static Mozu.Api.Contracts.MZDB.EntityList UpdateEntityList(ServiceClientM } /// - /// Delete an existing EntityList for a specific tenant. This will also delete all Entities in all instances of this EntityList for the tenant. + /// /// /// - /// var result = EntityListsFactory.DeleteEntityList(handler : handler, entityListFullName : entityListFullName, expectedCode: expectedCode, successCode: successCode); + /// var result = OrderNoteFactory.DeleteReturnNote(handler : handler, returnId : returnId, noteId : noteId, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// - public static void DeleteEntityList(ServiceClientMessageHandler handler, - string entityListFullName, + public static void DeleteReturnNote(ServiceClientMessageHandler handler, + string returnId, string noteId, HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) { SetSdKparameters(); var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.EntityLists.EntityListsClient.DeleteEntityListClient( - entityListFullName : entityListFullName ); + var apiClient = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.DeleteReturnNoteClient( + returnId : returnId, noteId : noteId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ReturnsPackageFactory.cs b/Mozu.Api.Test/Factories/Commerce/Returns/ReturnsPackageFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ReturnsPackageFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Returns/ReturnsPackageFactory.cs index 69345ddb..1a30915a --- a/Mozu.Api.Test/Factories/ReturnsPackageFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Returns/ReturnsPackageFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Returns { /// /// Use the Return Packages subresource to manage physical packages used to ship return replacement items. @@ -30,7 +31,7 @@ public partial class ReturnsPackageFactory : BaseDataFactory { /// - /// Retrieves the package label image supplied by the carrier for a return replacement. + /// /// /// /// var result = PackageFactory.GetPackageLabel(handler : handler, returnId : returnId, packageId : packageId, returnAsBase64Png : returnAsBase64Png, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static System.IO.Stream GetPackageLabel(ServiceClientMessageHandler handl returnId : returnId, packageId : packageId, returnAsBase64Png : returnAsBase64Png ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static System.IO.Stream GetPackageLabel(ServiceClientMessageHandler handl } /// - /// Retrieves the details of a package of return replacement items. + /// /// /// /// var result = PackageFactory.GetPackage(handler : handler, returnId : returnId, packageId : packageId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package GetPackage( returnId : returnId, packageId : packageId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package GetPackage( } /// - /// Creates a new physical package of return replacement items. + /// /// /// /// var result = PackageFactory.CreatePackage(handler : handler, pkg : pkg, returnId : returnId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package CreatePacka pkg : pkg, returnId : returnId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package CreatePacka } /// - /// Updates one or more properties of a package associated with a return replacement. + /// /// /// /// var result = PackageFactory.UpdatePackage(handler : handler, pkg : pkg, returnId : returnId, packageId : packageId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package UpdatePacka pkg : pkg, returnId : returnId, packageId : packageId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package UpdatePacka } /// - /// Deletes a package associated with a return replacement. + /// /// /// /// var result = PackageFactory.DeletePackage(handler : handler, returnId : returnId, packageId : packageId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeletePackage(ServiceClientMessageHandler handler, returnId : returnId, packageId : packageId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ReturnsShipmentFactory.cs b/Mozu.Api.Test/Factories/Commerce/Returns/ReturnsShipmentFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ReturnsShipmentFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Returns/ReturnsShipmentFactory.cs index 9108e25c..ac661bd2 --- a/Mozu.Api.Test/Factories/ReturnsShipmentFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Returns/ReturnsShipmentFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Returns { /// /// Use the Return Shipments subresource to manage shipments for a return replacement. @@ -30,7 +31,7 @@ public partial class ReturnsShipmentFactory : BaseDataFactory { /// - /// Retrieves the details of the specified return replacement shipment. + /// /// /// /// var result = ShipmentFactory.GetShipment(handler : handler, returnId : returnId, shipmentId : shipmentId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen returnId : returnId, shipmentId : shipmentId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen } /// - /// Creates a shipment from one or more packages associated with a return replacement. + /// /// /// /// var result = ShipmentFactory.CreatePackageShipments(handler : handler, packageIds : packageIds, returnId : returnId, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen packageIds : packageIds, returnId : returnId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipmen } /// - /// Deletes a shipment for a return replacement. + /// /// /// /// var result = ShipmentFactory.DeleteShipment(handler : handler, returnId : returnId, shipmentId : shipmentId, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static void DeleteShipment(ServiceClientMessageHandler handler, returnId : returnId, shipmentId : shipmentId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ApplicationSettingsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/ApplicationSettingsFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/ApplicationSettingsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/ApplicationSettingsFactory.cs index 94ff679f..095779a1 --- a/Mozu.Api.Test/Factories/ApplicationSettingsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/ApplicationSettingsFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings { /// /// Use the Applications resource to update site-specific settings for installed applications. @@ -30,7 +31,7 @@ public partial class ApplicationSettingsFactory : BaseDataFactory { /// - /// Retrieve the settings of a third-party application. + /// /// /// /// var result = ApplicationFactory.ThirdPartyGetApplication(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.SiteSettings.Application.Application ThirdParty responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.SiteSettings.Application.Application ThirdParty } /// - /// Initializes an application with the necessary configured settings. + /// /// /// /// var result = ApplicationFactory.ThirdPartyUpdateApplication(handler : handler, application : application, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.SiteSettings.Application.Application ThirdParty application : application, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CartSettingsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/CartSettingsFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/CartSettingsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/CartSettingsFactory.cs index e2ce2d20..12844bd9 --- a/Mozu.Api.Test/Factories/CartSettingsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/CartSettingsFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings { /// - /// Use the cart subresource to manage settings for the cart, such as whether to include handling fees in the cost calculations. + /// /// public partial class CartSettingsFactory : BaseDataFactory { /// - /// Retrieves cart settings. + /// /// /// /// var result = CartSettingsFactory.GetCartSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.CartSettings GetCartSettings responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.CartSettings GetCartSettings } /// - /// Creates cart settings. + /// /// /// /// var result = CartSettingsFactory.CreateCartSettings(handler : handler, cartSettings : cartSettings, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.CartSettings CreateCartSetti cartSettings : cartSettings, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.CartSettings CreateCartSetti } /// - /// Updates cart settings. + /// /// /// /// var result = CartSettingsFactory.UpdateCartSettings(handler : handler, cartSettings : cartSettings, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.CartSettings UpdateCartSetti cartSettings : cartSettings, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerCheckoutSettingsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/Checkout/CustomerCheckoutSettingsFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/CustomerCheckoutSettingsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/Checkout/CustomerCheckoutSettingsFactory.cs index 9ac46b08..00108b20 --- a/Mozu.Api.Test/Factories/CustomerCheckoutSettingsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/Checkout/CustomerCheckoutSettingsFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings.Checkout { /// /// Use the Customer Checkout Settings resource to define login settings that apply when shoppers proceed to checkout. @@ -30,7 +31,7 @@ public partial class CustomerCheckoutSettingsFactory : BaseDataFactory { /// - /// Retrieves all checkout settings defined for the site: Payment settings, such as the payment gateway ID and credentials, supported credit cards, and more; Customer Checkout settings, such as whether login is required, and any custom attributes; and Order Processing settings, such as when payment is authorized and captured, and any custom attributes. + /// /// /// /// var result = CustomerCheckoutSettingsFactory.GetCustomerCheckoutSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings Get responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings Get } /// - /// Modifies existing site checkout settings. Modify Payment, Customer Checkout, and Order Processing settings in one PUT. + /// /// /// /// var result = CustomerCheckoutSettingsFactory.UpdateCustomerCheckoutSettings(handler : handler, customerCheckoutSettings : customerCheckoutSettings, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings Upd customerCheckoutSettings : customerCheckoutSettings, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PaymentSettingsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/Checkout/PaymentSettingsFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/PaymentSettingsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/Checkout/PaymentSettingsFactory.cs index 53bb82df..fe11cb4e --- a/Mozu.Api.Test/Factories/PaymentSettingsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/Checkout/PaymentSettingsFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings.Checkout { /// /// Use the Payment Settings resource to specify settings when creating payments for order checkout on the site. @@ -30,7 +31,7 @@ public partial class PaymentSettingsFactory : BaseDataFactory { /// - /// Retrieves the schema and definition along with the actual instance values of the third-party payment service workflow configured for the corresponding fully qualified name. + /// /// /// /// var result = PaymentSettingsFactory.GetThirdPartyPaymentWorkflowWithValues(handler : handler, fullyQualifiedName : fullyQualifiedName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefin fullyQualifiedName : fullyQualifiedName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefin } /// - /// Retrieves the schema and definition of all third-party payment service workflows configured for the site. + /// /// /// /// var result = PaymentSettingsFactory.GetThirdPartyPaymentWorkflows(handler : handler, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefin ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefin } /// - /// Adds a third-party payment workflow to the site. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the platform. + /// /// /// /// var result = PaymentSettingsFactory.AddThirdPartyPaymentWorkflow(handler : handler, definition : definition, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static void AddThirdPartyPaymentWorkflow(ServiceClientMessageHandler hand definition : definition ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -143,7 +144,7 @@ public static void AddThirdPartyPaymentWorkflow(ServiceClientMessageHandler hand } /// - /// Deletes a third-party payment workflow. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the platform. + /// /// /// /// var result = PaymentSettingsFactory.DeleteThirdPartyPaymentWorkflow(handler : handler, fullyQualifiedName : fullyQualifiedName, expectedCode: expectedCode, successCode: successCode); @@ -164,7 +165,7 @@ public static void DeleteThirdPartyPaymentWorkflow(ServiceClientMessageHandler h fullyQualifiedName : fullyQualifiedName ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CheckoutSettingsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/CheckoutSettingsFactory.cs old mode 100644 new mode 100755 similarity index 86% rename from Mozu.Api.Test/Factories/CheckoutSettingsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/CheckoutSettingsFactory.cs index 7daedf35..66f03619 --- a/Mozu.Api.Test/Factories/CheckoutSettingsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/CheckoutSettingsFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings { /// /// Use the Checkout Settings resource to specify the site-wide settings that define checkout and order processing behavior. This resource includes subresources for payment settings, customer checkout settings, and order processing settings. @@ -30,7 +31,7 @@ public partial class CheckoutSettingsFactory : BaseDataFactory { /// - /// Retrieves all checkout settings defined for the site including payment settings (payment gateway ID and credentials), shopper checkout settings (login requirement or guest mode and custom attributes), and order processing settings (when payment is authorized and captured plus any custom attributes). + /// /// /// /// var result = CheckoutSettingsFactory.GetCheckoutSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.SiteSettings.Order.CheckoutSettings GetCheckout responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomRouteSettingsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/General/CustomRouteSettingsFactory.cs old mode 100644 new mode 100755 similarity index 86% rename from Mozu.Api.Test/Factories/CustomRouteSettingsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/General/CustomRouteSettingsFactory.cs index ca9c0ade..c7d1c74d --- a/Mozu.Api.Test/Factories/CustomRouteSettingsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/General/CustomRouteSettingsFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings.General { /// - /// Use the Custom Routes resource to manage your custom route settings. Custom routing allows you to display SEO-friendly URLs on your site that map behind-the-scenes to conventional resources such as a product page or a search results page. With custom routing, you gain advanced control over the URL structures on your site and can more visibly highlight the products or categories your shoppers are interested in purchasing.To learn more about custom routing, refer to the [Custom Route Settings](../../../guides/settings/custom-routes.htm) topic. + /// /// public partial class CustomRouteSettingsFactory : BaseDataFactory { /// - /// Retrieves the custom route settings configured for a site. These are the same settings configured through in the Custom Routing JSON Editor. + /// /// /// /// var result = CustomRouteSettingsFactory.GetCustomRouteSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRout responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRout } /// - /// Create new custom route settings. + /// /// /// /// var result = CustomRouteSettingsFactory.CreateCustomRouteSettings(handler : handler, settings : settings, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRout settings : settings, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRout } /// - /// Updates custom route settings. + /// /// /// /// var result = CustomRouteSettingsFactory.UpdateCustomRouteSettings(handler : handler, settings : settings, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRout settings : settings, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRout } /// - /// Deletes all the custom route settings for a site, returning all routes to their defaults. + /// /// /// /// var result = CustomRouteSettingsFactory.DeleteCustomRouteSettings(handler : handler, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static void DeleteCustomRouteSettings(ServiceClientMessageHandler handler ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/TaxableTerritoryFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/General/TaxableTerritoryFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/TaxableTerritoryFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/General/TaxableTerritoryFactory.cs index 9d84bb77..28edd620 --- a/Mozu.Api.Test/Factories/TaxableTerritoryFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/General/TaxableTerritoryFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings.General { /// /// Use the taxable territories subresource to manage the regional territories for this site that are subejct to sales tax. @@ -30,7 +31,7 @@ public partial class TaxableTerritoryFactory : BaseDataFactory { /// - /// Retrieves a list of the taxable territories configured for the site. + /// /// /// /// var result = TaxableTerritoryFactory.GetTaxableTerritories(handler : handler, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class TaxableTerritoryFactory : BaseDataFactory ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class TaxableTerritoryFactory : BaseDataFactory } /// - /// Creates a new territory for which to calculate sales tax. + /// /// /// /// var result = TaxableTerritoryFactory.AddTaxableTerritory(handler : handler, taxableTerritory : taxableTerritory, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.TaxableTerritory AddTaxabl taxableTerritory : taxableTerritory, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.TaxableTerritory AddTaxabl } /// - /// Updates one or more taxable territories configured for a site. + /// /// /// /// var result = TaxableTerritoryFactory.UpdateTaxableTerritories(handler : handler, taxableterritories : taxableterritories, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.TaxableTerritory AddTaxabl taxableterritories : taxableterritories ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/GeneralSettingsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/GeneralSettingsFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/GeneralSettingsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/GeneralSettingsFactory.cs index a2175d18..57da10d1 --- a/Mozu.Api.Test/Factories/GeneralSettingsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/GeneralSettingsFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings { /// /// Define global site settings such as the site name, shipping and email addresses, and logo images. Block undesirable IP addresses using this resource. @@ -30,7 +31,7 @@ public partial class GeneralSettingsFactory : BaseDataFactory { /// - /// Retrieve a site's general global settings. + /// /// /// /// var result = GeneralSettingsFactory.GetGeneralSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.GeneralSettings GetGeneral responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.GeneralSettings GetGeneral } /// - /// Updates a site's general global settings. + /// /// /// /// var result = GeneralSettingsFactory.UpdateGeneralSettings(handler : handler, generalSettings : generalSettings, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.SiteSettings.General.GeneralSettings UpdateGene generalSettings : generalSettings, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/LocationUsageFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/LocationUsageFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/LocationUsageFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/LocationUsageFactory.cs index de927760..136a78cb --- a/Mozu.Api.Test/Factories/LocationUsageFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/LocationUsageFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings { /// /// Use the Location Usages resource to define the locations and location types that interact with the specified site. The system creates three default location usage types for each site after provisioning a new tenant - one for direct ship (DS), one for in-store pickup (SP), and one for store finder (storeFinder). Each site can only use a single location for the direct ship location usage type, and the location must support the direct ship fulfillment type (DS). For the in-store pickup location usage type, each site can use one or more location types. The location service identifies all locations of the specified type that support the in-store pickup fulfillment type (SP). For the store finder location usage type, each site can use one or more location types. The location service identifies all locations of the type. Locations configured for the store finder type do not typically maintain inventory. You cannot create additional location usage types at this time. @@ -30,7 +31,7 @@ public partial class LocationUsageFactory : BaseDataFactory { /// - /// Retrieves the configured site location usages for the location usage code specified in the request. + /// /// /// /// var result = LocationUsageFactory.GetLocationUsages(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Location.LocationUsageCollection GetLocationUsa responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Location.LocationUsageCollection GetLocationUsa } /// - /// Retrieves the location usages for the site specified in the request header. + /// /// /// /// var result = LocationUsageFactory.GetLocationUsage(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Location.LocationUsage GetLocationUsage(Service code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Location.LocationUsage GetLocationUsage(Service } /// - /// Updates the location usage for the site based on the location usage code specified in the request. + /// /// /// /// var result = LocationUsageFactory.UpdateLocationUsage(handler : handler, usage : usage, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Location.LocationUsage UpdateLocationUsage(Serv usage : usage, code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/SiteShippingHandlingFeeFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/Shipping/SiteShippingHandlingFeeFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/SiteShippingHandlingFeeFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/Shipping/SiteShippingHandlingFeeFactory.cs index 647f1d54..233dd090 --- a/Mozu.Api.Test/Factories/SiteShippingHandlingFeeFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/Shipping/SiteShippingHandlingFeeFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings.Shipping { /// /// Use the Order Handling Fee subresource to configure any shipping and handling fees to apply to orders for this site. @@ -30,7 +31,7 @@ public partial class SiteShippingHandlingFeeFactory : BaseDataFactory { /// - /// Retrieves the details of the order handling fee configured for the site. + /// /// /// /// var result = SiteShippingHandlingFeeFactory.GetOrderHandlingFee(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee G responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee G } /// - /// Creates a new order handling fee for the site. + /// /// /// /// var result = SiteShippingHandlingFeeFactory.CreateOrderHandlingFee(handler : handler, orderHandlingFee : orderHandlingFee, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee C orderHandlingFee : orderHandlingFee, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee C } /// - /// Updates the order handling fee amount for the site. + /// /// /// /// var result = SiteShippingHandlingFeeFactory.UpdateOrderHandlingFee(handler : handler, orderHandlingFee : orderHandlingFee, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee U orderHandlingFee : orderHandlingFee, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/SiteShippingSettingsFactory.cs b/Mozu.Api.Test/Factories/Commerce/Settings/SiteShippingSettingsFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/SiteShippingSettingsFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Settings/SiteShippingSettingsFactory.cs index 6a1a7df9..081357b6 --- a/Mozu.Api.Test/Factories/SiteShippingSettingsFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Settings/SiteShippingSettingsFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Settings { /// /// Use the shipping subresource to manage settings for the site shipping information, such as origin address information, carrier shipping methods, shipping rate providers, and regions available for shipping. @@ -30,7 +31,7 @@ public partial class SiteShippingSettingsFactory : BaseDataFactory { /// - /// Retrieves a list of the shipping settings configured for a site. + /// /// /// /// var result = SiteShippingSettingsFactory.GetSiteShippingSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingSettings GetS responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CarrierConfigurationFactory.cs b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/CarrierConfigurationFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/CarrierConfigurationFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Shipping/Admin/CarrierConfigurationFactory.cs index bae26316..895a6a11 --- a/Mozu.Api.Test/Factories/CarrierConfigurationFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/CarrierConfigurationFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Shipping.Admin { /// - /// Use the Carriers resource to configure and manage your supported shipping carrier configurations. + /// /// public partial class CarrierConfigurationFactory : BaseDataFactory { /// - /// Retrieves a list of carrier configurations and their details according to any specified facets, filter criteria, and sort options. + /// /// /// /// var result = CarrierConfigurationFactory.GetConfigurations(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.CarrierConfigurationCollection Ge startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.CarrierConfigurationCollection Ge } /// - /// Retrieves the details of the specified carrier configuration. + /// /// /// /// var result = CarrierConfigurationFactory.GetConfiguration(handler : handler, carrierId : carrierId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration GetConfigura carrierId : carrierId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration GetConfigura } /// - /// Creates a new carrier configuration. + /// /// /// /// var result = CarrierConfigurationFactory.CreateConfiguration(handler : handler, carrierConfiguration : carrierConfiguration, carrierId : carrierId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration CreateConfig carrierConfiguration : carrierConfiguration, carrierId : carrierId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration CreateConfig } /// - /// Updates the details of the specified carrier configuration. + /// /// /// /// var result = CarrierConfigurationFactory.UpdateConfiguration(handler : handler, carrierConfiguration : carrierConfiguration, carrierId : carrierId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration UpdateConfig carrierConfiguration : carrierConfiguration, carrierId : carrierId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration UpdateConfig } /// - /// Deletes the specified carrier configuration. + /// /// /// /// var result = CarrierConfigurationFactory.DeleteConfiguration(handler : handler, carrierId : carrierId, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteConfiguration(ServiceClientMessageHandler handler, carrierId : carrierId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesFactory.cs b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesFactory.cs new file mode 100755 index 00000000..d6c27477 --- /dev/null +++ b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesFactory.cs @@ -0,0 +1,227 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#region Usings Setup + +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Net; +using Mozu.Api; +using Mozu.Api.Security; +using Mozu.Api.Test.Helpers; +using System.Diagnostics; +using Newtonsoft.Json.Linq; +using System.Threading; + +#endregion + +namespace Mozu.Api.Test.Factories.Commerce.Shipping.Admin.Profiles +{ + /// + /// + /// + public partial class OrderHandlingFeeRulesFactory : BaseDataFactory + { + + /// + /// + /// + /// + /// var result = OrderHandlingFeeRulesFactory.GetOrderHandlingFeeRule(handler : handler, profilecode : profilecode, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule GetOrderHandlingFeeRule(ServiceClientMessageHandler handler, + string profilecode, string id, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.GetOrderHandlingFeeRuleClient( + profilecode : profilecode, id : id, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = OrderHandlingFeeRulesFactory.GetOrderHandlingFeeRules(handler : handler, profilecode : profilecode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRuleCollection GetOrderHandlingFeeRules(ServiceClientMessageHandler handler, + string profilecode, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.GetOrderHandlingFeeRulesClient( + profilecode : profilecode, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = OrderHandlingFeeRulesFactory.CreateOrderHandlingFeeRule(handler : handler, rule : rule, profilecode : profilecode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule CreateOrderHandlingFeeRule(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.CreateOrderHandlingFeeRuleClient( + rule : rule, profilecode : profilecode, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = OrderHandlingFeeRulesFactory.UpdateOrderHandlingFeeRule(handler : handler, rule : rule, profilecode : profilecode, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule UpdateOrderHandlingFeeRule(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string id, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.UpdateOrderHandlingFeeRuleClient( + rule : rule, profilecode : profilecode, id : id, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = OrderHandlingFeeRulesFactory.DeleteOrderHandlingFeeRule(handler : handler, profilecode : profilecode, id : id, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static void DeleteOrderHandlingFeeRule(ServiceClientMessageHandler handler, + string profilecode, string id, + HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.DeleteOrderHandlingFeeRuleClient( + profilecode : profilecode, id : id ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + } + var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + + } + +} + + diff --git a/Mozu.Api.Test/Factories/HandlingFeeRuleFactory.cs b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesFactory.cs old mode 100644 new mode 100755 similarity index 77% rename from Mozu.Api.Test/Factories/HandlingFeeRuleFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesFactory.cs index d7217320..015f3ee9 --- a/Mozu.Api.Test/Factories/HandlingFeeRuleFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesFactory.cs @@ -18,22 +18,23 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Shipping.Admin.Profiles { /// - /// Use the ProductHandlingFeeRules sub-resource to manage your product handling fee rules that are associated with a specific shipping profile. + /// /// - public partial class HandlingFeeRuleFactory : BaseDataFactory + public partial class ProductHandlingFeeRulesFactory : BaseDataFactory { /// - /// Retrieves the details of the specified product handling fee rule. + /// /// /// - /// var result = HandlingFeeRuleFactory.GetProductHandlingFeeRule(handler : handler, profilecode : profilecode, id : id, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); + /// var result = ProductHandlingFeeRulesFactory.GetProductHandlingFeeRule(handler : handler, profilecode : profilecode, id : id, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// @@ -47,11 +48,11 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule GetProduc var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.GetProductHandlingFeeRuleClient( + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.GetProductHandlingFeeRuleClient( profilecode : profilecode, id : id, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,10 +69,10 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule GetProduc } /// - /// Retrieves a list of product handling fee rules and their details. + /// /// /// - /// var result = HandlingFeeRuleFactory.GetProductHandlingFeeRules(handler : handler, profilecode : profilecode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); + /// var result = ProductHandlingFeeRulesFactory.GetProductHandlingFeeRules(handler : handler, profilecode : profilecode, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// @@ -85,11 +86,11 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRuleCollection var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.GetProductHandlingFeeRulesClient( + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.GetProductHandlingFeeRulesClient( profilecode : profilecode, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,10 +107,10 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRuleCollection } /// - /// Creates a new product handling fee rule. + /// /// /// - /// var result = HandlingFeeRuleFactory.CreateProductHandlingFeeRule(handler : handler, rule : rule, profilecode : profilecode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = ProductHandlingFeeRulesFactory.CreateProductHandlingFeeRule(handler : handler, rule : rule, profilecode : profilecode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// @@ -123,11 +124,11 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule CreatePro var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.CreateProductHandlingFeeRuleClient( + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.CreateProductHandlingFeeRuleClient( rule : rule, profilecode : profilecode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,10 +145,10 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule CreatePro } /// - /// Updates the details of the specified product handling fee rule. + /// /// /// - /// var result = HandlingFeeRuleFactory.UpdateProductHandlingFeeRule(handler : handler, rule : rule, profilecode : profilecode, id : id, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); + /// var result = ProductHandlingFeeRulesFactory.UpdateProductHandlingFeeRule(handler : handler, rule : rule, profilecode : profilecode, id : id, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// @@ -161,11 +162,11 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule UpdatePro var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.UpdateProductHandlingFeeRuleClient( + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.UpdateProductHandlingFeeRuleClient( rule : rule, profilecode : profilecode, id : id, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,10 +183,10 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule UpdatePro } /// - /// Deletes the specified product handling fee rule. + /// /// /// - /// var result = HandlingFeeRuleFactory.DeleteProductHandlingFeeRule(handler : handler, profilecode : profilecode, id : id, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); + /// var result = ProductHandlingFeeRulesFactory.DeleteProductHandlingFeeRule(handler : handler, profilecode : profilecode, id : id, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// @@ -199,11 +200,11 @@ public static void DeleteProductHandlingFeeRule(ServiceClientMessageHandler hand var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.DeleteProductHandlingFeeRuleClient( + var apiClient = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.DeleteProductHandlingFeeRuleClient( profilecode : profilecode, id : id, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ShippingInclusionRuleFactory.cs b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ShippingInclusionRuleFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleFactory.cs index 8f852215..32b2f419 --- a/Mozu.Api.Test/Factories/ShippingInclusionRuleFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Shipping.Admin.Profiles { /// - /// Use the ShippingInclusionRules sub-resource to manage your shipping inclusion rules that are associated with a specific shipping profile. + /// /// public partial class ShippingInclusionRuleFactory : BaseDataFactory { /// - /// Retrieves the details of the specified shipping inclusion rule. + /// /// /// /// var result = ShippingInclusionRuleFactory.GetShippingInclusionRule(handler : handler, profilecode : profilecode, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule Get profilecode : profilecode, id : id, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule Get } /// - /// Retrieves a list of shipping inclusion rules and their details. + /// /// /// /// var result = ShippingInclusionRuleFactory.GetShippingInclusionRules(handler : handler, profilecode : profilecode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRuleColl profilecode : profilecode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRuleColl } /// - /// Creates a new shipping inclusion rule. + /// /// /// /// var result = ShippingInclusionRuleFactory.CreateShippingInclusionRule(handler : handler, rule : rule, profilecode : profilecode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule Cre rule : rule, profilecode : profilecode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule Cre } /// - /// Updates the details of the specified shipping inclusion rule. + /// /// /// /// var result = ShippingInclusionRuleFactory.UpdateShippingInclusionRule(handler : handler, rule : rule, profilecode : profilecode, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule Upd rule : rule, profilecode : profilecode, id : id, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule Upd } /// - /// Deletes the specified shipping inclusion rule. + /// /// /// /// var result = ShippingInclusionRuleFactory.DeleteShippingInclusionRule(handler : handler, profilecode : profilecode, id : id, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteShippingInclusionRule(ServiceClientMessageHandler handl profilecode : profilecode, id : id ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ShippingStatesFactory.cs b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/ShippingStatesFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/ShippingStatesFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/ShippingStatesFactory.cs index 9fa42598..2625e5c8 --- a/Mozu.Api.Test/Factories/ShippingStatesFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/Profiles/ShippingStatesFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Shipping.Admin.Profiles { /// - /// Use the ShippingStates sub-resource to manage the states your shipping profile supports. For example, you can specify one of your shipping profiles to only support Texas, Oklahoma, Arkansas, Louisiana, and New Mexico.Each shipping state is composed of a user-definied code and name. + /// /// public partial class ShippingStatesFactory : BaseDataFactory { /// - /// Retrieves a list of shipping states and their details. + /// /// /// /// var result = ShippingStatesFactory.GetStates(handler : handler, profileCode : profileCode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class ShippingStatesFactory : BaseDataFactory profileCode : profileCode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public partial class ShippingStatesFactory : BaseDataFactory } /// - /// Updates the details of the shipping states. + /// /// /// /// var result = ShippingStatesFactory.UpdateStates(handler : handler, states : states, profilecode : profilecode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public partial class ShippingStatesFactory : BaseDataFactory states : states, profilecode : profilecode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ShippingProfileFactory.cs b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/ShippingProfileFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/ShippingProfileFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Shipping/Admin/ShippingProfileFactory.cs index b9d143ba..278b1cac --- a/Mozu.Api.Test/Factories/ShippingProfileFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Shipping/Admin/ShippingProfileFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Shipping.Admin { /// - /// Use the Profiles resource to manage your shipping profiles. + /// /// public partial class ShippingProfileFactory : BaseDataFactory { /// - /// Retrieves a list of shipping profiles. + /// /// /// /// var result = ShippingProfileFactory.GetProfiles(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingProfileCollection responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/TargetRuleFactory.cs b/Mozu.Api.Test/Factories/Commerce/TargetRuleFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/TargetRuleFactory.cs rename to Mozu.Api.Test/Factories/Commerce/TargetRuleFactory.cs index 5eb84c0e..db00a9f4 --- a/Mozu.Api.Test/Factories/TargetRuleFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/TargetRuleFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce { /// - /// Use the TargetRules resource to manage your target rules for products and zones. For example, you can set specific rules that dictate shipping options for specific products. + /// /// public partial class TargetRuleFactory : BaseDataFactory { /// - /// Retrieves a list of target rules and their details according to any specified facets, filter criteria, and sort options. + /// /// /// /// var result = TargetRuleFactory.GetTargetRules(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.TargetRuleCollection GetTargetRul startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.TargetRuleCollection GetTargetRul } /// - /// Retrieves the details of the specified target rule. + /// /// /// /// var result = TargetRuleFactory.GetTargetRule(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.TargetRule GetTargetRule(ServiceC code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.TargetRule GetTargetRule(ServiceC } /// - /// Creates a new target rule. + /// /// /// /// var result = TargetRuleFactory.CreateTargetRule(handler : handler, targetRule : targetRule, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.TargetRule CreateTargetRule(Servi targetRule : targetRule, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.TargetRule CreateTargetRule(Servi } /// - /// Validates the details of a target rule. + /// /// /// /// var result = TargetRuleFactory.ValidateTargetRule(handler : handler, targetRule : targetRule, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static void ValidateTargetRule(ServiceClientMessageHandler handler, targetRule : targetRule ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -181,7 +182,7 @@ public static void ValidateTargetRule(ServiceClientMessageHandler handler, } /// - /// Updates the details of the specified target rule. + /// /// /// /// var result = TargetRuleFactory.UpdateTargetRule(handler : handler, targetRule : targetRule, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -202,7 +203,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.TargetRule UpdateTargetRule(Servi targetRule : targetRule, code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -219,7 +220,7 @@ public static Mozu.Api.Contracts.ShippingAdmin.TargetRule UpdateTargetRule(Servi } /// - /// Deletes the specified target rule. + /// /// /// /// var result = TargetRuleFactory.DeleteTargetRule(handler : handler, code : code, expectedCode: expectedCode, successCode: successCode); @@ -240,7 +241,7 @@ public static void DeleteTargetRule(ServiceClientMessageHandler handler, code : code ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/WishlistFactory.cs b/Mozu.Api.Test/Factories/Commerce/WishlistFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/WishlistFactory.cs rename to Mozu.Api.Test/Factories/Commerce/WishlistFactory.cs index 84b42230..e753619b --- a/Mozu.Api.Test/Factories/WishlistFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/WishlistFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce { /// /// Use the Wish Lists resource to manage the shopper wish lists of products associated with a customer account. Although customer accounts are managed at the tenant level, the system stores shopper wish lists at the site level. This enables the same customer to have wish lists for each of a merchant's sites. Use the Wish List Items resource to manage items in a wish list. @@ -30,7 +31,7 @@ public partial class WishlistFactory : BaseDataFactory { /// - /// Retrieves a list of shopper wish lists according to any filter and sort criteria. + /// /// /// /// var result = WishlistFactory.GetWishlists(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistCollection Ge startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, q : q, qLimit : qLimit, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistCollection Ge } /// - /// Retrieves the details of the shopper wish list specified in the request. + /// /// /// /// var result = WishlistFactory.GetWishlist(handler : handler, wishlistId : wishlistId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist GetWishlist( wishlistId : wishlistId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist GetWishlist( } /// - /// Retrieves the details of a wish list by supplying the wish list name. + /// /// /// /// var result = WishlistFactory.GetWishlistByName(handler : handler, customerAccountId : customerAccountId, wishlistName : wishlistName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist GetWishlistB customerAccountId : customerAccountId, wishlistName : wishlistName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist GetWishlistB } /// - /// Creates a new shopper wish list for the associated customer account. Although customer accounts are maintained at the tenant level, the system stores wish lists at the site level. Newly created wish lists do not have any items. + /// /// /// /// var result = WishlistFactory.CreateWishlist(handler : handler, wishlist : wishlist, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist CreateWishli wishlist : wishlist, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist CreateWishli } /// - /// Updates one or more properties of a shopper wish list defined for a customer account. + /// /// /// /// var result = WishlistFactory.UpdateWishlist(handler : handler, wishlist : wishlist, wishlistId : wishlistId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist UpdateWishli wishlist : wishlist, wishlistId : wishlistId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist UpdateWishli } /// - /// Deletes the shopper wish list specified in the request and all items associated with it. + /// /// /// /// var result = WishlistFactory.DeleteWishlist(handler : handler, wishlistId : wishlistId, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static void DeleteWishlist(ServiceClientMessageHandler handler, wishlistId : wishlistId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/WishlistItemFactory.cs b/Mozu.Api.Test/Factories/Commerce/Wishlists/WishlistItemFactory.cs old mode 100644 new mode 100755 similarity index 93% rename from Mozu.Api.Test/Factories/WishlistItemFactory.cs rename to Mozu.Api.Test/Factories/Commerce/Wishlists/WishlistItemFactory.cs index 41eaa09a..13344f8d --- a/Mozu.Api.Test/Factories/WishlistItemFactory.cs +++ b/Mozu.Api.Test/Factories/Commerce/Wishlists/WishlistItemFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Commerce.Wishlists { /// /// Use the Wish List Items subresource to manage items in a shopper wish list. The same product can be defined as an item in any number of wish lists for the customer account. Use the Wish Lists resource to manage shopper wish lists. @@ -30,7 +31,7 @@ public partial class WishlistItemFactory : BaseDataFactory { /// - /// Retrieves the details of an item in a shopper wish list. + /// /// /// /// var result = WishlistItemFactory.GetWishlistItem(handler : handler, wishlistId : wishlistId, wishlistItemId : wishlistItemId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem GetWishl wishlistId : wishlistId, wishlistItemId : wishlistItemId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem GetWishl } /// - /// Retrieves a list of items in a shopper wish list according to any specified filter and sort criteria. + /// /// /// /// var result = WishlistItemFactory.GetWishlistItems(handler : handler, wishlistId : wishlistId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItemCollectio wishlistId : wishlistId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItemCollectio } /// - /// Retrieve a list of items in a customer wish list by supplying the wish list name. + /// /// /// /// var result = WishlistItemFactory.GetWishlistItemsByWishlistName(handler : handler, customerAccountId : customerAccountId, wishlistName : wishlistName, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItemCollectio customerAccountId : customerAccountId, wishlistName : wishlistName, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItemCollectio } /// - /// Adds a product in a site's catalog as an item in a shopper wish list. + /// /// /// /// var result = WishlistItemFactory.AddItemToWishlist(handler : handler, wishlistItem : wishlistItem, wishlistId : wishlistId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem AddItemT wishlistItem : wishlistItem, wishlistId : wishlistId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem AddItemT } /// - /// Updates the quantity of an item in a shopper wish list. + /// /// /// /// var result = WishlistItemFactory.UpdateWishlistItemQuantity(handler : handler, wishlistId : wishlistId, wishlistItemId : wishlistItemId, quantity : quantity, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem UpdateWi wishlistId : wishlistId, wishlistItemId : wishlistItemId, quantity : quantity, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem UpdateWi } /// - /// Updates the details of an item in a shopper wish list. + /// /// /// /// var result = WishlistItemFactory.UpdateWishlistItem(handler : handler, wishlistItem : wishlistItem, wishlistId : wishlistId, wishlistItemId : wishlistItemId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem UpdateWi wishlistItem : wishlistItem, wishlistId : wishlistId, wishlistItemId : wishlistItemId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem UpdateWi } /// - /// Removes all items associated with a shopper wish list. + /// /// /// /// var result = WishlistItemFactory.RemoveAllWishlistItems(handler : handler, wishlistId : wishlistId, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist RemoveAllWis wishlistId : wishlistId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist RemoveAllWis } /// - /// Removes an item from the wish list specified in the request. + /// /// /// /// var result = WishlistItemFactory.DeleteWishlistItem(handler : handler, wishlistId : wishlistId, wishlistItemId : wishlistItemId, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static void DeleteWishlistItem(ServiceClientMessageHandler handler, wishlistId : wishlistId, wishlistItemId : wishlistItemId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DocumentDraftSummaryFactory.cs b/Mozu.Api.Test/Factories/Content/DocumentDraftSummaryFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/DocumentDraftSummaryFactory.cs rename to Mozu.Api.Test/Factories/Content/DocumentDraftSummaryFactory.cs index e1c7670d..9212102e --- a/Mozu.Api.Test/Factories/DocumentDraftSummaryFactory.cs +++ b/Mozu.Api.Test/Factories/Content/DocumentDraftSummaryFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content { /// /// Use the document publishing subresource to manage and publish document drafts in the Content service. @@ -30,7 +31,7 @@ public partial class DocumentDraftSummaryFactory : BaseDataFactory { /// - /// Retrieves a list of the documents currently in draft state, according to any defined filter and sort criteria. + /// /// /// /// var result = DocumentDraftSummaryFactory.ListDocumentDraftSummaries(handler : handler, pageSize : pageSize, startIndex : startIndex, documentLists : documentLists, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection Lis pageSize : pageSize, startIndex : startIndex, documentLists : documentLists, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection Lis } /// - /// Deletes the drafts of the specified documents. Published documents cannot be deleted. + /// /// /// /// var result = DocumentDraftSummaryFactory.DeleteDocumentDrafts(handler : handler, documentIds : documentIds, documentLists : documentLists, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static void DeleteDocumentDrafts(ServiceClientMessageHandler handler, documentIds : documentIds, documentLists : documentLists ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -105,7 +106,7 @@ public static void DeleteDocumentDrafts(ServiceClientMessageHandler handler, } /// - /// Publish one or more document drafts to live content on the site. + /// /// /// /// var result = DocumentDraftSummaryFactory.PublishDocuments(handler : handler, documentIds : documentIds, documentLists : documentLists, expectedCode: expectedCode, successCode: successCode); @@ -126,7 +127,7 @@ public static void PublishDocuments(ServiceClientMessageHandler handler, documentIds : documentIds, documentLists : documentLists ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DocumentListFactory.cs b/Mozu.Api.Test/Factories/Content/DocumentListFactory.cs old mode 100644 new mode 100755 similarity index 94% rename from Mozu.Api.Test/Factories/DocumentListFactory.cs rename to Mozu.Api.Test/Factories/Content/DocumentListFactory.cs index 08b113cd..0e88beaf --- a/Mozu.Api.Test/Factories/DocumentListFactory.cs +++ b/Mozu.Api.Test/Factories/Content/DocumentListFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content { /// /// Use the document lists resource to organize your site's documents into a hierarchy. Document lists can contain documents, folders, and complete hierarchies of folders, which contain documents with unique names. @@ -30,7 +31,7 @@ public partial class DocumentListFactory : BaseDataFactory { /// - /// Retrieves a collection of document lists. + /// /// /// /// var result = DocumentListFactory.GetDocumentLists(handler : handler, pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Content.DocumentListCollection GetDocumentLists pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Content.DocumentListCollection GetDocumentLists } /// - /// Retrieve the details of a document list by providing the list name. + /// /// /// /// var result = DocumentListFactory.GetDocumentList(handler : handler, documentListName : documentListName, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Content.DocumentList GetDocumentList(ServiceCli documentListName : documentListName, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Content.DocumentList GetDocumentList(ServiceCli } /// - /// Creates a new documentList + /// /// /// /// var result = DocumentListFactory.CreateDocumentList(handler : handler, list : list, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Content.DocumentList CreateDocumentList(Service list : list, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Content.DocumentList CreateDocumentList(Service } /// - /// Updates a `DocumentListName`. + /// /// /// /// var result = DocumentListFactory.UpdateDocumentList(handler : handler, list : list, documentListName : documentListName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Content.DocumentList UpdateDocumentList(Service list : list, documentListName : documentListName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Content.DocumentList UpdateDocumentList(Service } /// - /// Deletes the specified `DocumentListName`. + /// /// /// /// var result = DocumentListFactory.DeleteDocumentList(handler : handler, documentListName : documentListName, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteDocumentList(ServiceClientMessageHandler handler, documentListName : documentListName ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DocumentListTypeFactory.cs b/Mozu.Api.Test/Factories/Content/DocumentListTypeFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/DocumentListTypeFactory.cs rename to Mozu.Api.Test/Factories/Content/DocumentListTypeFactory.cs index 17221360..569bf158 --- a/Mozu.Api.Test/Factories/DocumentListTypeFactory.cs +++ b/Mozu.Api.Test/Factories/Content/DocumentListTypeFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content { /// - /// Use the Document List Types resource to manage the types of document lists in your site's document hierarchy. The type denotes a content type for that list of folders, sub-folders, and documents such as `web_pages`. + /// /// public partial class DocumentListTypeFactory : BaseDataFactory { /// - /// Gets all the available documentListTypes. + /// /// /// /// var result = DocumentListTypeFactory.GetDocumentListTypes(handler : handler, pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Content.DocumentListTypeCollection GetDocumentL pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Content.DocumentListTypeCollection GetDocumentL } /// - /// Gets a documentListType. + /// /// /// /// var result = DocumentListTypeFactory.GetDocumentListType(handler : handler, documentListTypeFQN : documentListTypeFQN, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Content.DocumentListType GetDocumentListType(Se documentListTypeFQN : documentListTypeFQN, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Content.DocumentListType GetDocumentListType(Se } /// - /// Creates a new documentListType. + /// /// /// /// var result = DocumentListTypeFactory.CreateDocumentListType(handler : handler, list : list, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Content.DocumentListType CreateDocumentListType list : list, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Content.DocumentListType CreateDocumentListType } /// - /// Updates a DocumentListType + /// /// /// /// var result = DocumentListTypeFactory.UpdateDocumentListType(handler : handler, list : list, documentListTypeFQN : documentListTypeFQN, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Content.DocumentListType UpdateDocumentListType list : list, documentListTypeFQN : documentListTypeFQN, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DocumentTypeFactory.cs b/Mozu.Api.Test/Factories/Content/DocumentTypeFactory.cs old mode 100644 new mode 100755 similarity index 94% rename from Mozu.Api.Test/Factories/DocumentTypeFactory.cs rename to Mozu.Api.Test/Factories/Content/DocumentTypeFactory.cs index f42ef5e0..ee07e0e0 --- a/Mozu.Api.Test/Factories/DocumentTypeFactory.cs +++ b/Mozu.Api.Test/Factories/Content/DocumentTypeFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content { /// /// Use the Document Types resource to view the document types supplied by the Content API. @@ -30,7 +31,7 @@ public partial class DocumentTypeFactory : BaseDataFactory { /// - /// Retrieves a paged list of the system-defined document types. + /// /// /// /// var result = DocumentTypeFactory.GetDocumentTypes(handler : handler, pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Content.DocumentTypeCollection GetDocumentTypes pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Content.DocumentTypeCollection GetDocumentTypes } /// - /// Retrieves a system-defined document type. + /// /// /// /// var result = DocumentTypeFactory.GetDocumentType(handler : handler, documentTypeName : documentTypeName, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Content.DocumentType GetDocumentType(ServiceCli documentTypeName : documentTypeName, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Content.DocumentType GetDocumentType(ServiceCli } /// - /// Creates a new DocumentType + /// /// /// /// var result = DocumentTypeFactory.CreateDocumentType(handler : handler, documentType : documentType, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Content.DocumentType CreateDocumentType(Service documentType : documentType, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Content.DocumentType CreateDocumentType(Service } /// - /// Updates a DocumentType + /// /// /// /// var result = DocumentTypeFactory.UpdateDocumentType(handler : handler, documentType : documentType, documentTypeName : documentTypeName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Content.DocumentType UpdateDocumentType(Service documentType : documentType, documentTypeName : documentTypeName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DocumentFactory.cs b/Mozu.Api.Test/Factories/Content/Documentlists/DocumentFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/DocumentFactory.cs rename to Mozu.Api.Test/Factories/Content/Documentlists/DocumentFactory.cs index db16f94f..776a547a --- a/Mozu.Api.Test/Factories/DocumentFactory.cs +++ b/Mozu.Api.Test/Factories/Content/Documentlists/DocumentFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content.Documentlists { /// /// Use this subresource to manage documents in a document list. @@ -30,7 +31,7 @@ public partial class DocumentFactory : BaseDataFactory { /// - /// Retrieve the content associated with a document, such as a product image or PDF specifications file, by supplying the document ID. + /// /// /// /// var result = DocumentFactory.GetDocumentContent(handler : handler, documentListName : documentListName, documentId : documentId, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static System.IO.Stream GetDocumentContent(ServiceClientMessageHandler ha documentListName : documentListName, documentId : documentId, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static System.IO.Stream GetDocumentContent(ServiceClientMessageHandler ha } /// - /// Performs transformations on a document. For example, resizing an image. + /// /// /// /// var result = DocumentFactory.TransformDocumentContent(handler : handler, documentListName : documentListName, documentId : documentId, width : width, height : height, max : max, maxWidth : maxWidth, maxHeight : maxHeight, crop : crop, quality : quality, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static System.IO.Stream TransformDocumentContent(ServiceClientMessageHand documentListName : documentListName, documentId : documentId, width : width, height : height, max : max, maxWidth : maxWidth, maxHeight : maxHeight, crop : crop, quality : quality ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static System.IO.Stream TransformDocumentContent(ServiceClientMessageHand } /// - /// Retrieves a document within the specified document list. + /// /// /// /// var result = DocumentFactory.GetDocument(handler : handler, documentListName : documentListName, documentId : documentId, includeInactive : includeInactive, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Content.Document GetDocument(ServiceClientMessa documentListName : documentListName, documentId : documentId, includeInactive : includeInactive, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Content.Document GetDocument(ServiceClientMessa } /// - /// Retrieves a collection of documents according to any filter and sort criteria. + /// /// /// /// var result = DocumentFactory.GetDocuments(handler : handler, documentListName : documentListName, filter : filter, sortBy : sortBy, pageSize : pageSize, startIndex : startIndex, includeInactive : includeInactive, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Content.DocumentCollection GetDocuments(Service documentListName : documentListName, filter : filter, sortBy : sortBy, pageSize : pageSize, startIndex : startIndex, includeInactive : includeInactive, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Content.DocumentCollection GetDocuments(Service } /// - /// Creates a new document in an defined document list. + /// /// /// /// var result = DocumentFactory.CreateDocument(handler : handler, document : document, documentListName : documentListName, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.Content.Document CreateDocument(ServiceClientMe document : document, documentListName : documentListName, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.Content.Document CreateDocument(ServiceClientMe } /// - /// Updates the binary data or content associated with a document, such as a product image or PDF specifications file, by supplying the document ID. + /// /// /// /// var result = DocumentFactory.UpdateDocumentContent(handler : handler, stream : stream, documentListName : documentListName, documentId : documentId, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static void UpdateDocumentContent(ServiceClientMessageHandler handler, stream : stream, documentListName : documentListName, documentId : documentId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -257,7 +258,7 @@ public static void UpdateDocumentContent(ServiceClientMessageHandler handler, } /// - /// Updates a document in a document list. + /// /// /// /// var result = DocumentFactory.UpdateDocument(handler : handler, document : document, documentListName : documentListName, documentId : documentId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -278,7 +279,7 @@ public static Mozu.Api.Contracts.Content.Document UpdateDocument(ServiceClientMe document : document, documentListName : documentListName, documentId : documentId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -295,7 +296,7 @@ public static Mozu.Api.Contracts.Content.Document UpdateDocument(ServiceClientMe } /// - /// Deletes a specific document based on the specified document ID. + /// /// /// /// var result = DocumentFactory.DeleteDocument(handler : handler, documentListName : documentListName, documentId : documentId, expectedCode: expectedCode, successCode: successCode); @@ -316,7 +317,7 @@ public static void DeleteDocument(ServiceClientMessageHandler handler, documentListName : documentListName, documentId : documentId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -332,7 +333,7 @@ public static void DeleteDocument(ServiceClientMessageHandler handler, } /// - /// Deletes the content associated with a document, such as a product image or PDF specification, by supplying the document ID. + /// /// /// /// var result = DocumentFactory.DeleteDocumentContent(handler : handler, documentListName : documentListName, documentId : documentId, expectedCode: expectedCode, successCode: successCode); @@ -353,7 +354,7 @@ public static void DeleteDocumentContent(ServiceClientMessageHandler handler, documentListName : documentListName, documentId : documentId ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DocumentTreeFactory.cs b/Mozu.Api.Test/Factories/Content/Documentlists/DocumentTreeFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/DocumentTreeFactory.cs rename to Mozu.Api.Test/Factories/Content/Documentlists/DocumentTreeFactory.cs index a2e66250..5a927c26 --- a/Mozu.Api.Test/Factories/DocumentTreeFactory.cs +++ b/Mozu.Api.Test/Factories/Content/Documentlists/DocumentTreeFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content.Documentlists { /// /// Use the document tree subresource to retrieve documents and manage content within the document hierarchy. @@ -30,7 +31,7 @@ public partial class DocumentTreeFactory : BaseDataFactory { /// - /// Retrieve the content associated with the document, such as a product image or PDF specifications file. + /// /// /// /// var result = DocumentTreeFactory.GetTreeDocumentContent(handler : handler, documentListName : documentListName, documentName : documentName, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static System.IO.Stream GetTreeDocumentContent(ServiceClientMessageHandle documentListName : documentListName, documentName : documentName, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static System.IO.Stream GetTreeDocumentContent(ServiceClientMessageHandle } /// - /// Performs transformations on a document. For example, resizing an image. + /// /// /// /// var result = DocumentTreeFactory.TransformTreeDocumentContent(handler : handler, documentListName : documentListName, documentName : documentName, width : width, height : height, max : max, maxWidth : maxWidth, maxHeight : maxHeight, crop : crop, quality : quality, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static System.IO.Stream TransformTreeDocumentContent(ServiceClientMessage documentListName : documentListName, documentName : documentName, width : width, height : height, max : max, maxWidth : maxWidth, maxHeight : maxHeight, crop : crop, quality : quality ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static System.IO.Stream TransformTreeDocumentContent(ServiceClientMessage } /// - /// Retrieves a document based on its document list and folder path in the document hierarchy. + /// /// /// /// var result = DocumentTreeFactory.GetTreeDocument(handler : handler, documentListName : documentListName, documentName : documentName, includeInactive : includeInactive, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Content.Document GetTreeDocument(ServiceClientM documentListName : documentListName, documentName : documentName, includeInactive : includeInactive, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Content.Document GetTreeDocument(ServiceClientM } /// - /// Updates the binary data or content associated with a document, such as a product image or PDF specifications file, by supplying the document name. + /// /// /// /// var result = DocumentTreeFactory.UpdateTreeDocumentContent(handler : handler, stream : stream, documentListName : documentListName, documentName : documentName, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static void UpdateTreeDocumentContent(ServiceClientMessageHandler handler stream : stream, documentListName : documentListName, documentName : documentName ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -181,7 +182,7 @@ public static void UpdateTreeDocumentContent(ServiceClientMessageHandler handler } /// - /// Deletes the content associated with a document, such as a product image or PDF specifications file. + /// /// /// /// var result = DocumentTreeFactory.DeleteTreeDocumentContent(handler : handler, stream : stream, documentListName : documentListName, documentName : documentName, expectedCode: expectedCode, successCode: successCode); @@ -202,7 +203,7 @@ public static void DeleteTreeDocumentContent(ServiceClientMessageHandler handler stream : stream, documentListName : documentListName, documentName : documentName ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/FacetFactory.cs b/Mozu.Api.Test/Factories/Content/Documentlists/FacetFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/FacetFactory.cs rename to Mozu.Api.Test/Factories/Content/Documentlists/FacetFactory.cs index 7107238e..b7d9f641 --- a/Mozu.Api.Test/Factories/FacetFactory.cs +++ b/Mozu.Api.Test/Factories/Content/Documentlists/FacetFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content.Documentlists { /// /// Use the facets subresource to allow a merchant to add information for product indexing and searching. @@ -30,7 +31,7 @@ public partial class FacetFactory : BaseDataFactory { /// - /// Retrieves the properties of facets that aid in indexing and searching. + /// /// /// /// var result = FacetFactory.GetFacets(handler : handler, documentListName : documentListName, propertyName : propertyName, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public partial class FacetFactory : BaseDataFactory documentListName : documentListName, propertyName : propertyName ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ViewFactory.cs b/Mozu.Api.Test/Factories/Content/Documentlists/ViewFactory.cs old mode 100644 new mode 100755 similarity index 89% rename from Mozu.Api.Test/Factories/ViewFactory.cs rename to Mozu.Api.Test/Factories/Content/Documentlists/ViewFactory.cs index 843fcebe..dcfa70c5 --- a/Mozu.Api.Test/Factories/ViewFactory.cs +++ b/Mozu.Api.Test/Factories/Content/Documentlists/ViewFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content.Documentlists { /// - /// Properties and content for views within a site/tenant. Views provide the schema, formatting, and associated content and entities for displaying content within a site/tenant. + /// /// public partial class ViewFactory : BaseDataFactory { /// - /// Retrieves a collection of documents associated with a view. + /// /// /// /// var result = ViewFactory.GetViewDocuments(handler : handler, documentListName : documentListName, viewName : viewName, filter : filter, sortBy : sortBy, pageSize : pageSize, startIndex : startIndex, includeInactive : includeInactive, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Content.DocumentCollection GetViewDocuments(Ser documentListName : documentListName, viewName : viewName, filter : filter, sortBy : sortBy, pageSize : pageSize, startIndex : startIndex, includeInactive : includeInactive, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PropertyTypeFactory.cs b/Mozu.Api.Test/Factories/Content/PropertyTypeFactory.cs old mode 100644 new mode 100755 similarity index 94% rename from Mozu.Api.Test/Factories/PropertyTypeFactory.cs rename to Mozu.Api.Test/Factories/Content/PropertyTypeFactory.cs index 92bae043..68903b6a --- a/Mozu.Api.Test/Factories/PropertyTypeFactory.cs +++ b/Mozu.Api.Test/Factories/Content/PropertyTypeFactory.cs @@ -18,10 +18,11 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content { /// /// Use the property types subresource to manage content properties. @@ -30,7 +31,7 @@ public partial class PropertyTypeFactory : BaseDataFactory { /// - /// Retrieves a list of the content property types. + /// /// /// /// var result = PropertyTypeFactory.GetPropertyTypes(handler : handler, pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Content.PropertyTypeCollection GetPropertyTypes pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Content.PropertyTypeCollection GetPropertyTypes } /// - /// Retrieves the details of the content property type. + /// /// /// /// var result = PropertyTypeFactory.GetPropertyType(handler : handler, propertyTypeName : propertyTypeName, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Content.PropertyType GetPropertyType(ServiceCli propertyTypeName : propertyTypeName, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Content.PropertyType GetPropertyType(ServiceCli } /// - /// Creates a new + /// /// /// /// var result = PropertyTypeFactory.CreatePropertyType(handler : handler, propertyType : propertyType, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Content.PropertyType CreatePropertyType(Service propertyType : propertyType, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Content.PropertyType CreatePropertyType(Service } /// - /// Updates a + /// /// /// /// var result = PropertyTypeFactory.UpdatePropertyType(handler : handler, propertyType : propertyType, propertyTypeName : propertyTypeName, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Content.PropertyType UpdatePropertyType(Service propertyType : propertyType, propertyTypeName : propertyTypeName, responseFields : responseFields, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Content.PropertyType UpdatePropertyType(Service } /// - /// Delete a specific + /// /// /// /// var result = PropertyTypeFactory.DeletePropertyType(handler : handler, propertyTypeName : propertyTypeName, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeletePropertyType(ServiceClientMessageHandler handler, propertyTypeName : propertyTypeName, dataViewMode: dataViewMode ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PublishSetSummaryFactory.cs b/Mozu.Api.Test/Factories/Content/PublishSetSummaryFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/PublishSetSummaryFactory.cs rename to Mozu.Api.Test/Factories/Content/PublishSetSummaryFactory.cs index 6705a19b..2590a584 --- a/Mozu.Api.Test/Factories/PublishSetSummaryFactory.cs +++ b/Mozu.Api.Test/Factories/Content/PublishSetSummaryFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Content { /// - /// Use the Content Publish Set resource to manage content publish sets and the pending content drafts.You can use content publish sets to group pending content changes together and publish them all at the same time. + /// /// public partial class PublishSetSummaryFactory : BaseDataFactory { /// - /// Returns a list of content publish sets. + /// /// /// /// var result = PublishSetSummaryFactory.GetPublishSets(handler : handler, pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Content.PublishSetSummaryPagedCollection GetPub pageSize : pageSize, startIndex : startIndex, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Content.PublishSetSummaryPagedCollection GetPub } /// - /// Retrieves a list of content publish sets and their properties. + /// /// /// /// var result = PublishSetSummaryFactory.GetPublishSetItems(handler : handler, code : code, pageSize : pageSize, startIndex : startIndex, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection Get code : code, pageSize : pageSize, startIndex : startIndex, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection Get } /// - /// Deletes the specified content publish set. You can use the shouldDiscard parameter to specify whether to discard the content drafts assigned to the content publish set. + /// /// /// /// var result = PublishSetSummaryFactory.DeletePublishSet(handler : handler, code : code, shouldDiscard : shouldDiscard, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static object DeletePublishSet(ServiceClientMessageHandler handler, code : code, shouldDiscard : shouldDiscard, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static object DeletePublishSet(ServiceClientMessageHandler handler, } /// - /// Adds a set of documents by id to a specified publish set. + /// /// /// /// var result = PublishSetSummaryFactory.AddPublishSetItems(handler : handler, itemsToPublish : itemsToPublish, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static object AddPublishSetItems(ServiceClientMessageHandler handler, itemsToPublish : itemsToPublish, code : code, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CustomerVisitFactory.cs b/Mozu.Api.Test/Factories/CustomerVisitFactory.cs deleted file mode 100644 index ae647685..00000000 --- a/Mozu.Api.Test/Factories/CustomerVisitFactory.cs +++ /dev/null @@ -1,189 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Visits resource to manage all visits a customer makes to a tenant's sites and measure the level of transactions a customer performs during a unique visit for customer account analytics. Clients can track customer visits by site (including online and in-person interactions), the transactions a customer performs during the visit, and the device type associated with the visit, if any. - /// - public partial class CustomerVisitFactory : BaseDataFactory - { - - /// - /// Retrieves a list of customer visits according to any filter or sort criteria specified in the request. - /// - /// - /// var result = CustomerVisitFactory.GetVisits(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Customer.VisitCollection GetVisits(ServiceClientMessageHandler handler, - int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Customer.VisitClient.GetVisitsClient( - startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the details of the customer visit specified in the request. - /// - /// - /// var result = CustomerVisitFactory.GetVisit(handler : handler, visitId : visitId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Customer.Visit GetVisit(ServiceClientMessageHandler handler, - string visitId, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Customer.VisitClient.GetVisitClient( - visitId : visitId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Creates a new visit for the customer account specified in the request. - /// - /// - /// var result = CustomerVisitFactory.AddVisit(handler : handler, visit : visit, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Customer.Visit AddVisit(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.Customer.Visit visit, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Customer.VisitClient.AddVisitClient( - visit : visit, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Updates one or more properties of a defined customer visit. - /// - /// - /// var result = CustomerVisitFactory.UpdateVisit(handler : handler, visit : visit, visitId : visitId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Customer.Visit UpdateVisit(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.Customer.Visit visit, string visitId, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Customer.VisitClient.UpdateVisitClient( - visit : visit, visitId : visitId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/DocumentPublishSetFactory.cs b/Mozu.Api.Test/Factories/DocumentPublishSetFactory.cs deleted file mode 100644 index 94ce5017..00000000 --- a/Mozu.Api.Test/Factories/DocumentPublishSetFactory.cs +++ /dev/null @@ -1,189 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// - /// - public partial class DocumentPublishSetFactory : BaseDataFactory - { - - /// - /// - /// - /// - /// var result = DocumentPublishSetFactory.GetPublishSets(handler : handler, pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Content.PublishSetSummaryPagedCollection GetPublishSets(ServiceClientMessageHandler handler, - int? pageSize = null, int? startIndex = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.GetPublishSetsClient( - pageSize : pageSize, startIndex : startIndex, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// - /// - /// - /// var result = DocumentPublishSetFactory.GetPublishSetItems(handler : handler, code : code, pageSize : pageSize, startIndex : startIndex, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection GetPublishSetItems(ServiceClientMessageHandler handler, - string code, int? pageSize = null, int? startIndex = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.GetPublishSetItemsClient( - code : code, pageSize : pageSize, startIndex : startIndex, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// - /// - /// - /// var result = DocumentPublishSetFactory.DeletePublishSet(handler : handler, code : code, shouldDiscard : shouldDiscard, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static object DeletePublishSet(ServiceClientMessageHandler handler, - string code, bool? shouldDiscard = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.DeletePublishSetClient( - code : code, shouldDiscard : shouldDiscard, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// - /// - /// - /// var result = DocumentPublishSetFactory.AddPublishSetItems(handler : handler, documentIds : documentIds, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static object AddPublishSetItems(ServiceClientMessageHandler handler, - List documentIds, string code, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.AddPublishSetItemsClient( - documentIds : documentIds, code : code, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/DocumentPublishingFactory.cs b/Mozu.Api.Test/Factories/DocumentPublishingFactory.cs deleted file mode 100644 index 8c070a00..00000000 --- a/Mozu.Api.Test/Factories/DocumentPublishingFactory.cs +++ /dev/null @@ -1,149 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the document publishing subresource to manage and publish document drafts in the Content service. - /// - public partial class DocumentPublishingFactory : BaseDataFactory - { - - /// - /// Retrieves a list of the documents currently in draft state, according to any defined filter and sort criteria. - /// - /// - /// var result = DocumentPublishingFactory.ListDocumentDraftSummaries(handler : handler, pageSize : pageSize, startIndex : startIndex, documentLists : documentLists, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection ListDocumentDraftSummaries(ServiceClientMessageHandler handler, - int? pageSize = null, int? startIndex = null, string documentLists = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Content.DocumentPublishingClient.ListDocumentDraftSummariesClient( - pageSize : pageSize, startIndex : startIndex, documentLists : documentLists, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Deletes the drafts of the specified documents. Published documents cannot be deleted. - /// - /// - /// var result = DocumentPublishingFactory.DeleteDocumentDrafts(handler : handler, documentIds : documentIds, documentLists : documentLists, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static void DeleteDocumentDrafts(ServiceClientMessageHandler handler, - List documentIds, string documentLists = null, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Content.DocumentPublishingClient.DeleteDocumentDraftsClient( - documentIds : documentIds, documentLists : documentLists ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Publish one or more document drafts to live content on the site. - /// - /// - /// var result = DocumentPublishingFactory.PublishDocuments(handler : handler, documentIds : documentIds, documentLists : documentLists, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static void PublishDocuments(ServiceClientMessageHandler handler, - List documentIds, string documentLists = null, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Content.DocumentPublishingClient.PublishDocumentsClient( - documentIds : documentIds, documentLists : documentLists ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/EventNotificationFactory.cs b/Mozu.Api.Test/Factories/Event/EventNotificationFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/EventNotificationFactory.cs rename to Mozu.Api.Test/Factories/Event/EventNotificationFactory.cs index 66ae0895..3ba2296a --- a/Mozu.Api.Test/Factories/EventNotificationFactory.cs +++ b/Mozu.Api.Test/Factories/Event/EventNotificationFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Event { /// - /// Events are notifications publishes to the application when a create, read, update, or delete operation is performed. If the application subscribes to the event, you can use the Events resource to query for recent events published to your application or events that were not published successfully. + /// Events are notifications Mozu publishes to the application when a create, read, update, or delete operation is performed. If the application subscribes to the event, you can use the Events resource to query for recent events Mozu published to your application or events that were not published successfully. /// public partial class EventNotificationFactory : BaseDataFactory { /// - /// Retrieves a list of events. + /// /// /// /// var result = EventNotificationFactory.GetEvents(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Event.EventCollection GetEvents(ServiceClientMe startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Event.EventCollection GetEvents(ServiceClientMe } /// - /// Retrieves an event by providing the event ID. + /// /// /// /// var result = EventNotificationFactory.GetEvent(handler : handler, eventId : eventId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Event.Event GetEvent(ServiceClientMessageHandle eventId : eventId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/SubscriptionFactory.cs b/Mozu.Api.Test/Factories/Event/Push/SubscriptionFactory.cs old mode 100644 new mode 100755 similarity index 85% rename from Mozu.Api.Test/Factories/SubscriptionFactory.cs rename to Mozu.Api.Test/Factories/Event/Push/SubscriptionFactory.cs index f95be25a..1dc93c84 --- a/Mozu.Api.Test/Factories/SubscriptionFactory.cs +++ b/Mozu.Api.Test/Factories/Event/Push/SubscriptionFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Event.Push { /// - /// The Subscriptions resource triggers a push service to sent immediate notifications to the subscribed tenants and applications when triggers. The resource sends messages regarding a subscription event tha occurs in the tenant or site. + /// /// public partial class SubscriptionFactory : BaseDataFactory { /// - /// Retrieves a list of events according to any specified filter criteria and sort options. + /// /// /// /// var result = SubscriptionFactory.GetSubscriptions(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Event.SubscriptionCollection GetSubscriptions(S startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/EventDeliverySummaryFactory.cs b/Mozu.Api.Test/Factories/Event/Push/Subscriptions/EventDeliverySummaryFactory.cs old mode 100644 new mode 100755 similarity index 83% rename from Mozu.Api.Test/Factories/EventDeliverySummaryFactory.cs rename to Mozu.Api.Test/Factories/Event/Push/Subscriptions/EventDeliverySummaryFactory.cs index 8614e960..33e1b15a --- a/Mozu.Api.Test/Factories/EventDeliverySummaryFactory.cs +++ b/Mozu.Api.Test/Factories/Event/Push/Subscriptions/EventDeliverySummaryFactory.cs @@ -18,29 +18,30 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Event.Push.Subscriptions { /// - /// Provides details for each attempted delivery of the event to the endpoint. + /// /// public partial class EventDeliverySummaryFactory : BaseDataFactory { /// - /// This operation method is the external/public event entity used specifically in pull/poll event scenarios. + /// /// /// - /// var result = EventDeliverySummaryFactory.GetDeliveryAttemptSummary(handler : handler, subscriptionId : subscriptionId, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = EventDeliverySummaryFactory.GetDeliveryAttemptSummary(handler : handler, subscriptionId : subscriptionId, processId : processId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// /// /// public static Mozu.Api.Contracts.Event.EventDeliverySummary GetDeliveryAttemptSummary(ServiceClientMessageHandler handler, - string subscriptionId, int? id = null, string responseFields = null, + string subscriptionId, int? processId = null, string responseFields = null, HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) { SetSdKparameters(); @@ -48,10 +49,10 @@ public static Mozu.Api.Contracts.Event.EventDeliverySummary GetDeliveryAttemptSu var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); var apiClient = Mozu.Api.Clients.Event.Push.Subscriptions.EventDeliverySummaryClient.GetDeliveryAttemptSummaryClient( - subscriptionId : subscriptionId, id : id, responseFields : responseFields ); + subscriptionId : subscriptionId, processId : processId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Event.EventDeliverySummary GetDeliveryAttemptSu } /// - /// Retrieves a collection of data for delivery attempts of events and notifications. These are notifications sent to subscribing sites and tenants. A paged list is returned sorted and filtered per the entered parameters. + /// /// /// /// var result = EventDeliverySummaryFactory.GetDeliveryAttemptSummaries(handler : handler, subscriptionId : subscriptionId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Event.EventDeliverySummaryCollection GetDeliver subscriptionId : subscriptionId, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ExtensionFactory.cs b/Mozu.Api.Test/Factories/ExtensionFactory.cs deleted file mode 100644 index ee718f2b..00000000 --- a/Mozu.Api.Test/Factories/ExtensionFactory.cs +++ /dev/null @@ -1,113 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// platform/extensions related resources. DOCUMENT_HERE - /// - public partial class ExtensionFactory : BaseDataFactory - { - - /// - /// platform-extensions Get GetExtensions description DOCUMENT_HERE - /// - /// - /// var result = ExtensionFactory.GetExtensions(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.InstalledApplications.TenantExtensions GetExtensions(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.TenantExtensionsClient.GetExtensionsClient( - responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// platform-extensions Put UpdateExtensions description DOCUMENT_HERE - /// - /// - /// var result = ExtensionFactory.UpdateExtensions(handler : handler, extensions : extensions, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.InstalledApplications.TenantExtensions UpdateExtensions(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.InstalledApplications.TenantExtensions extensions, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.TenantExtensionsClient.UpdateExtensionsClient( - extensions : extensions, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/ExternalApplicationsFactory.cs b/Mozu.Api.Test/Factories/ExternalApplicationsFactory.cs deleted file mode 100644 index e988edfb..00000000 --- a/Mozu.Api.Test/Factories/ExternalApplicationsFactory.cs +++ /dev/null @@ -1,113 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Applications resource to update and retrieve details about the applications installed for your tenant. - /// - public partial class ExternalApplicationsFactory : BaseDataFactory - { - - /// - /// Retrieves the details of the installed application specified in the request. - /// - /// - /// var result = ExternalApplicationsFactory.GetApplication(handler : handler, appId : appId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.InstalledApplications.Application GetApplication(ServiceClientMessageHandler handler, - string appId, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ExternalApplicationsClient.GetApplicationClient( - appId : appId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Updates one or more properties of the application specified in the request. - /// - /// - /// var result = ExternalApplicationsFactory.UpdateApplication(handler : handler, application : application, appId : appId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.InstalledApplications.Application UpdateApplication(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.InstalledApplications.Application application, string appId, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ExternalApplicationsClient.UpdateApplicationClient( - application : application, appId : appId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/FraudScreenResponseFactory.cs b/Mozu.Api.Test/Factories/FraudScreenResponseFactory.cs deleted file mode 100644 index e498d023..00000000 --- a/Mozu.Api.Test/Factories/FraudScreenResponseFactory.cs +++ /dev/null @@ -1,75 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// - /// - public partial class FraudScreenResponseFactory : BaseDataFactory - { - - /// - /// - /// - /// - /// var result = FraudScreenResponseFactory.Screen(handler : handler, request : request, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.PaymentService.Response.FraudScreenResponse Screen(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.PaymentService.Request.FraudScreenRequest request, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Payments.FraudScreenResponseClient.ScreenClient( - request : request ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/LocationRuntimeFactory.cs b/Mozu.Api.Test/Factories/LocationRuntimeFactory.cs deleted file mode 100644 index bd208cc9..00000000 --- a/Mozu.Api.Test/Factories/LocationRuntimeFactory.cs +++ /dev/null @@ -1,227 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Location resource to retrieve details about a location from a Mozu hosted storefront. - /// - public partial class LocationRuntimeFactory : BaseDataFactory - { - - /// - /// Retrieves the details of the location specified in the request. - /// - /// - /// var result = LocationRuntimeFactory.GetLocation(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.Location GetLocation(ServiceClientMessageHandler handler, - string code, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetLocationClient( - code : code, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves a list of the locations configured for a specified location usage type for the specified site, according to any defined filter or sort criteria. - /// - /// - /// var result = LocationRuntimeFactory.GetLocationsInUsageType(handler : handler, locationUsageType : locationUsageType, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.LocationCollection GetLocationsInUsageType(ServiceClientMessageHandler handler, - string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetLocationsInUsageTypeClient( - locationUsageType : locationUsageType, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the details of the location configured for the direct shipping (DS) location usage type for the site specified in the request. This location acts as an origin address from which order packages will ship, as well as the location where product reservations are created when order items are submitted with the direct ship fulfillment type (DS). If the direct ship location usage type is not configured for this site, the operation returns an error. - /// - /// - /// var result = LocationRuntimeFactory.GetDirectShipLocation(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.Location GetDirectShipLocation(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetDirectShipLocationClient( - responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the details of the location configured for the in-store pickup (SP) location usage type for the site specified in the request. If the location is not associated with a location type configured for the in-store pickup location usage type (SP), the operation returns an error. - /// - /// - /// var result = LocationRuntimeFactory.GetInStorePickupLocation(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.Location GetInStorePickupLocation(ServiceClientMessageHandler handler, - string code, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationClient( - code : code, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves a list of locations valid for in-store pickup of an item in an order according to any filter and sort criteria. For example, an application could use this operation to provide a store finder feature based on the shopper's GPS coordinates. If the location types for the in-store pickup location usage type are not configured for the site, this operation returns an error. - /// - /// - /// var result = LocationRuntimeFactory.GetInStorePickupLocations(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.LocationCollection GetInStorePickupLocations(ServiceClientMessageHandler handler, - int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationsClient( - startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/LocationSettingFactory.cs b/Mozu.Api.Test/Factories/LocationSettingFactory.cs deleted file mode 100644 index cbd87bf4..00000000 --- a/Mozu.Api.Test/Factories/LocationSettingFactory.cs +++ /dev/null @@ -1,151 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Location Usages resource to define the locations and location types that interact with the specified site. The system creates three default location usage types for each site after provisioning a new tenant - one for direct ship (DS), one for in-store pickup (SP), and one for store finder (storeFinder). Each site can only use a single location for the direct ship location usage type, and the location must support the direct ship fulfillment type (DS). For the in-store pickup location usage type, each site can use one or more location types. The location service identifies all locations of the specified type that support the in-store pickup fulfillment type (SP). For the store finder location usage type, each site can use one or more location types. The location service identifies all locations of the type. Locations configured for the store finder type do not typically maintain inventory. You cannot create additional location usage types at this time. - /// - public partial class LocationSettingFactory : BaseDataFactory - { - - /// - /// Retrieves the configured site location usages for the location usage code specified in the request. - /// - /// - /// var result = LocationSettingFactory.GetLocationUsages(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.LocationUsageCollection GetLocationUsages(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.LocationUsageClient.GetLocationUsagesClient( - responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the location usages for the site specified in the request header. - /// - /// - /// var result = LocationSettingFactory.GetLocationUsage(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.LocationUsage GetLocationUsage(ServiceClientMessageHandler handler, - string code, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.LocationUsageClient.GetLocationUsageClient( - code : code, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Updates the location usage for the site based on the location usage code specified in the request. - /// - /// - /// var result = LocationSettingFactory.UpdateLocationUsage(handler : handler, usage : usage, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.LocationUsage UpdateLocationUsage(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.Location.LocationUsage usage, string code, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.LocationUsageClient.UpdateLocationUsageClient( - usage : usage, code : code, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/LocationSettingsFactory.cs b/Mozu.Api.Test/Factories/LocationSettingsFactory.cs deleted file mode 100644 index 9fd54619..00000000 --- a/Mozu.Api.Test/Factories/LocationSettingsFactory.cs +++ /dev/null @@ -1,151 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Location Usages resource to define the locations and location types that interact with the specified site. The system creates three default location usage types for each site after provisioning a new tenant - one for direct ship (DS), one for in-store pickup (SP), and one for store finder (storeFinder). Each site can only use a single location for the direct ship location usage type, and the location must support the direct ship fulfillment type (DS). For the in-store pickup location usage type, each site can use one or more location types. The location service identifies all locations of the specified type that support the in-store pickup fulfillment type (SP). For the store finder location usage type, each site can use one or more location types. The location service identifies all locations of the type. Locations configured for the store finder type do not typically maintain inventory. You cannot create additional location usage types at this time. - /// - public partial class LocationSettingsFactory : BaseDataFactory - { - - /// - /// Retrieves the configured site location usages for the location usage code specified in the request. - /// - /// - /// var result = LocationSettingsFactory.GetLocationUsages(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.LocationUsageCollection GetLocationUsages(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.LocationSettingsClient.GetLocationUsagesClient( - responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the location usages for the site specified in the request header. - /// - /// - /// var result = LocationSettingsFactory.GetLocationUsage(handler : handler, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.LocationUsage GetLocationUsage(ServiceClientMessageHandler handler, - string code, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.LocationSettingsClient.GetLocationUsageClient( - code : code, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Updates the location usage for the site based on the location usage code specified in the request. - /// - /// - /// var result = LocationSettingsFactory.UpdateLocationUsage(handler : handler, usage : usage, code : code, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Location.LocationUsage UpdateLocationUsage(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.Location.LocationUsage usage, string code, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.LocationSettingsClient.UpdateLocationUsageClient( - usage : usage, code : code, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/AdminUserFactory.cs b/Mozu.Api.Test/Factories/Platform/Adminuser/AdminUserFactory.cs old mode 100644 new mode 100755 similarity index 88% rename from Mozu.Api.Test/Factories/AdminUserFactory.cs rename to Mozu.Api.Test/Factories/Platform/Adminuser/AdminUserFactory.cs index 2b95ca0b..4733628f --- a/Mozu.Api.Test/Factories/AdminUserFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/Adminuser/AdminUserFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform.Adminuser { /// - /// The Accounts resource displays the user accounts and account details associated with a developer or tenant administrator. Email addresses uniquely identify admin user accounts. + /// Displays the user accounts and account details associated with a developer or Mozu tenant administrator. Email addresses uniquely identify admin user accounts. /// public partial class AdminUserFactory : BaseDataFactory { /// - /// Retrieves a list of the tenants or development stores for which the specified user has an assigned role. + /// /// /// /// var result = AdminUserFactory.GetTenantScopesForUser(handler : handler, userId : userId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Tenant.TenantCollection GetTenantScopesForUser( userId : userId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Tenant.TenantCollection GetTenantScopesForUser( } /// - /// Retrieves the details of the specified administrator user account. + /// /// /// /// var result = AdminUserFactory.GetUser(handler : handler, userId : userId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Core.User GetUser(ServiceClientMessageHandler h userId : userId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/TenantAdminUserAuthTicketFactory.cs b/Mozu.Api.Test/Factories/Platform/Adminuser/TenantAdminUserAuthTicketFactory.cs old mode 100644 new mode 100755 similarity index 89% rename from Mozu.Api.Test/Factories/TenantAdminUserAuthTicketFactory.cs rename to Mozu.Api.Test/Factories/Platform/Adminuser/TenantAdminUserAuthTicketFactory.cs index 62143794..2a0e01b6 --- a/Mozu.Api.Test/Factories/TenantAdminUserAuthTicketFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/Adminuser/TenantAdminUserAuthTicketFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform.Adminuser { /// - /// Use the Admin User authentication tickets resource to generate and refresh authentication tickets that enable administrator or developer account users to access development or production tenants. + /// Use the Admin User authentication tickets resource to generate and refresh authentication tickets that enable Mozu administrator or developer account users to access development or production tenants. /// public partial class TenantAdminUserAuthTicketFactory : BaseDataFactory { /// - /// Creates an authentication ticket for the supplied user to specify in API requests associated with the supplied tenant. + /// /// /// /// var result = TenantAdminUserAuthTicketFactory.CreateUserAuthTicket(handler : handler, userAuthInfo : userAuthInfo, tenantId : tenantId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket CreateUserA userAuthInfo : userAuthInfo, tenantId : tenantId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket CreateUserA } /// - /// Generates a new user authentication ticket for the specified tenant by supplying the user's existing refresh token information. + /// /// /// /// var result = TenantAdminUserAuthTicketFactory.RefreshAuthTicket(handler : handler, existingAuthTicket : existingAuthTicket, tenantId : tenantId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket RefreshAuth existingAuthTicket : existingAuthTicket, tenantId : tenantId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket RefreshAuth } /// - /// Deletes the authentication ticket for the user by supplying the refresh token. + /// /// /// /// var result = TenantAdminUserAuthTicketFactory.DeleteUserAuthTicket(handler : handler, refreshToken : refreshToken, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static void DeleteUserAuthTicket(ServiceClientMessageHandler handler, refreshToken : refreshToken ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/Platform/Appdev/AppPackageFactory.cs b/Mozu.Api.Test/Factories/Platform/Appdev/AppPackageFactory.cs new file mode 100755 index 00000000..fa7dfc57 --- /dev/null +++ b/Mozu.Api.Test/Factories/Platform/Appdev/AppPackageFactory.cs @@ -0,0 +1,417 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +#region Usings Setup + +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Net; +using Mozu.Api; +using Mozu.Api.Security; +using Mozu.Api.Test.Helpers; +using System.Diagnostics; +using Newtonsoft.Json.Linq; +using System.Threading; + +#endregion + +namespace Mozu.Api.Test.Factories.Platform.Appdev +{ + /// + /// + /// + public partial class AppPackageFactory : BaseDataFactory + { + + /// + /// + /// + /// + /// var result = AppPackageFactory.GetAllPackages(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.AppDev.PackageSummaryCollection GetAllPackages(ServiceClientMessageHandler handler, + int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetAllPackagesClient( + startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AppPackageFactory.GetPackage(handler : handler, applicationKey : applicationKey, includeChildren : includeChildren, skipDevAccountCheck : skipDevAccountCheck, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.AppDev.Package GetPackage(ServiceClientMessageHandler handler, + string applicationKey, bool? includeChildren = null, bool? skipDevAccountCheck = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetPackageClient( + applicationKey : applicationKey, includeChildren : includeChildren, skipDevAccountCheck : skipDevAccountCheck, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AppPackageFactory.GetPackages(handler : handler, applicationKey : applicationKey, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.AppDev.PackageCollection GetPackages(ServiceClientMessageHandler handler, + string applicationKey, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetPackagesClient( + applicationKey : applicationKey, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AppPackageFactory.GetApplicationSummaryChildren(handler : handler, appId : appId, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass/>(result); + /// return optionalCasting; + /// + /// + /// + public static List GetApplicationSummaryChildren(ServiceClientMessageHandler handler, + string appId, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetApplicationSummaryChildrenClient( + appId : appId ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AppPackageFactory.GetApplicationSummaryParents(handler : handler, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.AppDev.ApplicationSummaryCollection GetApplicationSummaryParents(ServiceClientMessageHandler handler, + int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetApplicationSummaryParentsClient( + startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, filter : filter, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AppPackageFactory.ClonePackage(handler : handler, applicationKey : applicationKey, packageName : packageName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.AppDev.Package ClonePackage(ServiceClientMessageHandler handler, + string applicationKey, string packageName, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.ClonePackageClient( + applicationKey : applicationKey, packageName : packageName, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AppPackageFactory.CreateNewCorePackage(handler : handler, packageRequest : packageRequest, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.AppDev.Package CreateNewCorePackage(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.AppDev.PackageRequest packageRequest, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.CreateNewCorePackageClient( + packageRequest : packageRequest, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AppPackageFactory.CreatePackage(handler : handler, pkg : pkg, projectId : projectId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.AppDev.Package CreatePackage(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.AppDev.Package pkg, int? projectId = null, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.CreatePackageClient( + pkg : pkg, projectId : projectId, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AppPackageFactory.UpdatePackage(handler : handler, pkg : pkg, applicationKey : applicationKey, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static Mozu.Api.Contracts.AppDev.Package UpdatePackage(ServiceClientMessageHandler handler, + Mozu.Api.Contracts.AppDev.Package pkg, string applicationKey, string responseFields = null, + HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.UpdatePackageClient( + pkg : pkg, applicationKey : applicationKey, responseFields : responseFields ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + return null; + } + return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + /// + /// + /// + /// + /// var result = AppPackageFactory.DeletePackage(handler : handler, applicationKey : applicationKey, expectedCode: expectedCode, successCode: successCode); + /// var optionalCasting = ConvertClass(result); + /// return optionalCasting; + /// + /// + /// + public static void DeletePackage(ServiceClientMessageHandler handler, + string applicationKey, + HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) + { + SetSdKparameters(); + var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; + var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; + Debug.WriteLine(currentMethodName + '.' + currentMethodName ); + var apiClient = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.DeletePackageClient( + applicationKey : applicationKey ); + try + { + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); + } + catch (ApiException ex) + { + // Custom error handling for test cases can be placed here + Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); + if (customException != null) + throw customException; + } + var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) + ? (apiClient.Result()) + : null; + + } + + + } + +} + + diff --git a/Mozu.Api.Test/Factories/PackageFactory.cs b/Mozu.Api.Test/Factories/Platform/Appdev/PackageFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/PackageFactory.cs rename to Mozu.Api.Test/Factories/Platform/Appdev/PackageFactory.cs index c13f4e17..fba31104 --- a/Mozu.Api.Test/Factories/PackageFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/Appdev/PackageFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform.Appdev { /// - /// This resource is not public. + /// /// public partial class PackageFactory : BaseDataFactory { /// - /// This operation is not public. + /// /// /// /// var result = PackageFactory.GetFile(handler : handler, applicationKey : applicationKey, fileName : fileName, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static System.IO.Stream GetFile(ServiceClientMessageHandler handler, applicationKey : applicationKey, fileName : fileName ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ApplicationFactory.cs b/Mozu.Api.Test/Factories/Platform/ApplicationFactory.cs old mode 100644 new mode 100755 similarity index 92% rename from Mozu.Api.Test/Factories/ApplicationFactory.cs rename to Mozu.Api.Test/Factories/Platform/ApplicationFactory.cs index 2c23e525..386f29a9 --- a/Mozu.Api.Test/Factories/ApplicationFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/ApplicationFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// - /// Use the Developer resource to view and update information and files related to application packages. + /// /// public partial class ApplicationFactory : BaseDataFactory { /// - /// Returns a collection of package names for the application specified in the request. + /// /// /// /// var result = ApplicationFactory.GetAppPackageNames(handler : handler, applicationKey : applicationKey, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.AppDev.PackageNamesCollection GetAppPackageName applicationKey : applicationKey, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.AppDev.PackageNamesCollection GetAppPackageName } /// - /// Retrieves the available versions for the application specified in the request. + /// /// /// /// var result = ApplicationFactory.GetAppVersions(handler : handler, nsAndAppId : nsAndAppId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.AppDev.ApplicationVersionsCollection GetAppVers nsAndAppId : nsAndAppId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.AppDev.ApplicationVersionsCollection GetAppVers } /// - /// Retrieves the metadata for a file in an application package. + /// /// /// /// var result = ApplicationFactory.GetPackageFileMetadata(handler : handler, applicationKey : applicationKey, filepath : filepath, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.AppDev.FileMetadata GetPackageFileMetadata(Serv applicationKey : applicationKey, filepath : filepath, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.AppDev.FileMetadata GetPackageFileMetadata(Serv } /// - /// Retrieves the metadata for a folder in an application package. + /// /// /// /// var result = ApplicationFactory.GetPackageMetadata(handler : handler, applicationKey : applicationKey, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.AppDev.FolderMetadata GetPackageMetadata(Servic applicationKey : applicationKey, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.AppDev.FolderMetadata GetPackageMetadata(Servic } /// - /// Insert or update the specified file into the specified application package. + /// /// /// /// var result = ApplicationFactory.UpsertPackageFile(handler : handler, stream : stream, applicationKey : applicationKey, filepath : filepath, lastModifiedTime : lastModifiedTime, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.AppDev.FileMetadata UpsertPackageFile(ServiceCl stream : stream, applicationKey : applicationKey, filepath : filepath, lastModifiedTime : lastModifiedTime, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.AppDev.FileMetadata UpsertPackageFile(ServiceCl } /// - /// Renames a file in an application package. + /// /// /// /// var result = ApplicationFactory.RenamePackageFile(handler : handler, renameInfo : renameInfo, applicationKey : applicationKey, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.AppDev.FileMetadata RenamePackageFile(ServiceCl renameInfo : renameInfo, applicationKey : applicationKey, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.AppDev.FileMetadata RenamePackageFile(ServiceCl } /// - /// Deletes the specified file from the specified application package. + /// /// /// /// var result = ApplicationFactory.DeletePackageFile(handler : handler, applicationKey : applicationKey, filepath : filepath, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static void DeletePackageFile(ServiceClientMessageHandler handler, applicationKey : applicationKey, filepath : filepath ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/AuthTicketFactory.cs b/Mozu.Api.Test/Factories/Platform/Applications/AuthTicketFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/AuthTicketFactory.cs rename to Mozu.Api.Test/Factories/Platform/Applications/AuthTicketFactory.cs index 23744f5c..cdc7b6e7 --- a/Mozu.Api.Test/Factories/AuthTicketFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/Applications/AuthTicketFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform.Applications { /// - /// Use the Authetickets for applications resource to manage authentication tickets for your apps. + /// Use this resource to manage authentication tickets for your applications. /// public partial class AuthTicketFactory : BaseDataFactory { /// - /// Generate an authentication ticket for an application. + /// /// /// /// var result = AuthTicketFactory.AuthenticateApp(handler : handler, appAuthInfo : appAuthInfo, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.AppDev.AuthTicket AuthenticateApp(ServiceClient appAuthInfo : appAuthInfo, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.AppDev.AuthTicket AuthenticateApp(ServiceClient } /// - /// Refreshes the application's authentication ticket and generates a new access token by providing the refresh token string. + /// /// /// /// var result = AuthTicketFactory.RefreshAppAuthTicket(handler : handler, authTicketRequest : authTicketRequest, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.AppDev.AuthTicket RefreshAppAuthTicket(ServiceC authTicketRequest : authTicketRequest, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.AppDev.AuthTicket RefreshAppAuthTicket(ServiceC } /// - /// Deletes an authentication for an application based on the specified refresh token. + /// /// /// /// var result = AuthTicketFactory.DeleteAppAuthTicket(handler : handler, refreshToken : refreshToken, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static void DeleteAppAuthTicket(ServiceClientMessageHandler handler, refreshToken : refreshToken ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/DeveloperAdminUserAuthTicketFactory.cs b/Mozu.Api.Test/Factories/Platform/Developer/DeveloperAdminUserAuthTicketFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/DeveloperAdminUserAuthTicketFactory.cs rename to Mozu.Api.Test/Factories/Platform/Developer/DeveloperAdminUserAuthTicketFactory.cs index 56675c2c..7419ee36 --- a/Mozu.Api.Test/Factories/DeveloperAdminUserAuthTicketFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/Developer/DeveloperAdminUserAuthTicketFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform.Developer { /// - /// Use the Authtickets resource to manage authentication tickets for your developer account. + /// Use this resource to manage authentication tickets for your developer account. /// public partial class DeveloperAdminUserAuthTicketFactory : BaseDataFactory { /// - /// Generate an authentication ticket for a developer account. + /// /// /// /// var result = DeveloperAdminUserAuthTicketFactory.CreateDeveloperUserAuthTicket(handler : handler, userAuthInfo : userAuthInfo, developerAccountId : developerAccountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket CreateDe userAuthInfo : userAuthInfo, developerAccountId : developerAccountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket CreateDe } /// - /// Generates a new developer account authentication ticket for the specified tenant by supplying the defined refresh token information. + /// /// /// /// var result = DeveloperAdminUserAuthTicketFactory.RefreshDeveloperAuthTicket(handler : handler, existingAuthTicket : existingAuthTicket, developerAccountId : developerAccountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket RefreshD existingAuthTicket : existingAuthTicket, developerAccountId : developerAccountId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket RefreshD } /// - /// Deletes the authentication ticket for the developer account by supplying the refresh token. + /// /// /// /// var result = DeveloperAdminUserAuthTicketFactory.DeleteUserAuthTicket(handler : handler, refreshToken : refreshToken, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static void DeleteUserAuthTicket(ServiceClientMessageHandler handler, refreshToken : refreshToken ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/EntityListFactory.cs b/Mozu.Api.Test/Factories/Platform/EntityListFactory.cs old mode 100644 new mode 100755 similarity index 89% rename from Mozu.Api.Test/Factories/EntityListFactory.cs rename to Mozu.Api.Test/Factories/Platform/EntityListFactory.cs index 867be955..1555aa21 --- a/Mozu.Api.Test/Factories/EntityListFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/EntityListFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// - /// The Entity Lists resource manages all dynamic entities in your document store of the cloud. The content is JSON and can have up to five indexed properties (integer, decimal, string, date, and boolean) with support for additional customized elements as needed. Every document in the entity list has a validated unique ID. + /// /// public partial class EntityListFactory : BaseDataFactory { /// - /// Get a filtered list of EntityLists for a specific tenant. + /// /// /// /// var result = EntityListFactory.GetEntityLists(handler : handler, pageSize : pageSize, startIndex : startIndex, filter : filter, sortBy : sortBy, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.MZDB.EntityListCollection GetEntityLists(Servic pageSize : pageSize, startIndex : startIndex, filter : filter, sortBy : sortBy, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.MZDB.EntityListCollection GetEntityLists(Servic } /// - /// Get an existing EntityList definition for a specific tenant + /// /// /// /// var result = EntityListFactory.GetEntityList(handler : handler, entityListFullName : entityListFullName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.MZDB.EntityList GetEntityList(ServiceClientMess entityListFullName : entityListFullName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.MZDB.EntityList GetEntityList(ServiceClientMess } /// - /// Create a new EntityList for a specific tenant. + /// /// /// /// var result = EntityListFactory.CreateEntityList(handler : handler, entityList : entityList, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.MZDB.EntityList CreateEntityList(ServiceClientM entityList : entityList, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.MZDB.EntityList CreateEntityList(ServiceClientM } /// - /// Update an existing Entitylist for a specific tenant. + /// /// /// /// var result = EntityListFactory.UpdateEntityList(handler : handler, entityList : entityList, entityListFullName : entityListFullName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.MZDB.EntityList UpdateEntityList(ServiceClientM entityList : entityList, entityListFullName : entityListFullName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.MZDB.EntityList UpdateEntityList(ServiceClientM } /// - /// Delete an existing EntityList for a specific tenant. This will also delete all Entities in all instances of this EntityList for the tenant. + /// /// /// /// var result = EntityListFactory.DeleteEntityList(handler : handler, entityListFullName : entityListFullName, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteEntityList(ServiceClientMessageHandler handler, entityListFullName : entityListFullName ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/EntityContainerFactory.cs b/Mozu.Api.Test/Factories/Platform/Entitylists/EntityContainerFactory.cs old mode 100644 new mode 100755 similarity index 88% rename from Mozu.Api.Test/Factories/EntityContainerFactory.cs rename to Mozu.Api.Test/Factories/Platform/Entitylists/EntityContainerFactory.cs index a6e59fe5..268b5aec --- a/Mozu.Api.Test/Factories/EntityContainerFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/Entitylists/EntityContainerFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform.Entitylists { /// - /// Entity containers provide all properties and data for entities within a site/tenant. This data encapsulates all associated IDs including entity lists, entity views, site, tenant, entities, and more. + /// /// public partial class EntityContainerFactory : BaseDataFactory { /// - /// Retrieves an entity container, providing all schema and rules and associated IDs for entities. + /// /// /// /// var result = EntityContainerFactory.GetEntityContainer(handler : handler, entityListFullName : entityListFullName, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.MZDB.EntityContainer GetEntityContainer(Service entityListFullName : entityListFullName, id : id, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.MZDB.EntityContainer GetEntityContainer(Service } /// - /// Retrieves a collection of entity containers. Each container holds a set of entities per ID. + /// /// /// /// var result = EntityContainerFactory.GetEntityContainers(handler : handler, entityListFullName : entityListFullName, pageSize : pageSize, startIndex : startIndex, filter : filter, sortBy : sortBy, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.MZDB.EntityContainerCollection GetEntityContain entityListFullName : entityListFullName, pageSize : pageSize, startIndex : startIndex, filter : filter, sortBy : sortBy, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/EntityFactory.cs b/Mozu.Api.Test/Factories/Platform/Entitylists/EntityFactory.cs old mode 100644 new mode 100755 similarity index 87% rename from Mozu.Api.Test/Factories/EntityFactory.cs rename to Mozu.Api.Test/Factories/Platform/Entitylists/EntityFactory.cs index 4b7e614f..acdf1379 --- a/Mozu.Api.Test/Factories/EntityFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/Entitylists/EntityFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform.Entitylists { /// - /// Entities are JSON entries within the MZDB ( Mongo DB) for handling large data sets to heavily filter (>2,000 items). Each entity is associated to an EntityList with schema, rules, and formatting for storing the content. This content can be accessed via the API and Hypr tags. + /// /// public partial class EntityFactory : BaseDataFactory { /// - /// Retrieves an entity with an associated entity list and context level at tenant, master catalog, catalog, or site. + /// /// /// /// var result = EntityFactory.GetEntity(handler : handler, entityListFullName : entityListFullName, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static JObject GetEntity(ServiceClientMessageHandler handler, entityListFullName : entityListFullName, id : id, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static JObject GetEntity(ServiceClientMessageHandler handler, } /// - /// Retrieves a collection of entities with an associated entity list and context level at tenant, master catalog, catalog, or site. + /// /// /// /// var result = EntityFactory.GetEntities(handler : handler, entityListFullName : entityListFullName, pageSize : pageSize, startIndex : startIndex, filter : filter, sortBy : sortBy, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.MZDB.EntityCollection GetEntities(ServiceClient entityListFullName : entityListFullName, pageSize : pageSize, startIndex : startIndex, filter : filter, sortBy : sortBy, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.MZDB.EntityCollection GetEntities(ServiceClient } /// - /// Inserts a new entity per the entered item, the entity list full name, and associated response fields. + /// /// /// /// var result = EntityFactory.InsertEntity(handler : handler, item : item, entityListFullName : entityListFullName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static JObject InsertEntity(ServiceClientMessageHandler handler, item : item, entityListFullName : entityListFullName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static JObject InsertEntity(ServiceClientMessageHandler handler, } /// - /// Updates the content and associations for an existing entity. + /// /// /// /// var result = EntityFactory.UpdateEntity(handler : handler, item : item, entityListFullName : entityListFullName, id : id, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static JObject UpdateEntity(ServiceClientMessageHandler handler, item : item, entityListFullName : entityListFullName, id : id, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static JObject UpdateEntity(ServiceClientMessageHandler handler, } /// - /// Deletes an entity depending on the context of tenant, master catalog, catalog, or site level. Entities are associated to an entity list (schema and formatting) for displaying within a namespace and context level. + /// /// /// /// var result = EntityFactory.DeleteEntity(handler : handler, entityListFullName : entityListFullName, id : id, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static void DeleteEntity(ServiceClientMessageHandler handler, entityListFullName : entityListFullName, id : id ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ListViewFactory.cs b/Mozu.Api.Test/Factories/Platform/Entitylists/ListViewFactory.cs old mode 100644 new mode 100755 similarity index 89% rename from Mozu.Api.Test/Factories/ListViewFactory.cs rename to Mozu.Api.Test/Factories/Platform/Entitylists/ListViewFactory.cs index 3059e4a8..b7a5fcc6 --- a/Mozu.Api.Test/Factories/ListViewFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/Entitylists/ListViewFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform.Entitylists { /// - /// Provides settings and options for displaying associated content within a context level of site, tenant, catalog, or master catalog. ListViews can be associated with entity lists and entities. + /// /// public partial class ListViewFactory : BaseDataFactory { /// - /// Retrieves a view for associated entities. A view provides display context levels (site, tenant, catalog, master catalog) and settings. + /// /// /// /// var result = ListViewFactory.GetViewEntity(handler : handler, entityListFullName : entityListFullName, viewName : viewName, entityId : entityId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static JObject GetViewEntity(ServiceClientMessageHandler handler, entityListFullName : entityListFullName, viewName : viewName, entityId : entityId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static JObject GetViewEntity(ServiceClientMessageHandler handler, } /// - /// Retrieves a collection of views for associated entities. Each view provides display context levels (site, tenant, catalog, master catalog) and settings. + /// /// /// /// var result = ListViewFactory.GetViewEntities(handler : handler, entityListFullName : entityListFullName, viewName : viewName, pageSize : pageSize, startIndex : startIndex, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.MZDB.EntityCollection GetViewEntities(ServiceCl entityListFullName : entityListFullName, viewName : viewName, pageSize : pageSize, startIndex : startIndex, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.MZDB.EntityCollection GetViewEntities(ServiceCl } /// - /// Retrieves a collection of container data for creating and displaying a view of entities. + /// /// /// /// var result = ListViewFactory.GetViewEntityContainer(handler : handler, entityListFullName : entityListFullName, viewName : viewName, entityId : entityId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.MZDB.EntityContainer GetViewEntityContainer(Ser entityListFullName : entityListFullName, viewName : viewName, entityId : entityId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.MZDB.EntityContainer GetViewEntityContainer(Ser } /// - /// Retrieves a collection of container data for creating and displaying a view of entities. + /// /// /// /// var result = ListViewFactory.GetViewEntityContainers(handler : handler, entityListFullName : entityListFullName, viewName : viewName, pageSize : pageSize, startIndex : startIndex, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.MZDB.EntityContainerCollection GetViewEntityCon entityListFullName : entityListFullName, viewName : viewName, pageSize : pageSize, startIndex : startIndex, filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.MZDB.EntityContainerCollection GetViewEntityCon } /// - /// Retrieves a specific `EntityListView`. These views provide schema, rules, and formatting for all associated entities. + /// /// /// /// var result = ListViewFactory.GetEntityListView(handler : handler, entityListFullName : entityListFullName, viewName : viewName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.MZDB.ListView GetEntityListView(ServiceClientMe entityListFullName : entityListFullName, viewName : viewName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.MZDB.ListView GetEntityListView(ServiceClientMe } /// - /// Retrieves a collection of `EntityListViews`. These views provide schema, rules, and formatting for all associated entities. + /// /// /// /// var result = ListViewFactory.GetEntityListViews(handler : handler, entityListFullName : entityListFullName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.MZDB.ListViewCollection GetEntityListViews(Serv entityListFullName : entityListFullName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.MZDB.ListViewCollection GetEntityListViews(Serv } /// - /// Creates an entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities. + /// /// /// /// var result = ListViewFactory.CreateEntityListView(handler : handler, listView : listView, entityListFullName : entityListFullName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.MZDB.ListView CreateEntityListView(ServiceClien listView : listView, entityListFullName : entityListFullName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.MZDB.ListView CreateEntityListView(ServiceClien } /// - /// Updates an existing entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities. + /// /// /// /// var result = ListViewFactory.UpdateEntityListView(handler : handler, listView : listView, entityListFullName : entityListFullName, viewName : viewName, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.MZDB.ListView UpdateEntityListView(ServiceClien listView : listView, entityListFullName : entityListFullName, viewName : viewName, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.MZDB.ListView UpdateEntityListView(ServiceClien } /// - /// Deletes an entity list view. Any associated entities have the association removed. + /// /// /// /// var result = ListViewFactory.DeleteEntityListView(handler : handler, entityListFullName : entityListFullName, viewName : viewName, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static void DeleteEntityListView(ServiceClientMessageHandler handler, entityListFullName : entityListFullName, viewName : viewName ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/CredentialStoreEntryFactory.cs b/Mozu.Api.Test/Factories/Platform/Extensions/CredentialStoreEntryFactory.cs old mode 100644 new mode 100755 similarity index 75% rename from Mozu.Api.Test/Factories/CredentialStoreEntryFactory.cs rename to Mozu.Api.Test/Factories/Platform/Extensions/CredentialStoreEntryFactory.cs index 4ae88b40..ba60a2f2 --- a/Mozu.Api.Test/Factories/CredentialStoreEntryFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/Extensions/CredentialStoreEntryFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform.Extensions { /// - /// The CredentialStore resource allows you to encrypt and store sensitive data on your tenant. You can then decrypt and access that data using an Arc.js application, as described in the Arc.js [Programming Patterns](https://www.mozu.com/docs/developer/arcjs-guides/programming-patterns.htm#securely_store_and_access_sensitive_data) topic. + /// /// public partial class CredentialStoreEntryFactory : BaseDataFactory { /// - /// Encrypts and stores data contained in the JSON object. You can decrypt and access the secured data using an Arc.js application, as described in the Arc.js [Programming Patterns](https://www.mozu.com/docs/developer/arcjs-guides/programming-patterns.htm#securely_store_and_access_sensitive_data) topic. + /// /// /// /// var result = CredentialStoreEntryFactory.StoreCredentials(handler : handler, credentials : credentials, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static void StoreCredentials(ServiceClientMessageHandler handler, credentials : credentials ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ExternalApplicationFactory.cs b/Mozu.Api.Test/Factories/Platform/InstalledApplicationsFactory.cs old mode 100644 new mode 100755 similarity index 77% rename from Mozu.Api.Test/Factories/ExternalApplicationFactory.cs rename to Mozu.Api.Test/Factories/Platform/InstalledApplicationsFactory.cs index c634b97e..6a500277 --- a/Mozu.Api.Test/Factories/ExternalApplicationFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/InstalledApplicationsFactory.cs @@ -18,22 +18,23 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// /// Use the Applications resource to update and retrieve details about the applications installed for your tenant. /// - public partial class ExternalApplicationFactory : BaseDataFactory + public partial class InstalledApplicationsFactory : BaseDataFactory { /// - /// Retrieves the details of the installed application specified in the request. + /// /// /// - /// var result = ExternalApplicationFactory.GetApplication(handler : handler, appId : appId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = InstalledApplicationsFactory.GetApplication(handler : handler, appId : appId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// @@ -47,11 +48,11 @@ public static Mozu.Api.Contracts.InstalledApplications.Application GetApplicatio var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ExternalApplicationClient.GetApplicationClient( + var apiClient = Mozu.Api.Clients.Platform.InstalledApplicationsClient.GetApplicationClient( appId : appId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,10 +69,10 @@ public static Mozu.Api.Contracts.InstalledApplications.Application GetApplicatio } /// - /// Updates one or more properties of the application specified in the request. + /// /// /// - /// var result = ExternalApplicationFactory.UpdateApplication(handler : handler, application : application, appId : appId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); + /// var result = InstalledApplicationsFactory.UpdateApplication(handler : handler, application : application, appId : appId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); /// var optionalCasting = ConvertClass(result); /// return optionalCasting; /// @@ -85,11 +86,11 @@ public static Mozu.Api.Contracts.InstalledApplications.Application UpdateApplica var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ExternalApplicationClient.UpdateApplicationClient( + var apiClient = Mozu.Api.Clients.Platform.InstalledApplicationsClient.UpdateApplicationClient( application : application, appId : appId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/ReferenceDataFactory.cs b/Mozu.Api.Test/Factories/Platform/ReferenceDataFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/ReferenceDataFactory.cs rename to Mozu.Api.Test/Factories/Platform/ReferenceDataFactory.cs index 376d8e9c..329ca239 --- a/Mozu.Api.Test/Factories/ReferenceDataFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/ReferenceDataFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// - /// The Reference resource retrieves collections of standards the system currently supports. This includes content locales, top-level domains, units of measure, countries, currencies, time zones, and shipping or billing address schemas. + /// The Reference resource retrieves collections of standards the Mozu system currently supports. This includes content locales, top-level domains, units of measure, countries, currencies, time zones, and shipping or billing address schemas. /// public partial class ReferenceDataFactory : BaseDataFactory { /// - /// Retrieves a specific address schema based on the country code provided. This operation allows the creation of custom shipping and billing address fields. + /// /// /// /// var result = ReferenceDataFactory.GetAddressSchema(handler : handler, countryCode : countryCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Reference.AddressSchema GetAddressSchema(Servic countryCode : countryCode, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.Reference.AddressSchema GetAddressSchema(Servic } /// - /// Retrieves the entire list of address schemas that the system supports. + /// /// /// /// var result = ReferenceDataFactory.GetAddressSchemas(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.Reference.AddressSchemaCollection GetAddressSch responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -106,7 +107,7 @@ public static Mozu.Api.Contracts.Reference.AddressSchemaCollection GetAddressSch } /// - /// Retrieves the details of a behavior based on the behavior ID specified in the request. + /// /// /// /// var result = ReferenceDataFactory.GetBehavior(handler : handler, behaviorId : behaviorId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -127,7 +128,7 @@ public static Mozu.Api.Contracts.Core.Behavior GetBehavior(ServiceClientMessageH behaviorId : behaviorId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -144,7 +145,7 @@ public static Mozu.Api.Contracts.Core.Behavior GetBehavior(ServiceClientMessageH } /// - /// Retrieves the details of the behavior category specified in the request. + /// /// /// /// var result = ReferenceDataFactory.GetBehaviorCategory(handler : handler, categoryId : categoryId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -165,7 +166,7 @@ public static Mozu.Api.Contracts.Core.BehaviorCategory GetBehaviorCategory(Servi categoryId : categoryId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -182,7 +183,7 @@ public static Mozu.Api.Contracts.Core.BehaviorCategory GetBehaviorCategory(Servi } /// - /// Retrieves the list of behavior categories. + /// /// /// /// var result = ReferenceDataFactory.GetBehaviorCategories(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -203,7 +204,7 @@ public static Mozu.Api.Contracts.Core.BehaviorCategoryCollection GetBehaviorCate responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -220,7 +221,7 @@ public static Mozu.Api.Contracts.Core.BehaviorCategoryCollection GetBehaviorCate } /// - /// Retrieves a list of application behaviors. + /// /// /// /// var result = ReferenceDataFactory.GetBehaviors(handler : handler, userType : userType, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -241,7 +242,7 @@ public static Mozu.Api.Contracts.Core.BehaviorCollection GetBehaviors(ServiceCli userType : userType, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -258,7 +259,7 @@ public static Mozu.Api.Contracts.Core.BehaviorCollection GetBehaviors(ServiceCli } /// - /// Retrieves the list of content locales the system supports. Content locales indicate the language used and the country where the language is used. + /// /// /// /// var result = ReferenceDataFactory.GetContentLocales(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -279,7 +280,7 @@ public static Mozu.Api.Contracts.Reference.ContentLocaleCollection GetContentLoc responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -296,7 +297,7 @@ public static Mozu.Api.Contracts.Reference.ContentLocaleCollection GetContentLoc } /// - /// Retrieves the entire list of countries that the system supports. + /// /// /// /// var result = ReferenceDataFactory.GetCountries(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -317,7 +318,7 @@ public static Mozu.Api.Contracts.Reference.CountryCollection GetCountries(Servic responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -334,7 +335,7 @@ public static Mozu.Api.Contracts.Reference.CountryCollection GetCountries(Servic } /// - /// Retrieves the entire list of countries that the system supports. + /// /// /// /// var result = ReferenceDataFactory.GetCountriesWithStates(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -355,7 +356,7 @@ public static Mozu.Api.Contracts.Reference.CountryWithStatesCollection GetCountr responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -372,7 +373,7 @@ public static Mozu.Api.Contracts.Reference.CountryWithStatesCollection GetCountr } /// - /// Retrieves the entire list of currencies that the system supports. + /// /// /// /// var result = ReferenceDataFactory.GetCurrencies(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -393,7 +394,7 @@ public static Mozu.Api.Contracts.Reference.CurrencyCollection GetCurrencies(Serv responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -410,7 +411,7 @@ public static Mozu.Api.Contracts.Reference.CurrencyCollection GetCurrencies(Serv } /// - /// Retrieves the entire list of time zones that the system supports. + /// /// /// /// var result = ReferenceDataFactory.GetTimeZones(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -431,7 +432,7 @@ public static Mozu.Api.Contracts.Reference.TimeZoneCollection GetTimeZones(Servi responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -448,7 +449,7 @@ public static Mozu.Api.Contracts.Reference.TimeZoneCollection GetTimeZones(Servi } /// - /// Retrieves the entire list of top-level internet domains that the system supports. + /// /// /// /// var result = ReferenceDataFactory.GetTopLevelDomains(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -469,7 +470,7 @@ public static Mozu.Api.Contracts.Reference.TopLevelDomainCollection GetTopLevelD responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -486,7 +487,7 @@ public static Mozu.Api.Contracts.Reference.TopLevelDomainCollection GetTopLevelD } /// - /// Retrieves an array list of all units of measure the system supports. + /// /// /// /// var result = ReferenceDataFactory.GetUnitsOfMeasure(handler : handler, filter : filter, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -507,7 +508,7 @@ public static Mozu.Api.Contracts.Reference.UnitOfMeasureCollection GetUnitsOfMea filter : filter, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/SecureAppDataFactory.cs b/Mozu.Api.Test/Factories/Platform/SecureAppDataFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/SecureAppDataFactory.cs rename to Mozu.Api.Test/Factories/Platform/SecureAppDataFactory.cs index 0ae7bc3a..ee79b96f --- a/Mozu.Api.Test/Factories/SecureAppDataFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/SecureAppDataFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// - /// Manage Secure App Settings. Expose via arc.js so that arc apps can securely access secrets. Third-party extensions can also access their data. Secured via AppKey.AppId + /// /// public partial class SecureAppDataFactory : BaseDataFactory { /// - /// platform-secureappdata Get GetDBValue description DOCUMENT_HERE + /// /// /// /// var result = SecureAppDataFactory.GetDBValue(handler : handler, appKeyId : appKeyId, dbEntryQuery : dbEntryQuery, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static JObject GetDBValue(ServiceClientMessageHandler handler, appKeyId : appKeyId, dbEntryQuery : dbEntryQuery, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static JObject GetDBValue(ServiceClientMessageHandler handler, } /// - /// platform-secureappdata Post CreateDBValue description DOCUMENT_HERE + /// /// /// /// var result = SecureAppDataFactory.CreateDBValue(handler : handler, value : value, appKeyId : appKeyId, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static void CreateDBValue(ServiceClientMessageHandler handler, value : value, appKeyId : appKeyId, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -105,7 +106,7 @@ public static void CreateDBValue(ServiceClientMessageHandler handler, } /// - /// platform-secureappdata Put UpdateDBValue description DOCUMENT_HERE + /// /// /// /// var result = SecureAppDataFactory.UpdateDBValue(handler : handler, value : value, appKeyId : appKeyId, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -126,7 +127,7 @@ public static void UpdateDBValue(ServiceClientMessageHandler handler, value : value, appKeyId : appKeyId, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -142,7 +143,7 @@ public static void UpdateDBValue(ServiceClientMessageHandler handler, } /// - /// platform-secureappdata Delete DeleteDBValue description DOCUMENT_HERE + /// /// /// /// var result = SecureAppDataFactory.DeleteDBValue(handler : handler, appKeyId : appKeyId, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -163,7 +164,7 @@ public static void DeleteDBValue(ServiceClientMessageHandler handler, appKeyId : appKeyId, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/SiteDataFactory.cs b/Mozu.Api.Test/Factories/Platform/SiteDataFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/SiteDataFactory.cs rename to Mozu.Api.Test/Factories/Platform/SiteDataFactory.cs index 086ef261..3306cc7f --- a/Mozu.Api.Test/Factories/SiteDataFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/SiteDataFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// - /// Use the site data resource to store site-level information required for a third-party application in the database. + /// Use the site data resource to store site-level information required for a third-party application in the Mozu database. /// public partial class SiteDataFactory : BaseDataFactory { /// - /// Retrieves the value of a record in the database. + /// /// /// /// var result = SiteDataFactory.GetDBValue(handler : handler, dbEntryQuery : dbEntryQuery, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static string GetDBValue(ServiceClientMessageHandler handler, dbEntryQuery : dbEntryQuery, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static string GetDBValue(ServiceClientMessageHandler handler, } /// - /// Creates a new record in the database based on the information supplied in the request. + /// /// /// /// var result = SiteDataFactory.CreateDBValue(handler : handler, value : value, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static void CreateDBValue(ServiceClientMessageHandler handler, value : value, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -105,7 +106,7 @@ public static void CreateDBValue(ServiceClientMessageHandler handler, } /// - /// Updates a record in the database based on the information supplied in the request. + /// /// /// /// var result = SiteDataFactory.UpdateDBValue(handler : handler, value : value, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -126,7 +127,7 @@ public static void UpdateDBValue(ServiceClientMessageHandler handler, value : value, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -142,7 +143,7 @@ public static void UpdateDBValue(ServiceClientMessageHandler handler, } /// - /// Removes a previously defined record in the database. + /// /// /// /// var result = SiteDataFactory.DeleteDBValue(handler : handler, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -163,7 +164,7 @@ public static void DeleteDBValue(ServiceClientMessageHandler handler, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/TenantDataFactory.cs b/Mozu.Api.Test/Factories/Platform/TenantDataFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/TenantDataFactory.cs rename to Mozu.Api.Test/Factories/Platform/TenantDataFactory.cs index a54ee962..a93a0d12 --- a/Mozu.Api.Test/Factories/TenantDataFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/TenantDataFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// - /// Use the tenant data resource to store tenant-level information required for a third-party application in the database. + /// Use the tenant data resource to store tenant-level information required for a third-party application in the Mozu database. /// public partial class TenantDataFactory : BaseDataFactory { /// - /// Retrieves the value of a record in the database. + /// /// /// /// var result = TenantDataFactory.GetDBValue(handler : handler, dbEntryQuery : dbEntryQuery, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static string GetDBValue(ServiceClientMessageHandler handler, dbEntryQuery : dbEntryQuery, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static string GetDBValue(ServiceClientMessageHandler handler, } /// - /// Creates a new record in the database based on the information supplied in the request. + /// /// /// /// var result = TenantDataFactory.CreateDBValue(handler : handler, value : value, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static void CreateDBValue(ServiceClientMessageHandler handler, value : value, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -105,7 +106,7 @@ public static void CreateDBValue(ServiceClientMessageHandler handler, } /// - /// Updates a record in the database based on the information supplied in the request. + /// /// /// /// var result = TenantDataFactory.UpdateDBValue(handler : handler, value : value, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -126,7 +127,7 @@ public static void UpdateDBValue(ServiceClientMessageHandler handler, value : value, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -142,7 +143,7 @@ public static void UpdateDBValue(ServiceClientMessageHandler handler, } /// - /// Removes a previously defined record in the database. + /// /// /// /// var result = TenantDataFactory.DeleteDBValue(handler : handler, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -163,7 +164,7 @@ public static void DeleteDBValue(ServiceClientMessageHandler handler, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/TenantExtensionsFactory.cs b/Mozu.Api.Test/Factories/Platform/TenantExtensionsFactory.cs old mode 100644 new mode 100755 similarity index 89% rename from Mozu.Api.Test/Factories/TenantExtensionsFactory.cs rename to Mozu.Api.Test/Factories/Platform/TenantExtensionsFactory.cs index fbd6a944..f6260e66 --- a/Mozu.Api.Test/Factories/TenantExtensionsFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/TenantExtensionsFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// - /// Use the Extensions resource to manage Arc.js configuration settings. These are the same settings you can configure through in the Action Management JSON Editor. + /// /// public partial class TenantExtensionsFactory : BaseDataFactory { /// - /// Retrieves the Arc.js configuration settings for a site. + /// /// /// /// var result = TenantExtensionsFactory.GetExtensions(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.InstalledApplications.TenantExtensions GetExten responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static Mozu.Api.Contracts.InstalledApplications.TenantExtensions GetExten } /// - /// Updates the Arc.js configuration settings for a site. + /// /// /// /// var result = TenantExtensionsFactory.UpdateExtensions(handler : handler, extensions : extensions, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static Mozu.Api.Contracts.InstalledApplications.TenantExtensions UpdateEx extensions : extensions, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/TenantFactory.cs b/Mozu.Api.Test/Factories/Platform/TenantFactory.cs old mode 100644 new mode 100755 similarity index 90% rename from Mozu.Api.Test/Factories/TenantFactory.cs rename to Mozu.Api.Test/Factories/Platform/TenantFactory.cs index a9f7b791..d6ec5e5b --- a/Mozu.Api.Test/Factories/TenantFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/TenantFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// - /// Use the tenants resource to manage information about a tenant. + /// Use the tenants resource to manage information about a Mozu tenant. /// public partial class TenantFactory : BaseDataFactory { /// - /// Retrieve details about a specific tenant by providing the tenant ID. + /// /// /// /// var result = TenantFactory.GetTenant(handler : handler, tenantId : tenantId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static Mozu.Api.Contracts.Tenant.Tenant GetTenant(ServiceClientMessageHan tenantId : tenantId, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/UserDataFactory.cs b/Mozu.Api.Test/Factories/Platform/UserDataFactory.cs old mode 100644 new mode 100755 similarity index 91% rename from Mozu.Api.Test/Factories/UserDataFactory.cs rename to Mozu.Api.Test/Factories/Platform/UserDataFactory.cs index 0f83c658..8613c8b6 --- a/Mozu.Api.Test/Factories/UserDataFactory.cs +++ b/Mozu.Api.Test/Factories/Platform/UserDataFactory.cs @@ -18,19 +18,20 @@ using Mozu.Api.Test.Helpers; using System.Diagnostics; using Newtonsoft.Json.Linq; +using System.Threading; #endregion -namespace Mozu.Api.Test.Factories +namespace Mozu.Api.Test.Factories.Platform { /// - /// Use the user data subresource to store user-level data required for a third-party application in the database. + /// Use the user data subresource to store user-level data required for a third-party application in the Mozu database. /// public partial class UserDataFactory : BaseDataFactory { /// - /// Retrieves the value of a record in the database. + /// /// /// /// var result = UserDataFactory.GetDBValue(handler : handler, dbEntryQuery : dbEntryQuery, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); @@ -51,7 +52,7 @@ public static string GetDBValue(ServiceClientMessageHandler handler, dbEntryQuery : dbEntryQuery, responseFields : responseFields ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -68,7 +69,7 @@ public static string GetDBValue(ServiceClientMessageHandler handler, } /// - /// Creates a new record in the database based on the information supplied in the request. + /// /// /// /// var result = UserDataFactory.CreateDBValue(handler : handler, value : value, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -89,7 +90,7 @@ public static void CreateDBValue(ServiceClientMessageHandler handler, value : value, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -105,7 +106,7 @@ public static void CreateDBValue(ServiceClientMessageHandler handler, } /// - /// Updates a record in the database based on the information supplied in the request. + /// /// /// /// var result = UserDataFactory.UpdateDBValue(handler : handler, value : value, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -126,7 +127,7 @@ public static void UpdateDBValue(ServiceClientMessageHandler handler, value : value, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { @@ -142,7 +143,7 @@ public static void UpdateDBValue(ServiceClientMessageHandler handler, } /// - /// Removes a previously defined record in the database. + /// /// /// /// var result = UserDataFactory.DeleteDBValue(handler : handler, dbEntryQuery : dbEntryQuery, expectedCode: expectedCode, successCode: successCode); @@ -163,7 +164,7 @@ public static void DeleteDBValue(ServiceClientMessageHandler handler, dbEntryQuery : dbEntryQuery ); try { - apiClient.WithContext(handler.ApiContext).Execute(); + apiClient.WithContext(handler.ApiContext).ExecuteAsync(default(CancellationToken)).Wait(); } catch (ApiException ex) { diff --git a/Mozu.Api.Test/Factories/PublicAdminAuthTicketFactory.cs b/Mozu.Api.Test/Factories/PublicAdminAuthTicketFactory.cs deleted file mode 100644 index 9d595cb5..00000000 --- a/Mozu.Api.Test/Factories/PublicAdminAuthTicketFactory.cs +++ /dev/null @@ -1,150 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Admin User authentication tickets resource to generate and refresh authentication tickets that enable Mozu administrator or developer account users to access development or production tenants. - /// - public partial class PublicAdminAuthTicketFactory : BaseDataFactory - { - - /// - /// Creates an authentication ticket for the supplied user to specify in API requests associated with the supplied tenant. - /// - /// - /// var result = PublicAdminAuthTicketFactory.CreateUserAuthTicket(handler : handler, userAuthInfo : userAuthInfo, tenantId : tenantId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket CreateUserAuthTicket(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.Core.UserAuthInfo userAuthInfo, int? tenantId = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Adminuser.TenantAdminUserAuthTicketClient.CreateUserAuthTicketClient( - userAuthInfo : userAuthInfo, tenantId : tenantId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Generates a new user authentication ticket for the specified tenant by supplying the user's existing refresh token information. - /// - /// - /// var result = PublicAdminAuthTicketFactory.RefreshAuthTicket(handler : handler, existingAuthTicket : existingAuthTicket, tenantId : tenantId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket RefreshAuthTicket(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket existingAuthTicket, int? tenantId = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Adminuser.TenantAdminUserAuthTicketClient.RefreshAuthTicketClient( - existingAuthTicket : existingAuthTicket, tenantId : tenantId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Deletes the authentication ticket for the user by supplying the refresh token. - /// - /// - /// var result = PublicAdminAuthTicketFactory.DeleteUserAuthTicket(handler : handler, refreshToken : refreshToken, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static void DeleteUserAuthTicket(ServiceClientMessageHandler handler, - string refreshToken, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Adminuser.TenantAdminUserAuthTicketClient.DeleteUserAuthTicketClient( - refreshToken : refreshToken ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/PublicApplicationFactory.cs b/Mozu.Api.Test/Factories/PublicApplicationFactory.cs deleted file mode 100644 index acd5b373..00000000 --- a/Mozu.Api.Test/Factories/PublicApplicationFactory.cs +++ /dev/null @@ -1,302 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// platform/developer related resources. DOCUMENT_HERE - /// - public partial class PublicApplicationFactory : BaseDataFactory - { - - /// - /// platform-developer Get GetAppPackageNames description DOCUMENT_HERE - /// - /// - /// var result = PublicApplicationFactory.GetAppPackageNames(handler : handler, applicationKey : applicationKey, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.PackageNamesCollection GetAppPackageNames(ServiceClientMessageHandler handler, - string applicationKey, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ApplicationClient.GetAppPackageNamesClient( - applicationKey : applicationKey, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// platform-developer Get GetAppVersions description DOCUMENT_HERE - /// - /// - /// var result = PublicApplicationFactory.GetAppVersions(handler : handler, nsAndAppId : nsAndAppId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.ApplicationVersionsCollection GetAppVersions(ServiceClientMessageHandler handler, - string nsAndAppId, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ApplicationClient.GetAppVersionsClient( - nsAndAppId : nsAndAppId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// platform-developer Get GetPackageFileMetadata description DOCUMENT_HERE - /// - /// - /// var result = PublicApplicationFactory.GetPackageFileMetadata(handler : handler, applicationKey : applicationKey, filepath : filepath, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.FileMetadata GetPackageFileMetadata(ServiceClientMessageHandler handler, - string applicationKey, string filepath, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ApplicationClient.GetPackageFileMetadataClient( - applicationKey : applicationKey, filepath : filepath, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// platform-developer Get GetPackageMetadata description DOCUMENT_HERE - /// - /// - /// var result = PublicApplicationFactory.GetPackageMetadata(handler : handler, applicationKey : applicationKey, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.FolderMetadata GetPackageMetadata(ServiceClientMessageHandler handler, - string applicationKey, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ApplicationClient.GetPackageMetadataClient( - applicationKey : applicationKey, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// platform-developer Post UpsertPackageFile description DOCUMENT_HERE - /// - /// - /// var result = PublicApplicationFactory.UpsertPackageFile(handler : handler, stream : stream, applicationKey : applicationKey, filepath : filepath, lastModifiedTime : lastModifiedTime, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.FileMetadata UpsertPackageFile(ServiceClientMessageHandler handler, - System.IO.Stream stream, string applicationKey, string filepath, string lastModifiedTime = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ApplicationClient.UpsertPackageFileClient( - stream : stream, applicationKey : applicationKey, filepath : filepath, lastModifiedTime : lastModifiedTime, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// platform-developer Post RenamePackageFile description DOCUMENT_HERE - /// - /// - /// var result = PublicApplicationFactory.RenamePackageFile(handler : handler, renameInfo : renameInfo, applicationKey : applicationKey, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AppDev.FileMetadata RenamePackageFile(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.AppDev.RenameInfo renameInfo, string applicationKey, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ApplicationClient.RenamePackageFileClient( - renameInfo : renameInfo, applicationKey : applicationKey, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// platform-developer Delete DeletePackageFile description DOCUMENT_HERE - /// - /// - /// var result = PublicApplicationFactory.DeletePackageFile(handler : handler, applicationKey : applicationKey, filepath : filepath, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static void DeletePackageFile(ServiceClientMessageHandler handler, - string applicationKey, string filepath, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.ApplicationClient.DeletePackageFileClient( - applicationKey : applicationKey, filepath : filepath ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/PublicDeveloperAdminAuthTicketFactory.cs b/Mozu.Api.Test/Factories/PublicDeveloperAdminAuthTicketFactory.cs deleted file mode 100644 index d5a003d6..00000000 --- a/Mozu.Api.Test/Factories/PublicDeveloperAdminAuthTicketFactory.cs +++ /dev/null @@ -1,150 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Authtickets resource to manage authentication tickets for your developer account. - /// - public partial class PublicDeveloperAdminAuthTicketFactory : BaseDataFactory - { - - /// - /// Generate an authentication ticket for a developer account. - /// - /// - /// var result = PublicDeveloperAdminAuthTicketFactory.CreateDeveloperUserAuthTicket(handler : handler, userAuthInfo : userAuthInfo, developerAccountId : developerAccountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket CreateDeveloperUserAuthTicket(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.Core.UserAuthInfo userAuthInfo, int? developerAccountId = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.Created, HttpStatusCode successCode = HttpStatusCode.Created) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.DeveloperAdminUserAuthTicketClient.CreateDeveloperUserAuthTicketClient( - userAuthInfo : userAuthInfo, developerAccountId : developerAccountId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Generates a new developer account authentication ticket for the specified tenant by supplying the defined refresh token information. - /// - /// - /// var result = PublicDeveloperAdminAuthTicketFactory.RefreshDeveloperAuthTicket(handler : handler, existingAuthTicket : existingAuthTicket, developerAccountId : developerAccountId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket RefreshDeveloperAuthTicket(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket existingAuthTicket, int? developerAccountId = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.DeveloperAdminUserAuthTicketClient.RefreshDeveloperAuthTicketClient( - existingAuthTicket : existingAuthTicket, developerAccountId : developerAccountId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Deletes the authentication ticket for the developer account by supplying the refresh token. - /// - /// - /// var result = PublicDeveloperAdminAuthTicketFactory.DeleteUserAuthTicket(handler : handler, refreshToken : refreshToken, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static void DeleteUserAuthTicket(ServiceClientMessageHandler handler, - string refreshToken, - HttpStatusCode expectedCode = HttpStatusCode.NoContent, HttpStatusCode successCode = HttpStatusCode.NoContent) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.Developer.DeveloperAdminUserAuthTicketClient.DeleteUserAuthTicketClient( - refreshToken : refreshToken ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - } - var noResponse = ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/ShippingSettingFactory.cs b/Mozu.Api.Test/Factories/ShippingSettingFactory.cs deleted file mode 100644 index 2e4bb887..00000000 --- a/Mozu.Api.Test/Factories/ShippingSettingFactory.cs +++ /dev/null @@ -1,75 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the shipping subresource to manage settings for the site shipping information, such as origin address information, carrier shipping methods, shipping rate providers, and regions available for shipping. - /// - public partial class ShippingSettingFactory : BaseDataFactory - { - - /// - /// Retrieves a list of the shipping settings configured for a site. - /// - /// - /// var result = ShippingSettingFactory.GetSiteShippingSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingSettings GetSiteShippingSettings(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.SiteShippingSettingsClient.GetSiteShippingSettingsClient( - responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/ShippingSettingsFactory.cs b/Mozu.Api.Test/Factories/ShippingSettingsFactory.cs deleted file mode 100644 index c06976e4..00000000 --- a/Mozu.Api.Test/Factories/ShippingSettingsFactory.cs +++ /dev/null @@ -1,75 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the shipping subresource to manage settings for the site shipping information, such as origin address information, carrier shipping methods, shipping rate providers, and regions available for shipping. - /// - public partial class ShippingSettingsFactory : BaseDataFactory - { - - /// - /// Retrieves a list of the shipping settings configured for a site. - /// - /// - /// var result = ShippingSettingsFactory.GetSiteShippingSettings(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingSettings GetSiteShippingSettings(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.ShippingSettingsClient.GetSiteShippingSettingsClient( - responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/SiteSettingsApplicationFactory.cs b/Mozu.Api.Test/Factories/SiteSettingsApplicationFactory.cs deleted file mode 100644 index 5c6ad637..00000000 --- a/Mozu.Api.Test/Factories/SiteSettingsApplicationFactory.cs +++ /dev/null @@ -1,113 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Applications resource to update site-specific settings for installed applications. - /// - public partial class SiteSettingsApplicationFactory : BaseDataFactory - { - - /// - /// Retrieve the settings of a third-party application. - /// - /// - /// var result = SiteSettingsApplicationFactory.ThirdPartyGetApplication(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.SiteSettings.Application.Application ThirdPartyGetApplication(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.ApplicationClient.ThirdPartyGetApplicationClient( - responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Initializes an application with the necessary configured settings. - /// - /// - /// var result = SiteSettingsApplicationFactory.ThirdPartyUpdateApplication(handler : handler, application : application, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.SiteSettings.Application.Application ThirdPartyUpdateApplication(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.SiteSettings.Application.Application application, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.ApplicationClient.ThirdPartyUpdateApplicationClient( - application : application, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/SiteSettingsApplicationsFactory.cs b/Mozu.Api.Test/Factories/SiteSettingsApplicationsFactory.cs deleted file mode 100644 index 06e9f1d2..00000000 --- a/Mozu.Api.Test/Factories/SiteSettingsApplicationsFactory.cs +++ /dev/null @@ -1,113 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Applications resource to update site-specific settings for installed applications. - /// - public partial class SiteSettingsApplicationsFactory : BaseDataFactory - { - - /// - /// Retrieve the settings of a third-party application. - /// - /// - /// var result = SiteSettingsApplicationsFactory.ThirdPartyGetApplication(handler : handler, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.SiteSettings.Application.Application ThirdPartyGetApplication(ServiceClientMessageHandler handler, - string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.SiteSettingsApplicationsClient.ThirdPartyGetApplicationClient( - responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Initializes an application with the necessary configured settings. - /// - /// - /// var result = SiteSettingsApplicationsFactory.ThirdPartyUpdateApplication(handler : handler, application : application, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.SiteSettings.Application.Application ThirdPartyUpdateApplication(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.SiteSettings.Application.Application application, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Settings.SiteSettingsApplicationsClient.ThirdPartyUpdateApplicationClient( - application : application, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/StorefrontObjectFactory.cs b/Mozu.Api.Test/Factories/StorefrontObjectFactory.cs deleted file mode 100644 index b059c6e9..00000000 --- a/Mozu.Api.Test/Factories/StorefrontObjectFactory.cs +++ /dev/null @@ -1,74 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// - /// - public partial class StorefrontObjectFactory : BaseDataFactory - { - - /// - /// - /// - /// - /// var result = ObjectFactory.GetRates(handler : handler, rateRequest : rateRequest, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ShippingRuntime.RatesResponse GetRates(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ShippingRuntime.RateRequest rateRequest, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ObjectClient.GetRatesClient( - rateRequest : rateRequest ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/StorefrontProductRuntimeFactory.cs b/Mozu.Api.Test/Factories/StorefrontProductRuntimeFactory.cs deleted file mode 100644 index cb3af82a..00000000 --- a/Mozu.Api.Test/Factories/StorefrontProductRuntimeFactory.cs +++ /dev/null @@ -1,303 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Storefront Products resource to manage the shopper product selection process during a visit to the web storefront. You can update product options as shoppers pick and choose their product choices. A shopper cannot add a product to a cart until all of its required options have been selected. - /// - public partial class StorefrontProductRuntimeFactory : BaseDataFactory - { - - /// - /// Retrieves a list of products that appear on the web storefront according to any specified filter criteria and sort options. - /// - /// - /// var result = ProductRuntimeFactory.GetProducts(handler : handler, filter : filter, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ProductRuntime.ProductCollection GetProducts(ServiceClientMessageHandler handler, - string filter = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null, DataViewMode dataViewMode= DataViewMode.Live, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductsClient( - filter : filter, startIndex : startIndex, pageSize : pageSize, sortBy : sortBy, responseFields : responseFields, dataViewMode: dataViewMode ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves the active inventory level information associated with the product or location specified in the request. - /// - /// - /// var result = ProductRuntimeFactory.GetProductInventory(handler : handler, productCode : productCode, locationCodes : locationCodes, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ProductRuntime.LocationInventoryCollection GetProductInventory(ServiceClientMessageHandler handler, - string productCode, string locationCodes = null, string responseFields = null, DataViewMode dataViewMode= DataViewMode.Live, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductInventoryClient( - productCode : productCode, locationCodes : locationCodes, responseFields : responseFields, dataViewMode: dataViewMode ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves information about a single product given its product code. - /// - /// - /// var result = ProductRuntimeFactory.GetProduct(handler : handler, productCode : productCode, variationProductCode : variationProductCode, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, supressOutOfStock404 : supressOutOfStock404, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ProductRuntime.Product GetProduct(ServiceClientMessageHandler handler, - string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, string responseFields = null, DataViewMode dataViewMode= DataViewMode.Live, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductClient( - productCode : productCode, variationProductCode : variationProductCode, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, supressOutOfStock404 : supressOutOfStock404, responseFields : responseFields, dataViewMode: dataViewMode ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Creates a new product configuration each time a shopper selects a product option value. After the shopper defines values for all required product options, the shopper can add the product configuration to a cart. - /// - /// - /// var result = ProductRuntimeFactory.ConfiguredProduct(handler : handler, productOptionSelections : productOptionSelections, productCode : productCode, includeOptionDetails : includeOptionDetails, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ProductRuntime.ConfiguredProduct ConfiguredProduct(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ConfiguredProductClient( - productOptionSelections : productOptionSelections, productCode : productCode, includeOptionDetails : includeOptionDetails, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Validate the final state of shopper-selected options. - /// - /// - /// var result = ProductRuntimeFactory.ValidateProduct(handler : handler, productOptionSelections : productOptionSelections, productCode : productCode, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ProductRuntime.ProductValidationSummary ValidateProduct(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? skipInventoryCheck = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ValidateProductClient( - productOptionSelections : productOptionSelections, productCode : productCode, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Evaluates whether a collection of discounts specified in the request can be redeemed for the supplied product code. - /// - /// - /// var result = ProductRuntimeFactory.ValidateDiscounts(handler : handler, discountSelections : discountSelections, productCode : productCode, variationProductCode : variationProductCode, customerAccountId : customerAccountId, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ProductRuntime.DiscountValidationSummary ValidateDiscounts(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ProductRuntime.DiscountSelections discountSelections, string productCode, string variationProductCode = null, int? customerAccountId = null, bool? allowInactive = null, bool? skipInventoryCheck = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ValidateDiscountsClient( - discountSelections : discountSelections, productCode : productCode, variationProductCode : variationProductCode, customerAccountId : customerAccountId, allowInactive : allowInactive, skipInventoryCheck : skipInventoryCheck, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Retrieves product inventories for the storefront displayed products. - /// - /// - /// var result = ProductRuntimeFactory.GetProductInventories(handler : handler, query : query, responseFields : responseFields, dataViewMode: dataViewMode, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ProductRuntime.LocationInventoryCollection GetProductInventories(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ProductRuntime.LocationInventoryQuery query, string responseFields = null, DataViewMode dataViewMode= DataViewMode.Live, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductInventoriesClient( - query : query, responseFields : responseFields, dataViewMode: dataViewMode ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/StorefrontProductSearchFactory.cs b/Mozu.Api.Test/Factories/StorefrontProductSearchFactory.cs deleted file mode 100644 index d462fd76..00000000 --- a/Mozu.Api.Test/Factories/StorefrontProductSearchFactory.cs +++ /dev/null @@ -1,113 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Product Search resource to provide dynamic search results to shoppers as they browse and search for products on the web storefront, and to suggest possible search terms as the shopper enters text. - /// - public partial class StorefrontProductSearchFactory : BaseDataFactory - { - - /// - /// Searches the categories displayed on the web storefront for products or product options that the shopper types in a search query. - /// - /// - /// var result = ProductSearchFactory.Search(handler : handler, query : query, filter : filter, facetTemplate : facetTemplate, facetTemplateSubset : facetTemplateSubset, facet : facet, facetFieldRangeQuery : facetFieldRangeQuery, facetHierPrefix : facetHierPrefix, facetHierValue : facetHierValue, facetHierDepth : facetHierDepth, facetStartIndex : facetStartIndex, facetPageSize : facetPageSize, facetSettings : facetSettings, facetValueFilter : facetValueFilter, sortBy : sortBy, pageSize : pageSize, startIndex : startIndex, searchSettings : searchSettings, enableSearchTuningRules : enableSearchTuningRules, searchTuningRuleContext : searchTuningRuleContext, searchTuningRuleCode : searchTuningRuleCode, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ProductRuntime.ProductSearchResult Search(ServiceClientMessageHandler handler, - string query = null, string filter = null, string facetTemplate = null, string facetTemplateSubset = null, string facet = null, string facetFieldRangeQuery = null, string facetHierPrefix = null, string facetHierValue = null, string facetHierDepth = null, string facetStartIndex = null, string facetPageSize = null, string facetSettings = null, string facetValueFilter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, string searchSettings = null, bool? enableSearchTuningRules = null, string searchTuningRuleContext = null, string searchTuningRuleCode = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductSearchResultClient.SearchClient( - query : query, filter : filter, facetTemplate : facetTemplate, facetTemplateSubset : facetTemplateSubset, facet : facet, facetFieldRangeQuery : facetFieldRangeQuery, facetHierPrefix : facetHierPrefix, facetHierValue : facetHierValue, facetHierDepth : facetHierDepth, facetStartIndex : facetStartIndex, facetPageSize : facetPageSize, facetSettings : facetSettings, facetValueFilter : facetValueFilter, sortBy : sortBy, pageSize : pageSize, startIndex : startIndex, searchSettings : searchSettings, enableSearchTuningRules : enableSearchTuningRules, searchTuningRuleContext : searchTuningRuleContext, searchTuningRuleCode : searchTuningRuleCode, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - /// - /// Suggests possible search terms as the shopper enters search text. - /// - /// - /// var result = ProductSearchFactory.Suggest(handler : handler, query : query, groups : groups, pageSize : pageSize, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ProductRuntime.SearchSuggestionResult Suggest(ServiceClientMessageHandler handler, - string query = null, string groups = null, int? pageSize = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductSearchResultClient.SuggestClient( - query : query, groups : groups, pageSize : pageSize, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/StorefrontShippingFactory.cs b/Mozu.Api.Test/Factories/StorefrontShippingFactory.cs deleted file mode 100644 index 84dec6e8..00000000 --- a/Mozu.Api.Test/Factories/StorefrontShippingFactory.cs +++ /dev/null @@ -1,75 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the Storefront Shipping resource to retrieve shipping rate information from the website. - /// - public partial class StorefrontShippingFactory : BaseDataFactory - { - - /// - /// Retrieves the shipping rates applicable for the site. - /// - /// - /// var result = ShippingFactory.GetRates(handler : handler, rateRequest : rateRequest, includeRawResponse : includeRawResponse, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.ShippingRuntime.RatesResponse GetRates(ServiceClientMessageHandler handler, - Mozu.Api.Contracts.ShippingRuntime.RateRequest rateRequest, bool? includeRawResponse = null, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Commerce.Catalog.Storefront.ShippingClient.GetRatesClient( - rateRequest : rateRequest, includeRawResponse : includeRawResponse, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Factories/TenantsFactory.cs b/Mozu.Api.Test/Factories/TenantsFactory.cs deleted file mode 100644 index e63ac24c..00000000 --- a/Mozu.Api.Test/Factories/TenantsFactory.cs +++ /dev/null @@ -1,75 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -#region Usings Setup - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Net; -using Mozu.Api; -using Mozu.Api.Security; -using Mozu.Api.Test.Helpers; -using System.Diagnostics; -using Newtonsoft.Json.Linq; - -#endregion - -namespace Mozu.Api.Test.Factories -{ - /// - /// Use the tenants resource to manage information about a Mozu tenant. - /// - public partial class TenantsFactory : BaseDataFactory - { - - /// - /// Retrieve details about a specific tenant by providing the tenant ID. - /// - /// - /// var result = TenantsFactory.GetTenant(handler : handler, tenantId : tenantId, responseFields : responseFields, expectedCode: expectedCode, successCode: successCode); - /// var optionalCasting = ConvertClass(result); - /// return optionalCasting; - /// - /// - /// - public static Mozu.Api.Contracts.Tenant.Tenant GetTenant(ServiceClientMessageHandler handler, - int tenantId, string responseFields = null, - HttpStatusCode expectedCode = HttpStatusCode.OK, HttpStatusCode successCode = HttpStatusCode.OK) - { - SetSdKparameters(); - var currentClassName = System.Reflection.MethodInfo.GetCurrentMethod().DeclaringType.Name; - var currentMethodName = System.Reflection.MethodBase.GetCurrentMethod().Name; - Debug.WriteLine(currentMethodName + '.' + currentMethodName ); - var apiClient = Mozu.Api.Clients.Platform.TenantsClient.GetTenantClient( - tenantId : tenantId, responseFields : responseFields ); - try - { - apiClient.WithContext(handler.ApiContext).Execute(); - } - catch (ApiException ex) - { - // Custom error handling for test cases can be placed here - Exception customException = TestFailException.GetCustomTestException(ex, currentClassName, currentMethodName, expectedCode); - if (customException != null) - throw customException; - return null; - } - return ResponseMessageFactory.CheckResponseCodes(apiClient.HttpResponse.StatusCode, expectedCode, successCode) - ? (apiClient.Result()) - : null; - - } - - - } - -} - - diff --git a/Mozu.Api.Test/Helpers/CleanupData.cs b/Mozu.Api.Test/Helpers/CleanupData.cs index dfcf5dd3..a75c97e5 100644 --- a/Mozu.Api.Test/Helpers/CleanupData.cs +++ b/Mozu.Api.Test/Helpers/CleanupData.cs @@ -6,8 +6,10 @@ // *********************************************************************** using System; using System.Collections.Generic; -using Mozu.Api.Test.Factories; using System.Net; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition; +using Mozu.Api.Test.Factories.Platform; namespace Mozu.Api.Test.Helpers { diff --git a/Mozu.Api.Test/Helpers/Generator.cs b/Mozu.Api.Test/Helpers/Generator.cs index 6f2f640e..29a93082 100644 --- a/Mozu.Api.Test/Helpers/Generator.cs +++ b/Mozu.Api.Test/Helpers/Generator.cs @@ -1,20 +1,23 @@ using System; -using System.Collections; -using Mozu.Api.Contracts.Core; using Mozu.Api.Contracts.Customer; -using Mozu.Api.Contracts.PricingRuntime; using Mozu.Api.Contracts.ProductAdmin; using System.Collections.Generic; using System.Linq; using System.Globalization; using System.Runtime.Serialization; -using Mozu.Api.Test.Factories; using System.Net; -using System.Dynamic; + using Mozu.Api.Contracts.CommerceRuntime.Wishlists; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Producttypes; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Products; +using Mozu.Api.Test.Factories.Commerce.Customer; +using Mozu.Api.Test.Factories.Commerce.Customer.Accounts; using Attribute = Mozu.Api.Contracts.ProductAdmin.Attribute; using ProductProperty = Mozu.Api.Contracts.ProductAdmin.ProductProperty; using ProductPropertyValue = Mozu.Api.Contracts.ProductAdmin.ProductPropertyValue; +using Discount = Mozu.Api.Contracts.ProductAdmin.Discount; namespace Mozu.Api.Test.Helpers { @@ -2987,10 +2990,10 @@ public static string GenerateLastName() /// /// /// - public static Discount GenerateDiscount(DiscountLocalizedContent content, string scope, DiscountTarget target, + public static Contracts.ProductAdmin.Discount GenerateDiscount(DiscountLocalizedContent content, string scope, DiscountTarget target, DiscountCondition conditions, int? currentRedemptionCnt, decimal? amt, string type) { - return new Discount() + return new Contracts.ProductAdmin.Discount() { Content = content, Scope = scope, diff --git a/Mozu.Api.Test/Mozu.Api.Test.csproj b/Mozu.Api.Test/Mozu.Api.Test.csproj index 2020299c..22f6a08f 100644 --- a/Mozu.Api.Test/Mozu.Api.Test.csproj +++ b/Mozu.Api.Test/Mozu.Api.Test.csproj @@ -99,142 +99,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Mozu.Api.Test/MsTestCases/AttributeVocabularyTests.cs b/Mozu.Api.Test/MsTestCases/AttributeVocabularyTests.cs index 9fb33f90..7e3f0cd8 100644 --- a/Mozu.Api.Test/MsTestCases/AttributeVocabularyTests.cs +++ b/Mozu.Api.Test/MsTestCases/AttributeVocabularyTests.cs @@ -1,7 +1,8 @@ using System; using System.Linq; using Microsoft.VisualStudio.TestTools.UnitTesting; -using Mozu.Api.Test.Factories; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Attributes; +using Mozu.Api.Test.Factories.Platform; using Mozu.Api.Test.Helpers; namespace Mozu.Api.Test.MsTestCases diff --git a/Mozu.Api.Test/MsTestCases/CategoryTests.cs b/Mozu.Api.Test/MsTestCases/CategoryTests.cs index c9bb72ea..80ced4ee 100644 --- a/Mozu.Api.Test/MsTestCases/CategoryTests.cs +++ b/Mozu.Api.Test/MsTestCases/CategoryTests.cs @@ -4,7 +4,9 @@ using System.Net; using Microsoft.VisualStudio.TestTools.UnitTesting; using Mozu.Api.Test.Helpers; -using Mozu.Api.Test.Factories; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition; +using Mozu.Api.Test.Factories.Platform; namespace Mozu.Api.Test.MsTestCases { diff --git a/Mozu.Api.Test/MsTestCases/CustomerTests.cs b/Mozu.Api.Test/MsTestCases/CustomerTests.cs index c3d17ede..2d99d364 100644 --- a/Mozu.Api.Test/MsTestCases/CustomerTests.cs +++ b/Mozu.Api.Test/MsTestCases/CustomerTests.cs @@ -4,9 +4,11 @@ using Microsoft.VisualStudio.TestTools.UnitTesting; using Mozu.Api.Contracts.Customer; using Mozu.Api.Test.Helpers; -using Mozu.Api.Test.Factories; using System.Net; using System.Diagnostics; +using Mozu.Api.Test.Factories.Commerce.Customer; +using Mozu.Api.Test.Factories.Commerce.Customer.Accounts; +using Mozu.Api.Test.Factories.Platform; namespace Mozu.Api.Test.MsTestCases diff --git a/Mozu.Api.Test/MsTestCases/DocumentTest.cs b/Mozu.Api.Test/MsTestCases/DocumentTest.cs index b97486c6..da8b8fda 100644 --- a/Mozu.Api.Test/MsTestCases/DocumentTest.cs +++ b/Mozu.Api.Test/MsTestCases/DocumentTest.cs @@ -1,10 +1,9 @@ using System; using System.IO; using System.Linq; -using System.Text; -using System.Collections.Generic; using Microsoft.VisualStudio.TestTools.UnitTesting; -using Mozu.Api.Test.Factories; +using Mozu.Api.Test.Factories.Content.Documentlists; +using Mozu.Api.Test.Factories.Platform; using Mozu.Api.Test.Helpers; namespace Mozu.Api.Test.MsTestCases diff --git a/Mozu.Api.Test/MsTestCases/OrderTests.cs b/Mozu.Api.Test/MsTestCases/OrderTests.cs index 178a80ca..ec9c9676 100644 --- a/Mozu.Api.Test/MsTestCases/OrderTests.cs +++ b/Mozu.Api.Test/MsTestCases/OrderTests.cs @@ -7,15 +7,21 @@ using Mozu.Api.Contracts.CommerceRuntime.Orders; using Mozu.Api.Contracts.CommerceRuntime.Payments; using Mozu.Api.Contracts.CommerceRuntime.Returns; -using Mozu.Api.Resources.Commerce.Customer; -using Mozu.Api.Resources.Platform; using Mozu.Api.Test.Helpers; using Mozu.Api.Contracts.CommerceRuntime.Carts; -using Mozu.Api.Test.Factories; using Product = Mozu.Api.Contracts.CommerceRuntime.Products.Product; using System.Threading; using System.Diagnostics; using System.Collections; +using Mozu.Api.Test.Factories.Commerce; +using Mozu.Api.Test.Factories.Commerce.Admin; +using Mozu.Api.Test.Factories.Commerce.Carts; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin; +using Mozu.Api.Test.Factories.Commerce.Catalog.Storefront; +using Mozu.Api.Test.Factories.Commerce.Customer; +using Mozu.Api.Test.Factories.Commerce.Customer.Accounts; +using Mozu.Api.Test.Factories.Commerce.Orders; +using Mozu.Api.Test.Factories.Platform; namespace Mozu.Api.Test.MsTestCases @@ -218,7 +224,7 @@ public void OrderTests_CreateOrderPayByCreditCard() var ShopperAuth = Mozu.Api.Security.CustomerAuthenticator.Authenticate(customerUserAuthInfo: shopperUserAuthInfo, tenantId: TestBaseTenant.Id, - siteId: TestBaseTenant.Sites.FirstOrDefault().Id); + siteId: TestBaseTenant.Sites.FirstOrDefault().Id).Result; ShopperMsgHandler.ApiContext.UserAuthTicket = ShopperAuth.AuthTicket; var createdCart = CartFactory.GetOrCreateCart(ShopperMsgHandler); @@ -465,7 +471,7 @@ public string CreateOrdersForTest(bool submitOrder= false, bool fullfillOrder = ShopperAuth = Mozu.Api.Security.CustomerAuthenticator.Authenticate(customerUserAuthInfo: shopperUserAuthInfo, tenantId: TestBaseTenant.Id, - siteId: TestBaseTenant.Sites.FirstOrDefault().Id); + siteId: TestBaseTenant.Sites.FirstOrDefault().Id).Result; } catch (Exception ex) { diff --git a/Mozu.Api.Test/MsTestCases/PaymentTest.cs b/Mozu.Api.Test/MsTestCases/PaymentTest.cs index 9a7f867d..8cb2c571 100644 --- a/Mozu.Api.Test/MsTestCases/PaymentTest.cs +++ b/Mozu.Api.Test/MsTestCases/PaymentTest.cs @@ -1,12 +1,11 @@ using System; using System.Collections.Generic; using System.Linq; -using System.Net; -using System.Net.Http; using Microsoft.VisualStudio.TestTools.UnitTesting; using Mozu.Api.Contracts.PaymentService; using Mozu.Api.Resources.Commerce.Payments; -using Mozu.Api.Test.Factories; +using Mozu.Api.Test.Factories.Commerce.Orders; +using Mozu.Api.Test.Factories.Platform; using Mozu.Api.Test.Helpers; namespace Mozu.Api.Test.MsTestCases diff --git a/Mozu.Api.Test/MsTestCases/ProductAttributeTests.cs b/Mozu.Api.Test/MsTestCases/ProductAttributeTests.cs index 70d52a34..d0124bf4 100644 --- a/Mozu.Api.Test/MsTestCases/ProductAttributeTests.cs +++ b/Mozu.Api.Test/MsTestCases/ProductAttributeTests.cs @@ -3,21 +3,12 @@ using System.Linq; using System.Net; using Microsoft.VisualStudio.TestTools.UnitTesting; -using Mozu.Api.Contracts.CommerceRuntime.Fulfillment; -using Mozu.Api.Contracts.CommerceRuntime.Orders; -using Mozu.Api.Contracts.CommerceRuntime.Payments; -using Mozu.Api.Contracts.CommerceRuntime.Returns; -using Mozu.Api.Contracts.Customer; using Mozu.Api.Contracts.ProductAdmin; -using Mozu.Api.Security; using Mozu.Api.Test.Helpers; -using Mozu.Api.Contracts.CommerceRuntime.Carts; -using Mozu.Api.Test.Factories; -using Mozu.Api.Contracts.Core; -using Product = Mozu.Api.Contracts.CommerceRuntime.Products.Product; -using System.Threading; -using System.Diagnostics; -using System.Collections; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Attributes; +using Mozu.Api.Test.Factories.Platform; namespace Mozu.Api.Test.MsTestCases diff --git a/Mozu.Api.Test/MsTestCases/ProductPublishingTests.cs b/Mozu.Api.Test/MsTestCases/ProductPublishingTests.cs index 49946217..8e76f94b 100644 --- a/Mozu.Api.Test/MsTestCases/ProductPublishingTests.cs +++ b/Mozu.Api.Test/MsTestCases/ProductPublishingTests.cs @@ -4,8 +4,12 @@ using System.Net; using Microsoft.VisualStudio.TestTools.UnitTesting; using Mozu.Api.Test.Helpers; -using Mozu.Api.Test.Factories; using System.Threading; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition.Producttypes; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Products; +using Mozu.Api.Test.Factories.Platform; namespace Mozu.Api.Test.MsTestCases { diff --git a/Mozu.Api.Test/MsTestCases/ProductTests.cs b/Mozu.Api.Test/MsTestCases/ProductTests.cs index fa5ce1e6..8b657901 100644 --- a/Mozu.Api.Test/MsTestCases/ProductTests.cs +++ b/Mozu.Api.Test/MsTestCases/ProductTests.cs @@ -2,15 +2,16 @@ using System.Collections.Generic; using System.Linq; using System.Net; -using System.Security.Cryptography; using Microsoft.VisualStudio.TestTools.UnitTesting; using Mozu.Api.Contracts.ProductAdmin; using Mozu.Api.Resources.Commerce.Catalog.Admin; using Mozu.Api.Test.Helpers; -using Mozu.Api.Test.Factories; -using System.Configuration; using Attribute = Mozu.Api.Contracts.ProductAdmin.Attribute; using System.Threading; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Attributedefinition; +using Mozu.Api.Test.Factories.Commerce.Catalog.Admin.Products; +using Mozu.Api.Test.Factories.Platform; namespace Mozu.Api.Test.MsTestCases diff --git a/Mozu.Api.Test/MsTestCases/TenantDataTest.cs b/Mozu.Api.Test/MsTestCases/TenantDataTest.cs index e376d7c4..4952055c 100644 --- a/Mozu.Api.Test/MsTestCases/TenantDataTest.cs +++ b/Mozu.Api.Test/MsTestCases/TenantDataTest.cs @@ -2,18 +2,19 @@ using System.Linq; using System.Net; using System.Net.Http; -using System.Net.Http.Headers; -using System.Text; using System.Collections.Generic; using Microsoft.VisualStudio.TestTools.UnitTesting; using Mozu.Api.Resources.Platform; -using Mozu.Api.Test.Factories; +using Mozu.Api.Test.Factories.Platform; +using Mozu.Api.Test.Factories.Platform.Entitylists; using Mozu.Api.Test.Helpers; -using NUnit.Framework; + using TestContext = Microsoft.VisualStudio.TestTools.UnitTesting.TestContext; namespace Mozu.Api.Test.MsTestCases { + using System.Threading; + /// /// Summary description for TenantDataTest /// @@ -107,6 +108,17 @@ public void GetDataTest() } + [TestMethod] + public void GetTenantAsyncTest() + { + var tenantResource = new TenantResource(); + CancellationTokenSource cts = new CancellationTokenSource(); + cts.CancelAfter(TimeSpan.FromSeconds(3)); + + var tenant = tenantResource.GetTenantAsync(8088, ct: cts.Token).Result; + } + + [TestMethod] public void GetEntityList() { diff --git a/Mozu.Api.Test/MsTestCases/UserAuthTest.cs b/Mozu.Api.Test/MsTestCases/UserAuthTest.cs index f432f760..dd82b0fb 100644 --- a/Mozu.Api.Test/MsTestCases/UserAuthTest.cs +++ b/Mozu.Api.Test/MsTestCases/UserAuthTest.cs @@ -9,6 +9,7 @@ using Mozu.Api.Security; using System; using Mozu.Api.Test.Factories; +using Mozu.Api.Test.Factories.Platform; using Mozu.Api.Test.Helpers; namespace Mozu.Api.Test.MsTestCases diff --git a/Mozu.Api/Clients/Commerce/Admin/LocationClient.cs b/Mozu.Api/Clients/Commerce/Admin/LocationClient.cs old mode 100644 new mode 100755 index 276802b3..eab52c5c --- a/Mozu.Api/Clients/Commerce/Admin/LocationClient.cs +++ b/Mozu.Api/Clients/Commerce/Admin/LocationClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Admin { @@ -22,13 +23,13 @@ namespace Mozu.Api.Clients.Commerce.Admin public partial class LocationClient { /// - /// Retrieves a list of all locations associated with a tenant, according to any filter and sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class LocationClient { } /// - /// Retrieves the details of the location specified in the request by location code. + /// /// - /// The unique, user-defined code that identifies a location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// The merchant-defined code of the location to retrieve. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class LocationClient { } /// - /// Creates a new physical location for the tenant specified in the request header. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. + /// + /// Properties of the location to create. /// /// {} /// @@ -100,11 +101,11 @@ public partial class LocationClient { } /// - /// Updates one or more details of a the location specified in the request by location code. + /// /// - /// The unique, user-defined code that identifies a location. - /// Use this field to include those fields which are not included by default. - /// Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. + /// The merchant-defined code associated with the location to update. + /// + /// Properties of the location to update. /// /// {} /// @@ -126,9 +127,9 @@ public partial class LocationClient { } /// - /// Deletes the location specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. + /// The merchant-defined code of the location to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Admin/LocationTypeClient.cs b/Mozu.Api/Clients/Commerce/Admin/LocationTypeClient.cs old mode 100644 new mode 100755 index 9ebe59a8..52c7ef8c --- a/Mozu.Api/Clients/Commerce/Admin/LocationTypeClient.cs +++ b/Mozu.Api/Clients/Commerce/Admin/LocationTypeClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Admin { @@ -22,7 +23,7 @@ namespace Mozu.Api.Clients.Commerce.Admin public partial class LocationTypeClient { /// - /// Retrieve a list of all location types defined for the tenant. + /// /// /// /// {List{}} @@ -45,10 +46,10 @@ public partial class LocationTypeClient { } /// - /// Retrieves the details of the location type specified in the request. + /// /// /// The user-defined code that identifies the location type. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -70,10 +71,10 @@ public partial class LocationTypeClient { } /// - /// Creates a new location type based on the information specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a type of physical location, such as warehouse or kiosk. Location types enable tenants to group similar locations for filtering and location usage type definition. + /// + /// Properties of the location type to create. /// /// {} /// @@ -95,11 +96,11 @@ public partial class LocationTypeClient { } /// - /// Updates the name of a defined location type. + /// /// /// The user-defined code that identifies the location type. - /// Use this field to include those fields which are not included by default. - /// Properties of a type of physical location, such as warehouse or kiosk. Location types enable tenants to group similar locations for filtering and location usage type definition. + /// + /// Properties of the location type to update. /// /// {} /// @@ -121,9 +122,9 @@ public partial class LocationTypeClient { } /// - /// Deletes the location type specified in the request. + /// /// - /// The user-defined code that identifies the location type. + /// User-defined code used to identify the location type. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Admin/Locations/Attributedefinition/AttributeClient.cs b/Mozu.Api/Clients/Commerce/Admin/Locations/Attributedefinition/AttributeClient.cs new file mode 100755 index 00000000..f8a34479 --- /dev/null +++ b/Mozu.Api/Clients/Commerce/Admin/Locations/Attributedefinition/AttributeClient.cs @@ -0,0 +1,158 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition +{ + /// + /// + /// + public partial class AttributeClient { + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetAttributes( startIndex, pageSize, sortBy, filter, responseFields); + /// var attributeCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetAttributesClient(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Admin.Locations.Attributedefinition.AttributeUrl.GetAttributesUrl(startIndex, pageSize, sortBy, filter, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// {List{}} + /// + /// + /// + /// var mozuClient=GetAttributeVocabularyValues( attributeFQN); + /// var attributeVocabularyValueClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient> GetAttributeVocabularyValuesClient(string attributeFQN) + { + var url = Mozu.Api.Urls.Commerce.Admin.Locations.Attributedefinition.AttributeUrl.GetAttributeVocabularyValuesUrl(attributeFQN); + const string verb = "GET"; + var mozuClient = new MozuClient>() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetAttribute( attributeFQN, responseFields); + /// var attributeClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetAttributeClient(string attributeFQN, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Admin.Locations.Attributedefinition.AttributeUrl.GetAttributeUrl(attributeFQN, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=CreateAttribute( attribute, responseFields); + /// var attributeClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient CreateAttributeClient(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Admin.Locations.Attributedefinition.AttributeUrl.CreateAttributeUrl(responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(attribute); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=UpdateAttribute( attribute, attributeFQN, responseFields); + /// var attributeClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient UpdateAttributeClient(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Admin.Locations.Attributedefinition.AttributeUrl.UpdateAttributeUrl(attributeFQN, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(attribute); + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Commerce/CartClient.cs b/Mozu.Api/Clients/Commerce/CartClient.cs old mode 100644 new mode 100755 index d404ba12..27b75003 --- a/Mozu.Api/Clients/Commerce/CartClient.cs +++ b/Mozu.Api/Clients/Commerce/CartClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce { /// - /// Use this resource to manage storefront shopping carts as shoppers add and remove items for purchase. Each time a shopper's cart is modified, the Carts resource updates the estimated total with any applicable discounts. + /// Use the Carts resource to manage storefront shopping carts as items are added and removed. Each time a shopper's cart is modified, the Carts resource updates the estimated total with any applicable discounts. /// public partial class CartClient { /// - /// Retrieves the cart specified in the request. + /// /// - /// Identifier of the cart to delete. - /// Use this field to include those fields which are not included by default. + /// Identifier of the cart to retrieve. + /// /// /// {} /// @@ -47,9 +48,9 @@ public partial class CartClient { } /// - /// Retrieves a cart's contents for the current shopper. If the shopper does not have an active cart on the site, the service creates one. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -71,9 +72,9 @@ public partial class CartClient { } /// - /// Retrieves summary information associated with the cart of the current shopper, including the number of items, the current total, and whether the cart has expired. All anonymous idle carts that do not proceed to checkout expire after 14 days. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -95,10 +96,10 @@ public partial class CartClient { } /// - /// Retrieves summary information associated with the cart of user specified in the request, including the number of items in the cart, the current total, and whether the cart has expired. All anonymous idle carts that do not proceed to checkout expire after 14 days. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. + /// + /// Unique identifier of the user whose cart details you want to retrieve. /// /// {} /// @@ -120,10 +121,10 @@ public partial class CartClient { } /// - /// Retrieves the cart of the user specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. + /// + /// Unique identifier of the user whose cart you want to retrieve. /// /// {} /// @@ -145,10 +146,10 @@ public partial class CartClient { } /// - /// Update the current shopper's cart. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a shopping cart. + /// + /// All of the properties of the cart to update. The product code is required. /// /// {} /// @@ -170,7 +171,7 @@ public partial class CartClient { } /// - /// Deletes the cart specified in the request. + /// /// /// Identifier of the cart to delete. /// @@ -194,7 +195,7 @@ public static MozuClient DeleteCartClient(string cartId) } /// - /// Deletes the cart of the currently active shopper. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Carts/AppliedDiscountClient.cs b/Mozu.Api/Clients/Commerce/Carts/AppliedDiscountClient.cs old mode 100644 new mode 100755 index de944312..7cc30ac3 --- a/Mozu.Api/Clients/Commerce/Carts/AppliedDiscountClient.cs +++ b/Mozu.Api/Clients/Commerce/Carts/AppliedDiscountClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Carts { /// - /// Use the Cart Coupons subresource to apply a coupon to a defined cart or remove a coupon from a cart. When the shopper proceeds to checkout, the coupons applied to the cart apply to the order. + /// Use the Cart Coupons resource to apply a coupon to a defined cart or remove a coupon from a cart. When the shopper proceeds to checkout, the coupons applied to the cart apply to the order. /// public partial class AppliedDiscountClient { /// - /// Applies a defined coupon to the cart specified in the request. + /// /// - /// Identifier of the cart to delete. - /// Code associated with the coupon to remove from the cart. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the cart to which to apply the coupon. + /// Code associated with the coupon to apply to the cart. + /// /// /// {} /// @@ -48,9 +49,9 @@ public partial class AppliedDiscountClient { } /// - /// Removes all coupons from the cart specified in the request. + /// /// - /// Identifier of the cart to delete. + /// Unique identifier of the cart. /// /// {} /// @@ -72,9 +73,9 @@ public partial class AppliedDiscountClient { } /// - /// Removes an applied coupon from the cart specified in the request. + /// /// - /// Identifier of the cart to delete. + /// Unique identifier of the cart. /// Code associated with the coupon to remove from the cart. /// /// {} diff --git a/Mozu.Api/Clients/Commerce/Carts/CartItemClient.cs b/Mozu.Api/Clients/Commerce/Carts/CartItemClient.cs old mode 100644 new mode 100755 index 6ab79430..be50157b --- a/Mozu.Api/Clients/Commerce/Carts/CartItemClient.cs +++ b/Mozu.Api/Clients/Commerce/Carts/CartItemClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Carts { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Carts public partial class CartItemClient { /// - /// Retrieves a particular cart item by providing the cart item ID. + /// /// - /// Identifier of the cart item to delete. - /// Use this field to include those fields which are not included by default. + /// Identifier of the cart item to retrieve. + /// /// /// {} /// @@ -47,9 +48,9 @@ public partial class CartItemClient { } /// - /// Retrieves a list of cart items including the total number of items in the cart. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -71,10 +72,10 @@ public partial class CartItemClient { } /// - /// Adds a product to the current shopper's cart. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of an item added to an active shopping cart. + /// + /// All properties of the new cart item. The product code is required. /// /// {} /// @@ -96,11 +97,11 @@ public partial class CartItemClient { } /// - /// Update the quantity of an individual cart item in the cart of the current shopper. + /// /// - /// Identifier of the cart item to delete. + /// Identifier of the cart item to update quantity. /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -122,11 +123,11 @@ public partial class CartItemClient { } /// - /// Update the product or product quantity of an item in the current shopper's cart. + /// /// - /// Identifier of the cart item to delete. - /// Use this field to include those fields which are not included by default. - /// Properties of an item added to an active shopping cart. + /// Identifier of the cart item to update. + /// + /// The properties of the cart item to update. /// /// {} /// @@ -148,7 +149,7 @@ public partial class CartItemClient { } /// - /// Removes all items in the current shopper's active cart. + /// /// /// /// {} @@ -171,7 +172,7 @@ public partial class CartItemClient { } /// - /// Deletes a specific cart item by providing the cart item ID. + /// /// /// Identifier of the cart item to delete. /// diff --git a/Mozu.Api/Clients/Commerce/Carts/ChangeMessageClient.cs b/Mozu.Api/Clients/Commerce/Carts/ChangeMessageClient.cs old mode 100644 new mode 100755 index 8447880e..98cc4175 --- a/Mozu.Api/Clients/Commerce/Carts/ChangeMessageClient.cs +++ b/Mozu.Api/Clients/Commerce/Carts/ChangeMessageClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Carts { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Carts public partial class ChangeMessageClient { /// - /// Retrieves the messages associated with the current shopper's cart. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -46,7 +47,7 @@ public partial class ChangeMessageClient { } /// - /// Deletes all messages associated with the cart of the current shopper. + /// /// /// /// @@ -69,7 +70,7 @@ public static MozuClient RemoveAllMessagesClient() } /// - /// Removes a single message associated with the cart of the current shopper. + /// /// /// Identifier of the message to remove from the cart. /// diff --git a/Mozu.Api/Clients/Commerce/Carts/ExtendedPropertyClient.cs b/Mozu.Api/Clients/Commerce/Carts/ExtendedPropertyClient.cs old mode 100644 new mode 100755 index daf08aa5..11bcfdba --- a/Mozu.Api/Clients/Commerce/Carts/ExtendedPropertyClient.cs +++ b/Mozu.Api/Clients/Commerce/Carts/ExtendedPropertyClient.cs @@ -13,16 +13,17 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Carts { /// - /// Use the Cart Extended Properties subresource to store an arbitrary number of cart extended properties such as tracking strings, marketing sources, affiliates, sales personnel/data, and so on, on a per cart basis. Each cart may have none, one, or more than one entry in the extended properties collection, and all values in the extended properties collection are represented as strings. When you create an order from a cart, all extended properties are retained from the cart and copied to the order. Refer to the subresource for more information about order extended properties. + /// /// public partial class ExtendedPropertyClient { /// - /// Retrieves a list of cart extended properties specified in the request. + /// /// /// /// {List{}} @@ -45,9 +46,9 @@ public partial class ExtendedPropertyClient { } /// - /// Adds one or more specified extended properties to the carts extended properties collection. + /// /// - /// The details of the new extended property. + /// /// /// {List{}} /// @@ -69,12 +70,12 @@ public partial class ExtendedPropertyClient { } /// - /// Updates one or more details of the extended property specified in the request. + /// /// - /// Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Any set of key value pairs to be stored in the extended properties of a cart. - /// The details of the updated extended property. + /// + /// + /// + /// /// /// {} /// @@ -96,10 +97,10 @@ public partial class ExtendedPropertyClient { } /// - /// Updates one or more details of the extended properties specified in the request. + /// /// - /// Any set of key value pairs to be stored in the extended properties of a cart. - /// The details of the updated extended properties. + /// + /// /// /// {List{}} /// @@ -121,7 +122,7 @@ public partial class ExtendedPropertyClient { } /// - /// Deletes the extended properties cart extended properties collection. + /// /// /// /// @@ -145,7 +146,7 @@ public static MozuClient DeleteExtendedPropertiesClient(List keys) } /// - /// Deletes a specific extended property from the cart extended property collection. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/AttributeClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/AttributeClient.cs old mode 100644 new mode 100755 index 92120def..75d19c98 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/AttributeClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/AttributeClient.cs @@ -13,22 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition { /// - /// Attributes are used to add custom definitions and characteristics to the following objects: - - + /// Use the Attribute Definition resource to manage the properties, options, and extras that uniquely describe products of a specific type. Attributes can be associated with a product type, assigned values by a client or shopper, and added as faceted search filters for a product category. Options are product attributes that describe unique configurations made by the shopper, such as size or color, and generate a new product variation (or unique SKU). Properties are product attributes that describe aspects of the product that do not represent an option configurable by the shopper, such as screen resolution or brand. Extras are product attributes that describe add-on configurations made by the shopper that do not represent a product variation, such as a monogram. /// public partial class AttributeClient { /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// {} @@ -53,10 +52,10 @@ public partial class AttributeClient { } /// - /// Retrieves the details of the specified product attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// {} /// /// {} @@ -79,11 +78,11 @@ public partial class AttributeClient { } /// - /// Creates a new attribute to describe one aspect of a product such as color or size, based on its defined product type. The attribute name, attribute type, input type, and data type are required. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute used to describe customers or orders. + /// Properties of the new product attribute to create. /// /// {} /// @@ -105,12 +104,12 @@ public partial class AttributeClient { } /// - /// Updates an existing attribute with attribute properties to set. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// {} - /// Properties of an attribute used to describe customers or orders. + /// Any properties of the attribute that to update. /// /// {} /// @@ -132,9 +131,9 @@ public partial class AttributeClient { } /// - /// Deletes a defined product attribute. You cannot delete an attribute assigned a value for a product. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentClient.cs old mode 100644 new mode 100755 index 5d0a731a..d3ff8ab4 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes { /// - /// Properties of localized content for attributes, based on a `localeCode` at a site/tenant level. This content supports translated text for product, product options, and additional objects. + /// /// public partial class AttributeLocalizedContentClient { /// - /// Retrieves a collection of localized content for attributes based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. + /// /// {} /// /// {List{}} @@ -47,11 +48,11 @@ public partial class AttributeLocalizedContentClient { } /// - /// Retrieves the localized content for an attribute based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// {} /// /// {} @@ -74,12 +75,12 @@ public partial class AttributeLocalizedContentClient { } /// - /// Adds new localized content for an attribute based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Use this field to include those fields which are not included by default. + /// + /// /// {} - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. + /// /// /// {} /// @@ -101,11 +102,11 @@ public partial class AttributeLocalizedContentClient { } /// - /// Updates the localized content for a collection of existing attributes based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. + /// /// {} - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. + /// /// /// {List{}} /// @@ -127,13 +128,13 @@ public partial class AttributeLocalizedContentClient { } /// - /// Updates the localized content for an existing attribute based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// {} - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. + /// /// /// {} /// @@ -155,10 +156,10 @@ public partial class AttributeLocalizedContentClient { } /// - /// Removes all localized content. Localized content is translated text information and data based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. + /// + /// /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleClient.cs old mode 100644 new mode 100755 index 4a2ccaf8..89b566a4 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes public partial class AttributeTypeRuleClient { /// - /// 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. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// {} diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueClient.cs old mode 100644 new mode 100755 index 48c7bb29..d403d3c8 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes public partial class AttributeVocabularyValueClient { /// - /// Retrieves a list of vocabulary values defined for the attribute specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// {} /// /// {List{}} @@ -47,10 +48,10 @@ public partial class AttributeVocabularyValueClient { } /// - /// Retrieves a collection of localized content for vocabulary value attributes based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// The value string to create. + /// + /// /// {} /// /// {List{}} @@ -73,12 +74,12 @@ public partial class AttributeVocabularyValueClient { } /// - /// Retrieves the localized content for a vocabulary value attribute based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// /// {} /// /// {} @@ -101,11 +102,11 @@ public partial class AttributeVocabularyValueClient { } /// - /// Retrieves the details of a vocabulary value defined for an attribute by providing the attribute's fully qualified name and the value to retrieve. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// The actual unique value of the attribute vocabulary to retrieve. A single attribute must have a unique value and match the attribute's data type. If a string value returns null, the system will generate a value. The actual string content displayed shoud be stored as "Content" and actual content is required for string values. /// {} /// /// {} @@ -128,13 +129,13 @@ public partial class AttributeVocabularyValueClient { } /// - /// Creates and saves localized vocabulary value content for an attribute, based on the `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// /// {} - /// The localized text for the string value of a product attribute. + /// /// /// {} /// @@ -156,12 +157,12 @@ public partial class AttributeVocabularyValueClient { } /// - /// Creates a vocabulary value for a defined product attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// {} - /// Properties of a vocabulary value defined for an extensible attribute. + /// The predefined vocabulary value to add to the attribute content. /// /// {} /// @@ -183,11 +184,11 @@ public partial class AttributeVocabularyValueClient { } /// - /// Update existing vocabulary values for an attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// {} - /// Properties of a vocabulary value defined for an extensible attribute. + /// The actual vocabulary values for the attribute being updated. /// /// {List{}} /// @@ -209,12 +210,12 @@ public partial class AttributeVocabularyValueClient { } /// - /// Updates a collection of localized vocabulary value content for existing attributes, based on the `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// The value string to create. + /// + /// /// {} - /// The localized text for the string value of a product attribute. + /// /// /// {List{}} /// @@ -236,14 +237,14 @@ public partial class AttributeVocabularyValueClient { } /// - /// Updates localized vocabulary value content for an existing attribute, based on the `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// /// {} - /// The localized text for the string value of a product attribute. + /// /// /// {} /// @@ -265,13 +266,13 @@ public partial class AttributeVocabularyValueClient { } /// - /// Updates existing attribute vocabulary values. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// The actual unique value of the attribute vocabulary value to update. A single attribute must have a unique value and match the attribute's data type. If a string value returns null, the system will generate a value. The actual string content displayed shoud be stored as "Content" and actual content is required for string values. /// {} - /// Properties of a vocabulary value defined for an extensible attribute. + /// The predefined vocabulary value to add to the attribute content to update. /// /// {} /// @@ -293,10 +294,10 @@ public partial class AttributeVocabularyValueClient { } /// - /// Deletes an attribute's vocabulary value. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The value string to create. + /// + /// The actual unique value of the attribute vocabulary to delete. A single attribute must have a unique value and match the attribute's data type. If a string value returns null, the system will generate a value. The actual string content displayed shoud be stored as "Content" and actual content is required for string values. /// {} /// /// @@ -319,11 +320,11 @@ public static MozuClient DeleteAttributeVocabularyValueClient(string attributeFQ } /// - /// Removes localized content for a vocabulary value attribute. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The value string to create. + /// + /// + /// /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/ProductTypeClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/ProductTypeClient.cs old mode 100644 new mode 100755 index bbf86128..4eb81ded --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/ProductTypeClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/ProductTypeClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition public partial class ProductTypeClient { /// - /// Retrieves a list of product types according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product type search results by any of its properties. 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=Name+cont+shoes" + /// + /// /// /// /// {} @@ -52,10 +53,10 @@ public partial class ProductTypeClient { } /// - /// Retrieves the details of the product type specified in the request. + /// /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// Identifier of the product type to retrieve. + /// /// {} /// /// {} @@ -79,11 +80,11 @@ public partial class ProductTypeClient { } /// - /// Creates a new product type based on the information supplied in the request. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// {} - /// A product type is like a product template. + /// Properties of the product type to create. /// /// {} /// @@ -106,12 +107,12 @@ public partial class ProductTypeClient { } /// - /// Updates one or more properties of a product type. + /// /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// Identifier of the product type to update. + /// /// {} - /// A product type is like a product template. + /// The details of the product type to update. /// /// {} /// @@ -134,9 +135,9 @@ public partial class ProductTypeClient { } /// - /// Deletes the product type by providing the product type ID. + /// /// - /// Identifier of the product type. + /// Identifier of the product type to delete. /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraClient.cs old mode 100644 new mode 100755 index 81761811..f07dd265 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes { @@ -22,7 +23,7 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttyp public partial class ProductTypeExtraClient { /// - /// Retrieves a list of extra attributes defined for the specified product type. + /// /// /// Identifier of the product type. /// {} @@ -48,11 +49,11 @@ public partial class ProductTypeExtraClient { } /// - /// Retrieves the details of an extra attribute definition for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// + /// Identifier of the product type whose extra is being retrieved. + /// /// {} /// /// {} @@ -76,12 +77,12 @@ public partial class ProductTypeExtraClient { } /// - /// Assigns a defined extra attribute to the product type based on the information supplied in the request. + /// /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// The properties of the extra attribute definition for this product type assignment. /// /// {} /// @@ -104,13 +105,13 @@ public partial class ProductTypeExtraClient { } /// - /// Update the definition of an extra attribute for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// The properties of the extra attribute definition to update for the product type. /// /// {} /// @@ -133,9 +134,9 @@ public partial class ProductTypeExtraClient { } /// - /// Removes an extra attribute definition from the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionClient.cs old mode 100644 new mode 100755 index 8ca13a1e..21cf36b9 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttyp public partial class ProductTypeOptionClient { /// - /// Retrieves a list of option product attributes defined for the specified product type. + /// /// - /// Identifier of the product type. + /// Identifier of the product type to retrieve. /// {} /// /// {List{}} @@ -48,11 +49,11 @@ public partial class ProductTypeOptionClient { } /// - /// Retrieves the details of an option attribute defined for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// + /// The identifier of the product type. + /// /// {} /// /// {} @@ -76,12 +77,12 @@ public partial class ProductTypeOptionClient { } /// - /// Assigns an option attribute to the product type based on the information supplied in the request. + /// /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// Properties of the option attribute to define for the specified product type. /// /// {} /// @@ -104,13 +105,13 @@ public partial class ProductTypeOptionClient { } /// - /// Updates an option attribute definition for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// Properties of the option product attribute to define for the specified product type. /// /// {} /// @@ -133,9 +134,9 @@ public partial class ProductTypeOptionClient { } /// - /// Removes an option attribute definition for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyClient.cs old mode 100644 new mode 100755 index aee3b0fd..3b905436 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes { @@ -22,7 +23,7 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttyp public partial class ProductTypePropertyClient { /// - /// Retrieves a list of product property attributes defined for a product type. + /// /// /// Identifier of the product type. /// {} @@ -48,11 +49,11 @@ public partial class ProductTypePropertyClient { } /// - /// Retrieves a product property attribute definition for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} /// /// {} @@ -76,12 +77,12 @@ public partial class ProductTypePropertyClient { } /// - /// Assigns a property attribute to the specified product type, according to the information defined in the request. + /// /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// Properties of the property attribute to define for the specified product type. /// /// {} /// @@ -104,13 +105,13 @@ public partial class ProductTypePropertyClient { } /// - /// Updates the definition of a property attribute for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// Properties of the property attribute to define for the product type. /// /// {} /// @@ -133,9 +134,9 @@ public partial class ProductTypePropertyClient { } /// - /// Removes a property attribute previously defined for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationClient.cs old mode 100644 new mode 100755 index 9440e9a7..0c4ef455 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes { @@ -22,17 +23,17 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttyp public partial class ProductTypeVariationClient { /// - /// Generates the variations possible for a product associated with the product type based on the option values supplied in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. + /// + /// /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// Unique identifier of the product type. + /// + /// + /// /// {} - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. + /// The product option attributes configured for this product type. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/CategoryClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/CategoryClient.cs old mode 100644 new mode 100755 index 62765da2..e4e4e708 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/CategoryClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/CategoryClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin public partial class CategoryClient { /// - /// Retrieves a list of categories according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product category search results by any of its properties, including its position in the category hierarchy. 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" + /// + /// /// /// /// @@ -51,10 +52,10 @@ public partial class CategoryClient { } /// - /// Retrieves the list of subcategories within a category. + /// /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the category for which to retrieve subcategories. + /// /// /// {} /// @@ -76,10 +77,10 @@ public partial class CategoryClient { } /// - /// Retrieves the details of a single category. + /// /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the category to retrieve. + /// /// /// {} /// @@ -102,12 +103,12 @@ public partial class CategoryClient { } /// - /// Adds a new category to the site's category hierarchy.Specify a to determine where to place the category in the hierarchy. If no is specified, the new category is a top-level category. + /// /// /// If true, when adding a new product category, set the sequence number of the new category to an increment of one integer greater than the maximum available sequence number across all product categories. If false, set the sequence number to zero. - /// Use this field to include those fields which are not included by default. - /// Optional. If , uses the you specify in the request as the category's id. If , generates an for the category regardless if you specify an id in the request.If you specify an id already in use and set this parameter to , returns an error. - /// A descriptive container that groups products. A category is merchant defined with associated products and discounts as configured. GThe storefront displays products in a hierarchy of categories. As such, categories can include a nesting of sub-categories to organize products and product options per set guidelines such as color, brand, material, and size. + /// + /// + /// Properties of the new category to create. You must specify a name and parent category if you want to create it as a subcategory. /// /// {} /// @@ -129,10 +130,10 @@ public partial class CategoryClient { } /// - /// Validate the precomputed dynamic category expression for correctness. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the dynamic expression that you want to validate. + /// + /// /// /// {} /// @@ -154,10 +155,10 @@ public partial class CategoryClient { } /// - /// Validates the readltime dynamic category expression for correctness. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the dynamic expression that you want to validate. + /// + /// /// /// {} /// @@ -179,12 +180,12 @@ public partial class CategoryClient { } /// - /// Update the properties of a defined category or move it to another location in the category hierarchy. Because this operation replaces the defined resource,include all the information to maintain for the category in the request. + /// /// - /// If true, when changing the display option for the category, change it for all subcategories also. The default value is false. + /// If true, when changing the display option for the category, change it for all subcategories also. Default: False. /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. - /// A descriptive container that groups products. A category is merchant defined with associated products and discounts as configured. GThe storefront displays products in a hierarchy of categories. As such, categories can include a nesting of sub-categories to organize products and product options per set guidelines such as color, brand, material, and size. + /// + /// Properties of the category to modify. /// /// {} /// @@ -206,12 +207,12 @@ public partial class CategoryClient { } /// - /// Deletes the specified category. Use the categoryId parameter to specify the category. + /// /// - /// Specifies whether to also delete all subcategories associated with the specified category.If you set this value is false, only the specified category is deleted.The default value is false. - /// Unique identifier of the category to modify. - /// Specifies whether the category, and any associated subcategories, are deleted even if there are products that reference them. The default value is false. - /// Specifies whether any subcategories of the specified category are reassigned to the parent of the specified category.This field only applies if the cascadeDelete parameter is false.The default value is false. + /// If true, also delete all subcategories associated with the specified category. + /// Unique identifier of the category to delete. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/CouponSetClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/CouponSetClient.cs old mode 100644 new mode 100755 index 3196342b..00b8a37d --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/CouponSetClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/CouponSetClient.cs @@ -13,23 +13,24 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { /// - /// Use the Coupon Sets resource to view and create coupon sets. You can use coupon sets to group multiple coupon codes together and associate them with one or more discounts. Use the subresource to manage the coupon codes within manual coupon sets. Use the subresource to mange the discounts assigned to coupon sets. + /// /// public partial class CouponSetClient { /// - /// Retrieves a list of coupon sets in the catalog according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Specifies whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts in the response body. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -51,11 +52,11 @@ public partial class CouponSetClient { } /// - /// Retrieves the details of a single coupon set. Use the couponSetCode parameter to specify the coupon set. Use the includeCounts parameter to specify whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts. + /// /// - /// The unique identifier of the coupon set. - /// Specifies whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts in the response body. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// {} /// @@ -77,9 +78,9 @@ public partial class CouponSetClient { } /// - /// Returns a unique, random four character code to use for the couponSetCode. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {string} /// @@ -101,10 +102,10 @@ public static MozuClient GetUniqueCouponSetCodeClient(string responseFie } /// - /// Adds a single coupon set to the catalog. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new coupon set. + /// + /// /// /// {} /// @@ -126,9 +127,9 @@ public static MozuClient GetUniqueCouponSetCodeClient(string responseFie } /// - /// Validates the couponSetCode and tests it for uniqueness. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// /// /// /// @@ -150,11 +151,11 @@ public static MozuClient ValidateUniqueCouponSetCodeClient(string code) } /// - /// Updates one or more properties of a coupon set in the catalog. + /// /// - /// The unique identifier of the coupon set. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the updated coupon set. + /// + /// + /// /// /// {} /// @@ -176,9 +177,9 @@ public static MozuClient ValidateUniqueCouponSetCodeClient(string code) } /// - /// Deletes a specified coupon set from the catalog. Use the couponSetCode parameter to specify the coupon set to delete. + /// /// - /// The unique identifier of the coupon set. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Couponsets/AssignedDiscountClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Couponsets/AssignedDiscountClient.cs old mode 100644 new mode 100755 index 2d2a9276..912158f6 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Couponsets/AssignedDiscountClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Couponsets/AssignedDiscountClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets { /// - /// Use the AssignedDiscounts resource to manage the discounts assigned to coupon sets. + /// /// public partial class AssignedDiscountClient { /// - /// Retrieves the discountIds of any assigned discounts for the specified coupon set. + /// /// - /// The unique identifier of the coupon set. + /// /// /// {List{}} /// @@ -46,10 +47,10 @@ public partial class AssignedDiscountClient { } /// - /// Assigns or associates an existing discount to a specified coupon set. Use the couponSetCode parameter to specify the coupon set. + /// /// - /// The unique identifier of the coupon set. - /// The details of the discount assigned to the coupon set. + /// + /// /// /// /// @@ -71,10 +72,10 @@ public static MozuClient AssignDiscountClient(Mozu.Api.Contracts.ProductAdmin.As } /// - /// Unassigns or disassociates the specified discount with the specified coupon set. + /// /// - /// The unique identifier of the coupon set. - /// discountId parameter description DOCUMENT_HERE + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Couponsets/CouponClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Couponsets/CouponClient.cs old mode 100644 new mode 100755 index 06297988..0c0cd8b6 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Couponsets/CouponClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Couponsets/CouponClient.cs @@ -13,21 +13,22 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets { /// - /// Use the Coupons subresource to manage coupons within manual coupon sets. + /// /// public partial class CouponClient { /// - /// Retrieves the details of the specified coupon. Use the couponSetCode and the couponCode parameter to specify the coupon within a coupon set. Use the includeCounts paramter to specify whether to return the redemptionCount property in the response body object. + /// /// - /// Code associated with the coupon to remove from the cart. - /// The unique identifier of the coupon set that the coupon belongs to. - /// Specifies whether to return the redemptionCount property in the response body object. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// {} /// @@ -49,15 +50,15 @@ public partial class CouponClient { } /// - /// Retrieves a list of coupons in a specified coupon set according to any specified filter criteria and sort options. + /// /// - /// The unique identifier of the coupon set that the coupons belongs to. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Specifies whether to include the redemptionCount property in the response body object. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -79,10 +80,10 @@ public partial class CouponClient { } /// - /// Adds coupons to a specified manual coupon set. Use the couponSetCode parameter to specify the manual coupon set. + /// /// - /// The unique identifier of the coupon set. - /// The details necessary to assign the discount to a coupon set, including . + /// + /// /// /// /// @@ -104,10 +105,10 @@ public static MozuClient AddCouponsClient(List - /// Deletes the specified coupons and removes them from the coupon set. You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. + /// /// - /// The unique identifier of the coupon set that the coupon belongs to. - /// The unique identifiers of the coupons to delete. + /// + /// /// /// /// @@ -129,10 +130,10 @@ public static MozuClient DeleteCouponsClient(List couponCodes, string co } /// - /// Deletes the specified coupon and remove it from the coupon set. You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. + /// /// - /// Code associated with the coupon to remove from the cart. - /// The unique identifier of the coupon set that the coupon belongs to. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/DiscountClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/DiscountClient.cs old mode 100644 new mode 100755 index 60ae5b82..8eea6b58 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/DiscountClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/DiscountClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { /// - /// Use the Discounts resource to define and manage discounts to apply to products, product categories, or orders. The discounts can be a specified amount off the price, percentage off the price, or for free shipping. You can create a coupon code that shoppers can use to redeem the discount. + /// Define and manage discounts to apply to products, product categories, or orders. The discounts can be a specified amount off the price, percentage off the price, or for free shipping. Create a coupon code that shoppers can use to redeem the discount. /// public partial class DiscountClient { /// - /// Retrieves a list of discounts according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -51,10 +52,10 @@ public partial class DiscountClient { } /// - /// Retrieves the localized content specified for the specified discount. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read-only. + /// /// /// {} /// @@ -77,10 +78,10 @@ public partial class DiscountClient { } /// - /// Retrieves the details of a single discount. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read-only. + /// /// /// {} /// @@ -103,9 +104,9 @@ public partial class DiscountClient { } /// - /// Generates a random code for a coupon. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {string} /// @@ -127,10 +128,10 @@ public static MozuClient GenerateRandomCouponClient(string responseField } /// - /// Creates a new discount or coupon to apply to a product, category, order, or shipping. + /// /// - /// Use this field to include those fields which are not included by default. - /// Name of the discount added and applied to a shopping cart and order for a shopper's purchase. + /// + /// Properties of the discount to create. You must specify the discount name, amount type, start date, and target. /// /// {} /// @@ -152,11 +153,11 @@ public static MozuClient GenerateRandomCouponClient(string responseField } /// - /// Updates the localizable content for the specified discount or renames the discount without modifying its other properties. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// The container for the language-specific name of the discount. A container exists for each supported language (LocaleCode). This parameter enables you to display the discount name in multiple languages yet manage it as a single discount internally. + /// Unique identifier of the discount. System-supplied and read-only. + /// + /// The discount content to update, including the discount name. /// /// {} /// @@ -178,11 +179,11 @@ public static MozuClient GenerateRandomCouponClient(string responseField } /// - /// Updates one or more properties of the specified discount. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// Name of the discount added and applied to a shopping cart and order for a shopper's purchase. + /// Unique identifier of the discount to update. + /// + /// Properties of the discount to update. /// /// {} /// @@ -204,9 +205,9 @@ public static MozuClient GenerateRandomCouponClient(string responseField } /// - /// Deletes a discount specified by its discount ID. + /// /// - /// discountId parameter description DOCUMENT_HERE + /// Unique identifier of the discount. System-supplied and read-only. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/DiscountSettingsClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/DiscountSettingsClient.cs new file mode 100755 index 00000000..eb092331 --- /dev/null +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/DiscountSettingsClient.cs @@ -0,0 +1,84 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Commerce.Catalog.Admin +{ + /// + /// + /// + public partial class DiscountSettingsClient { + + /// + /// + /// + /// + /// + /// {} + /// + /// {} + /// + /// + /// + /// var mozuClient=GetDiscountSettings(dataViewMode, catalogId, responseFields); + /// var discountSettingsClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetDiscountSettingsClient(DataViewMode dataViewMode, int catalogId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Catalog.Admin.DiscountSettingsUrl.GetDiscountSettingsUrl(catalogId, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithHeader(Headers.X_VOL_DATAVIEW_MODE ,dataViewMode.ToString()) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=UpdateDiscountSettings( discountSettings, catalogId, responseFields); + /// var discountSettingsClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient UpdateDiscountSettingsClient(Mozu.Api.Contracts.ProductAdmin.DiscountSettings discountSettings, int catalogId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Catalog.Admin.DiscountSettingsUrl.UpdateDiscountSettingsUrl(catalogId, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(discountSettings); + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Discounts/DiscountTargetClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Discounts/DiscountTargetClient.cs old mode 100644 new mode 100755 index 1a097aa6..db8a0d28 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Discounts/DiscountTargetClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Discounts/DiscountTargetClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Discounts { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Discounts public partial class DiscountTargetClient { /// - /// Retrieves the discount target, that is which products, categories, or shipping methods are eligible for the discount. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read only. + /// /// /// {} /// @@ -48,11 +49,11 @@ public partial class DiscountTargetClient { } /// - /// Modifies properties of the discount target, for example, the dollar amount, or precentage off the price. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// 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. + /// Unique identifier of the discount. System-supplied and read-only. + /// + /// Properties of the discount target to modify. Required properties: Target.Type. Any unspecified properties are set to null and boolean variables to false. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/FacetClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/FacetClient.cs old mode 100644 new mode 100755 index 12f69fa2..0c5c0213 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/FacetClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/FacetClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin public partial class FacetClient { /// - /// Retrieves a facet specified by its unique identifier and displays its properties. + /// /// /// Unique identifier of the facet to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// Validates that the product category associated with a facet is active. System-supplied and read only. /// /// {} @@ -48,11 +49,11 @@ public partial class FacetClient { } /// - /// Retrieves a list of the facets defined for the specified category. + /// /// - /// Unique identifier of the category to modify. + /// Unique identifier of the category associated with the facets to retrieve. /// If true, returns a list of the attributes and categories associated with a product type that have not been defined as a facet for the category. - /// Use this field to include those fields which are not included by default. + /// /// Validates that the product category associated with a facet is active. System-supplied and read only. /// /// {} @@ -75,10 +76,10 @@ public partial class FacetClient { } /// - /// Creates a new category, price, or attribute facet. Define the category or attribute source to use for the facet values. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the facet used to retrieve documents. + /// + /// Properties of the new facet to create. You must specify the source, type, and category. /// /// {} /// @@ -100,11 +101,11 @@ public partial class FacetClient { } /// - /// Modifies one or more properties of a defined facet. + /// /// - /// Unique identifier of the facet to retrieve. - /// Use this field to include those fields which are not included by default. - /// Properties of the facet used to retrieve documents. + /// Unique identifier of the facet to modify. + /// + /// Properties of the defined facet to modify. /// /// {} /// @@ -126,9 +127,9 @@ public partial class FacetClient { } /// - /// Deletes the facet specified by its unique identifier. + /// /// - /// Unique identifier of the facet to retrieve. + /// Unique identifier of the facet to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/LocationInventoryClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/LocationInventoryClient.cs old mode 100644 new mode 100755 index e7d2f5c3..fb7fd2e1 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/LocationInventoryClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/LocationInventoryClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin public partial class LocationInventoryClient { /// - /// Retrieves the details of a product's active inventory at the location specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// User-defined code that uniquely identifies the location. + /// + /// /// {} /// /// {} @@ -50,15 +51,15 @@ public partial class LocationInventoryClient { } /// - /// Retrieves a list of all product inventory definitions for the location code specified in the request. + /// /// - /// 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" - /// Functions that optimize commonly used filters for efficiency.For the operation, you have access to the filter function. For example, use to filter only for product inventory that is currently active. - /// The unique, user-defined code that identifies a location. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// + /// /// {} /// /// {} @@ -82,12 +83,12 @@ public partial class LocationInventoryClient { } /// - /// Creates an array of product inventory definitions for the location specified in the request. When adding a new inventory definition, you must specify the productCode and stockOnHand value in each array you define. All other properties are system-supplied and read only. + /// /// - /// The unique, user-defined code that identifies a location. - /// Query string parameter lets the service perform an update for a new or existing record. When run, the update occurs without throwing a conflict exception that the record exists. If true, the updates completes regardless of the record currently existing. By default, if no value is specified, the service assumes this value is false. + /// User-defined code that uniquely identifies the location. + /// /// {} - /// Properties of an inventory definition that defines the level of inventory for a specific product at a given location. + /// Array list of product inventory definitions for all associated locations. For each location inventory in the list, define the productCode and stockOnHand values. /// /// {List{}} /// @@ -110,11 +111,11 @@ public partial class LocationInventoryClient { } /// - /// Updates the active stock on hand inventory of products for the location code specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. + /// User-defined code that uniquely identifies the location. /// {} - /// Properties of an adjustment to the active product inventory of a specific location. + /// Properties of the inventory adjustments to perform for the specified location. /// /// {List{}} /// @@ -137,10 +138,10 @@ public partial class LocationInventoryClient { } /// - /// Deletes the product code inventory definition for the location specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// User-defined code that uniquely identifies the location. + /// /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/MasterCatalogClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/MasterCatalogClient.cs old mode 100644 new mode 100755 index d14797f1..75baee09 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/MasterCatalogClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/MasterCatalogClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin public partial class MasterCatalogClient { /// - /// Retrieve the details of all master catalog associated with a tenant. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -46,10 +47,10 @@ public partial class MasterCatalogClient { } /// - /// Retrieve the details of the master catalog specified in the request. + /// /// - /// The unique identifier of the master catalog associated with the entity. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// {} /// @@ -71,11 +72,11 @@ public partial class MasterCatalogClient { } /// - /// Updates the product publishing mode for the master catalog specified in the request. + /// /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a master product catalog defined for a tenant. All catalogs and sites associated with a master catalog share product definitions. + /// + /// Properties of the master catalog to update, which consists of the product publishing mode. Possible values are "Pending" which saves product updates in draft mode until they are published, and "Live" which publishes all product changes immediately. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/PriceListClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/PriceListClient.cs old mode 100644 new mode 100755 index fe239ff5..648d40f7 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/PriceListClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/PriceListClient.cs @@ -13,22 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { /// - /// Use the Price Lists resource to view and create price lists. You can use price lists to override the catalog pricing of products for specific customer segments and/or sites. You can override products' list price, sale price, advanced pricing information such as MSRP, cost, MAP, and the catalog price of any extras associated with the product in a price list. You can also restrict discounts from applying to the overridden product pricing in a price list. Refer to [Price Lists](../../../guides/catalog/price-lists.htm) in the Guides section for more information about price lists. + /// /// public partial class PriceListClient { /// - /// Retrieves a list of price lists according to any specified facets, filter criteria, and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class PriceListClient { } /// - /// Retrieves the details of the specified price list. + /// /// - /// The unique, user-defined code of the price list. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class PriceListClient { } /// - /// Adds a new price list to the tenant. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new price list. + /// + /// /// /// {} /// @@ -100,10 +101,10 @@ public partial class PriceListClient { } /// - /// Adds up to 5000 new price list entries in bulk. + /// /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to adding price list entries to the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. + /// + /// /// /// /// @@ -126,10 +127,10 @@ public static MozuClient BulkAddPriceListEntriesClient(List - /// Deletes up to 5000 price list entries in bulk. + /// /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to deleting price list entries from the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. + /// + /// /// /// /// @@ -152,10 +153,10 @@ public static MozuClient BulkDeletePriceListEntriesClient(List - /// Updates up to 5000 price list entries in bulk. + /// /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to updating price list entries in the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. + /// + /// /// /// /// @@ -178,11 +179,11 @@ public static MozuClient BulkUpdatePriceListEntriesClient(List - /// Updates the details of the specified price list. + /// /// - /// The unique, user-defined code of the price list. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the updated price list. + /// + /// + /// /// /// {} /// @@ -204,10 +205,10 @@ public static MozuClient BulkUpdatePriceListEntriesClient(List - /// Deletes the specified price list from the tenant. + /// /// - /// Specifies whether to deletes all price list entries associated with the price list. - /// The unique, user-defined code of the price list. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Pricelists/PriceListEntryClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Pricelists/PriceListEntryClient.cs old mode 100644 new mode 100755 index 0d9d7931..7bd37a50 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Pricelists/PriceListEntryClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Pricelists/PriceListEntryClient.cs @@ -13,22 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists { /// - /// Use the Entries sub-resource to interact with price list entries. Price list entries enable you to override product pricing as well as control what products shoppers can view and purchase when the price list is exclusive. Refer to the [Price Lists](../../../guides/catalog/price-lists.htm) guides topic for more information. + /// /// public partial class PriceListEntryClient { /// - /// Retrieves the details of a price list entry. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique code of the price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The start date of the price list entry. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,14 +51,14 @@ public partial class PriceListEntryClient { } /// - /// Retrieves a list of price list entries associated with the specified price list according to any specified facets, filter criteria, and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// The unique code of the price list associated with the price list entry. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -79,11 +80,11 @@ public partial class PriceListEntryClient { } /// - /// Adds a new price list entry to the specified price list. + /// /// - /// The specified price list to which you want to add the price list entry. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new price list entry. + /// + /// + /// /// /// {} /// @@ -105,14 +106,14 @@ public partial class PriceListEntryClient { } /// - /// Updates the details of a price list entry. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique code of the price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The start date of the price list entry. - /// The updated details of the price list entry. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -134,12 +135,12 @@ public partial class PriceListEntryClient { } /// - /// Deletes a price list entry. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The code of the specified price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The start date of the price list entry. + /// + /// + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/ProductClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/ProductClient.cs old mode 100644 new mode 100755 index 811d4f43..79f6a0ac --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/ProductClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/ProductClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { @@ -22,14 +23,14 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin public partial class ProductClient { /// - /// Retrieves a list of products according to any specified facets, filter criteria, and sort options. + /// /// - /// 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" + /// /// If true, the operation does not return the TotalCount number of results. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// + /// A list of product search terms to use in the query when searching across product code and product name. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -54,9 +55,9 @@ public partial class ProductClient { } /// - /// Retrieves a product that is associated with one or more specific catalogs. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// {List{}} /// @@ -79,11 +80,11 @@ public partial class ProductClient { } /// - /// Retrieves the details of a product associated with a specific catalog. + /// /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// {} /// @@ -106,10 +107,10 @@ public partial class ProductClient { } /// - /// Retrieves the details of a product definition. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// {} /// @@ -132,10 +133,10 @@ public partial class ProductClient { } /// - /// Creates a new product definition in the specified master catalog. + /// /// - /// Use this field to include those fields which are not included by default. - /// The properties of a product, referenced and used by carts, orders, wish lists, and returns. + /// + /// Properties of the new product. You must supply values for the product code, product name, and price. /// /// {} /// @@ -158,11 +159,11 @@ public partial class ProductClient { } /// - /// Associates a new product defined in the master catalog with a specific catalog. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of a product associated with a specific catalog. + /// + /// + /// Properties of the product to define for the specific catalog association. /// /// {} /// @@ -185,9 +186,9 @@ public partial class ProductClient { } /// - /// Performs an update to a product code by renaming or replacing the current product code with a new one. + /// /// - /// Properties for a product code current and changed content. + /// /// /// /// @@ -209,10 +210,10 @@ public static MozuClient RenameProductCodesClient(List - /// Updates the properties of a product specific to each catalog associated with the product. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Properties of a product associated with a specific catalog. + /// + /// Properties of the product to update for each associated catalog. /// /// {List{}} /// @@ -235,12 +236,12 @@ public static MozuClient RenameProductCodesClient(List - /// Updates one or more properties of a product associated with a specific catalog. + /// /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of a product associated with a specific catalog. + /// + /// + /// + /// Properties of the product associated with the catalog specified in the request. /// /// {} /// @@ -263,11 +264,11 @@ public static MozuClient RenameProductCodesClient(List - /// Updates one or more properties of a product definition in a master catalog. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// The properties of a product, referenced and used by carts, orders, wish lists, and returns. + /// + /// + /// Properties of the product definition to update in the master catalog. /// /// {} /// @@ -290,9 +291,9 @@ public static MozuClient RenameProductCodesClient(List - /// Deletes the specified product from a master catalog. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// /// /// /// @@ -315,10 +316,10 @@ public static MozuClient DeleteProductClient(DataViewMode dataViewMode, string p } /// - /// Removes the product association defined for a specific catalog. + /// /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/ProductReservationClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/ProductReservationClient.cs old mode 100644 new mode 100755 index 3b2374fe..e6cbedf1 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/ProductReservationClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/ProductReservationClient.cs @@ -13,21 +13,22 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { /// - /// Use the Product Reservations resource to temporarily hold a product from inventory while a shopper is filling out payment information. You can create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete. + /// Temporarily hold a product from inventory while a shopper is filling out payment information. Create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete. /// public partial class ProductReservationClient { /// - /// Retrieves a list of product reservations according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// + /// + /// Used to page results from a query. Indicates the maximum number of entities to return from a query. Default value: 20. Max value: 200. + /// + /// The element to sort the results by and the order in which the results appear. Either ascending order (a-z) which accepts 'asc' or 'asc' or descending order (z-a) which accepts 'desc' or 'desc'. The sortBy parameter follows an available property. /// /// {} /// @@ -52,10 +53,10 @@ public partial class ProductReservationClient { } /// - /// Retrieves the details of a product reservation. + /// /// /// Unique identifier of the product reservation. - /// Use this field to include those fields which are not included by default. + /// /// {} /// /// {} @@ -79,11 +80,11 @@ public partial class ProductReservationClient { } /// - /// Creates a new product reservation for a product. This action places a hold on the product inventory for the quantity specified during the ordering process. + /// /// /// If true, skip the process to validate inventory when creating this product reservation. /// {} - /// A hold placed on product inventory for a particular product so that the quantity specified is set aside and available for purchase during the ordering process. + /// Details of the product reservations to add. /// /// {List{}} /// @@ -106,10 +107,10 @@ public partial class ProductReservationClient { } /// - /// Commits a product reservation to decrement the product's inventory by the quantity specified then release the reservation once the order process completed successfully. + /// /// /// {} - /// A hold placed on product inventory for a particular product so that the quantity specified is set aside and available for purchase during the ordering process. + /// List of unique identifiers of the reservations to commit. /// /// /// @@ -132,11 +133,11 @@ public static MozuClient CommitReservationsClient(DataViewMode dataViewMode, Lis } /// - /// Updates an existing product reservation for a product. + /// /// - /// If true, skip the process to validate inventory when creating this product reservation. + /// If true, skip the inventory validation process when updating this product reservation. /// {} - /// A hold placed on product inventory for a particular product so that the quantity specified is set aside and available for purchase during the ordering process. + /// Properties of the product reservations to update. /// /// {List{}} /// @@ -159,9 +160,9 @@ public static MozuClient CommitReservationsClient(DataViewMode dataViewMode, Lis } /// - /// Deletes a product reservation. For example, delete a reservation when an order is not processed to return the product quantity back to inventory. + /// /// - /// Unique identifier of the product reservation. + /// Unique identifier of the reservation. /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/LocationInventoryClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/LocationInventoryClient.cs old mode 100644 new mode 100755 index eb7c8b7b..9f475d38 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/LocationInventoryClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/LocationInventoryClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products { @@ -22,14 +23,14 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products public partial class LocationInventoryClient { /// - /// Retrieves all locations for which a product has inventory defined and displays the inventory definition properties of each location. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -52,11 +53,11 @@ public partial class LocationInventoryClient { } /// - /// Retrieves the details of the inventory of the product in the location specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the location. + /// + /// /// /// {} /// @@ -79,11 +80,11 @@ public partial class LocationInventoryClient { } /// - /// Creates a new location inventory definition for the product code specified in the request. + /// /// - /// Query string parameter lets the service perform an update for a new or existing record. When run, the update occurs without throwing a conflict exception that the record exists. If true, the updates completes regardless of the record currently existing. By default, if no value is specified, the service assumes this value is false. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Properties of an inventory definition that defines the level of inventory for a specific product at a given location. + /// The performUpserts query string parameter lets the service perform an update if the record already exists instead of throwing an already exists conflict exception. PerformUpserts=true means it updates if the record already exists. By default, no value specified means that the service assumes PerformUpserts=false. + /// + /// Array list of the location inventory definitions associated with the product code specified in the request. For each location, you must define the locationCode value and the stockOnHand value. All other properties in the array are system-supplied and read only. /// /// {List{}} /// @@ -106,10 +107,10 @@ public partial class LocationInventoryClient { } /// - /// Updates the current level of stock at each location associated with the product code specified in the request. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Properties of an adjustment to the active product inventory of a specific location. + /// The product code of the product for which to update active stock on hand inventory at a specified location. + /// Properties of the inventory adjustments to perform for the specified location. /// /// {List{}} /// @@ -132,10 +133,10 @@ public partial class LocationInventoryClient { } /// - /// Deletes the location inventory definition for the product code specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// The code that identifies the location for which to delete product inventory. + /// The product code for which to delete a location's inventory. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductExtraClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductExtraClient.cs old mode 100644 new mode 100755 index d968b9a2..5b2bb974 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductExtraClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductExtraClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products public partial class ProductExtraClient { /// - /// Retrieves a list of extras configured for the product according to any defined filter and sort criteria. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// {List{}} /// @@ -47,11 +48,11 @@ public partial class ProductExtraClient { } /// - /// Retrieves a collection of all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// /// /// {List{}} /// @@ -74,13 +75,13 @@ public partial class ProductExtraClient { } /// - /// Retrieves the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// + /// /// /// {} /// @@ -103,11 +104,11 @@ public partial class ProductExtraClient { } /// - /// Retrieves the details of an extra attribute configuration for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// {} /// @@ -130,13 +131,13 @@ public partial class ProductExtraClient { } /// - /// Adds a localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// The properties of the price difference between the product extra and the base product. + /// + /// + /// + /// + /// /// /// {} /// @@ -159,11 +160,11 @@ public partial class ProductExtraClient { } /// - /// Configure an extra attribute for the product specified in the request. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of an extra attribute to defined for a product that is associated with a product type that uses the extra. Setting up extras for a product enables shopper-entered information, such as initials for a monogram. + /// + /// + /// Properties of the product extra to configure for the specified product. /// /// {} /// @@ -186,12 +187,12 @@ public partial class ProductExtraClient { } /// - /// Updates all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. - /// The properties of the price difference between the product extra and the base product. + /// + /// + /// + /// /// /// {List{}} /// @@ -214,14 +215,14 @@ public partial class ProductExtraClient { } /// - /// Updates the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// The properties of the price difference between the product extra and the base product. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -244,12 +245,12 @@ public partial class ProductExtraClient { } /// - /// Updates the configuration of an extra attribute for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of an extra attribute to defined for a product that is associated with a product type that uses the extra. Setting up extras for a product enables shopper-entered information, such as initials for a monogram. + /// + /// + /// + /// Properties of the extra attribute to update for the specified product. /// /// {} /// @@ -272,10 +273,10 @@ public partial class ProductExtraClient { } /// - /// Delete a product extra configuration for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// + /// /// /// /// @@ -298,12 +299,12 @@ public static MozuClient DeleteExtraClient(DataViewMode dataViewMode, string pro } /// - /// Deletes the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. + /// + /// + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductOptionClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductOptionClient.cs old mode 100644 new mode 100755 index b2008a55..b9d30c5f --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductOptionClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductOptionClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products public partial class ProductOptionClient { /// - /// Retrieves a list of all option attributes configured for the product specified in the request. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// {List{}} /// @@ -47,11 +48,11 @@ public partial class ProductOptionClient { } /// - /// Retrieves the details of an option attribute configuration for the specified product. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// {} /// @@ -74,11 +75,11 @@ public partial class ProductOptionClient { } /// - /// Configures an option attribute for the product specified in the request. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. + /// + /// + /// Properties of the option attribute to define for the product. /// /// {} /// @@ -101,12 +102,12 @@ public partial class ProductOptionClient { } /// - /// Updates one or more properties of an option attribute configured for a product. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. + /// + /// + /// + /// Properties of the product option attribute configuration to update. /// /// {} /// @@ -129,10 +130,10 @@ public partial class ProductOptionClient { } /// - /// Deletes the configuration of an option attribute for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductPropertyClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductPropertyClient.cs old mode 100644 new mode 100755 index 65cca7af..2c1a0cab --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductPropertyClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductPropertyClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products public partial class ProductPropertyClient { /// - /// Retrieves a list of the property attributes configured for the product specified in the request. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// /// /// {List{}} /// @@ -47,11 +48,11 @@ public partial class ProductPropertyClient { } /// - /// Retrieves a collection of property values for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// /// /// {List{}} /// @@ -74,13 +75,13 @@ public partial class ProductPropertyClient { } /// - /// Retrieves the property value for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// + /// /// /// {} /// @@ -103,11 +104,11 @@ public partial class ProductPropertyClient { } /// - /// Retrieves the details of a property attribute configuration for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// {} /// @@ -130,13 +131,13 @@ public partial class ProductPropertyClient { } /// - /// Adds a property value for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// Use this field to include those fields which are not included by default. + /// + /// + /// + /// + /// /// /// {} /// @@ -159,11 +160,11 @@ public partial class ProductPropertyClient { } /// - /// Configures a property attribute for the product specified in the request. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// Details of a property defined for a product. + /// + /// + /// Properties of the property attribute to configure for a product. /// /// {} /// @@ -186,12 +187,12 @@ public partial class ProductPropertyClient { } /// - /// Updates all property values for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. - /// Content of the product property value in the language defined for the locale code. + /// + /// + /// + /// /// /// {List{}} /// @@ -214,14 +215,14 @@ public partial class ProductPropertyClient { } /// - /// Updates the property value for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// Content of the product property value in the language defined for the locale code. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -244,12 +245,12 @@ public partial class ProductPropertyClient { } /// - /// Update one or more details of a property attribute configuration for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// Details of a property defined for a product. + /// + /// + /// + /// Details of the property attribute to update for the product configuration. /// /// {} /// @@ -272,10 +273,10 @@ public partial class ProductPropertyClient { } /// - /// Deletes the configuration of a property attribute for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// + /// /// /// /// @@ -298,12 +299,12 @@ public static MozuClient DeletePropertyClient(DataViewMode dataViewMode, string } /// - /// Deletes the property value for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductVariationClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductVariationClient.cs old mode 100644 new mode 100755 index c7712548..be7af33d --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductVariationClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/Products/ProductVariationClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Admin.Products public partial class ProductVariationClient { /// - /// Retrieves a collection of the localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// /// /// {List{}} /// @@ -48,12 +49,12 @@ public partial class ProductVariationClient { } /// - /// Retrieves the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// + /// /// /// {} /// @@ -76,10 +77,10 @@ public partial class ProductVariationClient { } /// - /// Retrieves a list of details of the localized price values for a product variation. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// /// /// {List{}} /// @@ -102,12 +103,12 @@ public partial class ProductVariationClient { } /// - /// Retrieves the details of the localized price value for a product variation and a specific localized currency. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// + /// /// /// {} /// @@ -130,10 +131,10 @@ public partial class ProductVariationClient { } /// - /// Retrieves the details of a product variation based on the supplied product code and variation key. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// System-generated key that represents the attribute values that uniquely identify a specific product variation. /// /// {} @@ -157,14 +158,14 @@ public partial class ProductVariationClient { } /// - /// Retrieves a list of the product variations configured for the specified product code. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -187,12 +188,12 @@ public partial class ProductVariationClient { } /// - /// Adds the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2". + /// + /// + /// + /// /// /// {} /// @@ -215,12 +216,12 @@ public partial class ProductVariationClient { } /// - /// Adds the localized price value for a product variation and a specific localized currency. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The details of the product variation localized price. + /// + /// + /// + /// /// /// {} /// @@ -243,11 +244,11 @@ public partial class ProductVariationClient { } /// - /// Updates all localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2". + /// + /// + /// /// /// {List{}} /// @@ -270,13 +271,13 @@ public partial class ProductVariationClient { } /// - /// Updates the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2". + /// + /// + /// + /// + /// /// /// {} /// @@ -299,11 +300,11 @@ public partial class ProductVariationClient { } /// - /// Updates a list of localized price values for a product variation. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The details of the product variation localized price. + /// + /// + /// /// /// {List{}} /// @@ -326,13 +327,13 @@ public partial class ProductVariationClient { } /// - /// Updates the localized price value for a product variation and a specific localized currency. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The details of the product variation localized price. + /// + /// + /// + /// + /// /// /// {} /// @@ -355,12 +356,12 @@ public partial class ProductVariationClient { } /// - /// Modifies the details of a variation, based on the supplied variation key, for the specified product code. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// Properties of a specific product variation. + /// Wrapper for the properties of the specified product variation. /// /// {} /// @@ -383,11 +384,11 @@ public partial class ProductVariationClient { } /// - /// Modifies the collection of variations for the specified product code. Because this PUT replaces the existing resource, supply all information necessary to maintain for the product variation. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Collection of variations configured for a product. + /// + /// + /// Wrapper for the collection of variations configured for the specified product code. /// /// {} /// @@ -410,9 +411,9 @@ public partial class ProductVariationClient { } /// - /// Deletes a variation, based on the supplied variation key, for the specified product code. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// System-generated key that represents the attribute values that uniquely identify a specific product variation. /// /// @@ -436,11 +437,11 @@ public static MozuClient DeleteProductVariationClient(DataViewMode dataViewMode, } /// - /// Deletes the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// /// /// /// @@ -463,11 +464,11 @@ public static MozuClient DeleteProductVariationLocalizedDeltaPriceClient(DataVie } /// - /// Deletes the localized price value for a product variation and a specific localized currency. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/PublishingScopeClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/PublishingScopeClient.cs old mode 100644 new mode 100755 index 43046aab..f43d7dde --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/PublishingScopeClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/PublishingScopeClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { /// - /// Use the Product Publishing resource to publish or discard pending changes to products in a master catalog, or to add or remove pending changes to and from product publish sets.You can use product publish sets to group pending product changes together and publish them all at the same time. + /// Use the Product Publishing resource to publish or discard pending changes to product definitions in the master catalog. /// public partial class PublishingScopeClient { /// - /// Retrieves the details of the specified product publish set. + /// /// - /// The unique identifier of the publish set. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} /// /// {} @@ -48,9 +49,9 @@ public partial class PublishingScopeClient { } /// - /// Retrieves a list of product publish sets and their properties, including the amount of pending product changes that are included in each one. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// {} /// /// {} @@ -73,10 +74,10 @@ public partial class PublishingScopeClient { } /// - /// Deletes the draft version of product changes (pending product changes) for each product code specified in the request. + /// /// /// {} - /// Describes the scope of the product publishing update, which can include individual product codes or all pending changes. + /// Properties of the pending product changes to include in this operation. /// /// /// @@ -99,10 +100,10 @@ public static MozuClient DiscardDraftsClient(DataViewMode dataViewMode, Mozu.Api } /// - /// Publishes the draft version of product changes (pending product changes) for each product code specified in the request, and changes the product publish state to "live". + /// /// /// {} - /// Describes the scope of the product publishing update, which can include individual product codes or all pending changes. + /// Properties of the pending product changes to include in this operation. /// /// /// @@ -125,11 +126,11 @@ public static MozuClient PublishDraftsClient(DataViewMode dataViewMode, Mozu.Api } /// - /// Assigns pending product changes to a specified product publish set. Use the code field to specify the product publish set. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// {} - /// The details of the publish to which you want to assign products. + /// /// /// {} /// @@ -151,10 +152,10 @@ public static MozuClient PublishDraftsClient(DataViewMode dataViewMode, Mozu.Api } /// - /// Deletes the specified product publish set. If you set the discardDrafts parameter to true, this operation also deletes the product drafts assigned to the publish set. + /// /// - /// Specifies whether to discard all the drafts assigned to the publish set when the publish set is deleted. - /// The unique identifier of the publish set. + /// + /// /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/SearchClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/SearchClient.cs old mode 100644 new mode 100755 index f7f56780..7b11192d --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/SearchClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/SearchClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { /// - /// Use the Search resource to manage all settings and options for providing product search on your site, as well as search tuning rules. + /// /// public partial class SearchClient { /// - /// Retrieves the details of the specified search tuning rule. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the search tuning rule. + /// + /// /// /// {} /// @@ -47,13 +48,13 @@ public partial class SearchClient { } /// - /// Retrieves a list of search tuning rules and their properties. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// {} /// @@ -75,9 +76,9 @@ public partial class SearchClient { } /// - /// Retrieves the details of the specified search tuning rule sort fields. Sort fields allow you to control the product relevance whenver shoppers sort products on a page. For more information about sort relevance, refer to [Search Tuning Rules and Sorting](../../../developer/api-guides/search-tuning-rules.htm#search_tuning_rules_and_sorting). + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// @@ -99,9 +100,9 @@ public partial class SearchClient { } /// - /// Retrieves the search settings for the specified site.Refer to [Search Settings API Overview](../../../../developer/api-guides/search-settings.htm) for more information about 's search settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// @@ -123,10 +124,10 @@ public partial class SearchClient { } /// - /// Retrieves a collection of synonyms definitions for product searches.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -148,13 +149,13 @@ public partial class SearchClient { } /// - /// Retrieves a list of synonym definitions according to any specified filter criteria and sort options.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// {} /// @@ -176,10 +177,10 @@ public partial class SearchClient { } /// - /// Retrieves the details of the specified synonym defintion.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the synonym definition. + /// + /// /// /// {} /// @@ -201,10 +202,10 @@ public partial class SearchClient { } /// - /// Creates a search tuning rule for your site. You can use search tuning rules to fine tune the product search results that appear when a shopper searches for a specific keyword, or navigates to a category page.For more information on search tuning rules, refer to [Search Tuning Rules](../../../../developer/api-guides/search-tuning-rules.htm). + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new search tuning rule. + /// + /// /// /// {} /// @@ -226,10 +227,10 @@ public partial class SearchClient { } /// - /// Updates the details of the search tuning rule sort fields. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the updated search tuning rule sort fields. + /// + /// /// /// {} /// @@ -251,11 +252,11 @@ public partial class SearchClient { } /// - /// Updates a collection of synonym definitions.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The updated details of the synonym definition collection. + /// + /// + /// /// /// {} /// @@ -277,10 +278,10 @@ public partial class SearchClient { } /// - /// Creates a new synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new synonym definition. + /// + /// /// /// {} /// @@ -302,11 +303,11 @@ public partial class SearchClient { } /// - /// Updates the details of the specified search tuning rule. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the search tuning rule. - /// The details of the updated search tuning rule. + /// + /// + /// /// /// {} /// @@ -328,10 +329,10 @@ public partial class SearchClient { } /// - /// Updates the search setting properties for a specific site.Refer to [Search Settings API Overview](../../../../developer/api-guides/search-settings.htm) for more information about 's search settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The search settings to update. + /// + /// /// /// {} /// @@ -353,11 +354,11 @@ public partial class SearchClient { } /// - /// Updates the details of a synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the synonym definition. - /// The updated synonym definition details. + /// + /// + /// /// /// {} /// @@ -379,9 +380,9 @@ public partial class SearchClient { } /// - /// Deletes the specified search tuning rule from the site. + /// /// - /// The unique identifier of the search tuning rule. + /// /// /// /// @@ -403,9 +404,9 @@ public static MozuClient DeleteSearchTuningRuleClient(string searchTuningRuleCod } /// - /// Deletes the specified synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// The unique identifier of the synonym definition. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Admin/SoftAllocationClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Admin/SoftAllocationClient.cs old mode 100644 new mode 100755 index f3156036..2b24ca79 --- a/Mozu.Api/Clients/Commerce/Catalog/Admin/SoftAllocationClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Admin/SoftAllocationClient.cs @@ -13,22 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Admin { /// - /// The Soft Allocations resource allows you to temporarily hold a product from inventory while a shopper is filling out payment information. You create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete. + /// /// public partial class SoftAllocationClient { /// - /// Retrieves a list of sof allocations according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// {} /// /// {} @@ -51,10 +52,10 @@ public partial class SoftAllocationClient { } /// - /// Retrieves the details of a soft allocation. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the soft allocation. + /// + /// /// {} /// /// {} @@ -77,10 +78,10 @@ public partial class SoftAllocationClient { } /// - /// Creates a new soft allocation for a product. This places a hold on the product inventory for the quantity specified during the ordering process. + /// /// /// {} - /// The details of the new soft allocation. + /// /// /// {List{}} /// @@ -102,10 +103,10 @@ public partial class SoftAllocationClient { } /// - /// Converts a set of existing soft product allocations into product reservations. + /// /// /// {} - /// The details of the soft allocation which you want to convert into product reservations. + /// /// /// {List{}} /// @@ -127,10 +128,10 @@ public partial class SoftAllocationClient { } /// - /// Updates the expiration time for a set of soft allocations in a non-transactional batch. + /// /// /// {} - /// The details of the soft allocation that you want to renew. + /// /// /// {List{}} /// @@ -152,10 +153,10 @@ public partial class SoftAllocationClient { } /// - /// Updates a soft allocation. This updates a hold on the product inventory for the quantity specified during the ordering process. + /// /// /// {} - /// The details of the updated soft allocations. + /// /// /// {List{}} /// @@ -177,9 +178,9 @@ public partial class SoftAllocationClient { } /// - /// Deletes a soft allocation. You might delete a soft allocation when an order or cart is not processed in order to return the product quantity back to inventory. + /// /// - /// The unique identifier of the soft allocation. + /// /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Storefront/CategoryClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Storefront/CategoryClient.cs old mode 100644 new mode 100755 index d75654ac..476b96fe --- a/Mozu.Api/Clients/Commerce/Catalog/Storefront/CategoryClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Storefront/CategoryClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Storefront { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Storefront public partial class CategoryClient { /// - /// Retrieves a list of categories according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product category search results by any of its properties, including its position in the category hierarchy. 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" + /// + /// /// /// /// @@ -51,11 +52,11 @@ public partial class CategoryClient { } /// - /// Retrieves the details of a single category. + /// /// /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// Unique identifier for the storefront container used to organize products. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// Unique identifier of the product category. + /// /// /// {} /// @@ -78,9 +79,9 @@ public partial class CategoryClient { } /// - /// Retrieves the list of product categories that appear on the storefront organized in a hierarchical format. Hidden categories do not appear in the list. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Storefront/OrderTaxContextClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Storefront/OrderTaxContextClient.cs old mode 100644 new mode 100755 index 82ab7ca8..e60c155b --- a/Mozu.Api/Clients/Commerce/Catalog/Storefront/OrderTaxContextClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Storefront/OrderTaxContextClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Storefront { /// - /// Use the Storefront Tax resource to retrieve tax information from the storefront. + /// /// public partial class OrderTaxContextClient { /// - /// Retrieves tax information applicable to the site. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// {} diff --git a/Mozu.Api/Clients/Commerce/Catalog/Storefront/PriceListClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Storefront/PriceListClient.cs old mode 100644 new mode 100755 index c502f6b6..8942839d --- a/Mozu.Api/Clients/Commerce/Catalog/Storefront/PriceListClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Storefront/PriceListClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Storefront { /// - /// Retrieves the details of a price list. The details may contain a hierarchy of ancestor and/or descendant price lists dependening on your configuration. + /// /// public partial class PriceListClient { /// - /// Retrieves the details of the specified price list. + /// /// - /// The unique code of the price list for which you want to retrieve the details. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -47,10 +48,10 @@ public partial class PriceListClient { } /// - /// Retrieves the details of a price list to which the specified customer resolves. This is primarly used when creating an offline order for a shopper.You can use this operation alongside custom Arc.js actions to alter the price list to which a shopper resolves. + /// /// - /// The unique identifier of the customer account for which to retrieve wish lists. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Storefront/ProductClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Storefront/ProductClient.cs old mode 100644 new mode 100755 index ad4daff1..96525a76 --- a/Mozu.Api/Clients/Commerce/Catalog/Storefront/ProductClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Storefront/ProductClient.cs @@ -13,22 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Storefront { /// - /// Use the Storefront Products resource to manage the shopper product selection process during a visit to the web storefront. You can update product options as shoppers pick and choose their product choices. A shopper cannot add a product to a cart until all of its required options have been selected. + /// Use the Storefront Products resource to manage the shopper product selection process during a visit to the web storefront. You can update product options as shoppers pick and choose their product choices. A shopper cannot add a product to a cart until all of its required options have been selected. /// public partial class ProductClient { /// - /// Retrieves a list of products that appear on the web storefront according to any specified filter criteria and sort options. + /// /// - /// In your first deep paged request, set this parameter to . Then, in all subsequent requests, set this parameter to the subsequent values of that's returned in each response to continue paging through the results. Continue this pattern until is null, which signifies the end of the paged results. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Options you can specify for the response. This parameter is null by default.You can primarily use this parameter to return volume price band information in product details, which you can then display on category pages and search results depanding on your theme configuration. To return volume price band information, set this parameter to . + /// + /// + /// Used to page results from a query. Indicates the maximum number of entities to return from a single query. Default value: 20. Maximum value: 200. + /// + /// /// /// /// @@ -53,11 +54,11 @@ public partial class ProductClient { } /// - /// Retrieves the active inventory level information associated with the product or location specified in the request. + /// /// /// Array of location codes for which to retrieve product inventory information. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -80,28 +81,29 @@ public partial class ProductClient { } /// - /// Retrieves information about a single product given its product code. + /// /// - /// Specifies whether to accept a product variant's code as the .When you set this parameter to , you can pass in a product variant's code in the GetProduct call to retrieve the product variant details that are associated with the base product. - /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. - /// Specifies whether to supress the 404 error when the product is out of stock. + /// + /// If true, returns an inactive product as part of the query. + /// + /// + /// + /// + /// If true, skip the inventory validation process for the specified product. + /// /// Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. /// /// {} /// /// /// - /// var mozuClient=GetProduct(dataViewMode, productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, responseFields); + /// var mozuClient=GetProduct(dataViewMode, productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, purchaseLocation, responseFields); /// var productClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient GetProductClient(DataViewMode dataViewMode, string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, int? quantity = null, bool? acceptVariantProductCode = null, string responseFields = null) + public static MozuClient GetProductClient(DataViewMode dataViewMode, string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, int? quantity = null, bool? acceptVariantProductCode = null, string purchaseLocation = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.Catalog.Storefront.ProductUrl.GetProductUrl(productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, responseFields); + var url = Mozu.Api.Urls.Commerce.Catalog.Storefront.ProductUrl.GetProductUrl(productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, purchaseLocation, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -112,12 +114,12 @@ public partial class ProductClient { } /// - /// Retrieves information about a single product given its product code for to index in the search engine + /// /// - /// The date when the product was last updated. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The product version. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// {} /// @@ -140,26 +142,27 @@ public partial class ProductClient { } /// - /// Creates a new product configuration each time a shopper selects a product option value. After the shopper defines values for all required product options, the shopper can add the product configuration to a cart. + /// /// /// If true, the response returns details about the product. If false, returns a product summary such as the product name, price, and sale price. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. + /// + /// + /// + /// + /// If true, skip the inventory validation process for the specified product. /// For a product with shopper-configurable options, the properties of the product options selected by the shopper. /// /// {} /// /// /// - /// var mozuClient=ConfiguredProduct( productOptionSelections, productCode, includeOptionDetails, skipInventoryCheck, quantity, responseFields); + /// var mozuClient=ConfiguredProduct( productOptionSelections, productCode, includeOptionDetails, skipInventoryCheck, quantity, purchaseLocation, responseFields); /// var configuredProductClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient ConfiguredProductClient(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, int? quantity = null, string responseFields = null) + public static MozuClient ConfiguredProductClient(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, int? quantity = null, string purchaseLocation = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.Catalog.Storefront.ProductUrl.ConfiguredProductUrl(productCode, includeOptionDetails, skipInventoryCheck, quantity, responseFields); + var url = Mozu.Api.Urls.Commerce.Catalog.Storefront.ProductUrl.ConfiguredProductUrl(productCode, includeOptionDetails, skipInventoryCheck, quantity, purchaseLocation, responseFields); const string verb = "POST"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -169,26 +172,27 @@ public partial class ProductClient { } /// - /// Validate the final state of shopper-selected options. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// Normally, product validation applies default extras to products that do not have options specified. If , product validation does not apply default extras to products. - /// If true, skip the process to validate inventory when creating this product reservation. + /// + /// + /// + /// + /// + /// If true, skip the inventory validation process for the specified product. /// For a product with shopper-configurable options, the properties of the product options selected by the shopper. /// /// {} /// /// /// - /// var mozuClient=ValidateProduct( productOptionSelections, productCode, skipInventoryCheck, quantity, skipDefaults, responseFields); + /// var mozuClient=ValidateProduct( productOptionSelections, productCode, skipInventoryCheck, quantity, skipDefaults, purchaseLocation, responseFields); /// var productValidationSummaryClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient ValidateProductClient(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? skipInventoryCheck = null, int? quantity = null, bool? skipDefaults = null, string responseFields = null) + public static MozuClient ValidateProductClient(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? skipInventoryCheck = null, int? quantity = null, bool? skipDefaults = null, string purchaseLocation = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.Catalog.Storefront.ProductUrl.ValidateProductUrl(productCode, skipInventoryCheck, quantity, skipDefaults, responseFields); + var url = Mozu.Api.Urls.Commerce.Catalog.Storefront.ProductUrl.ValidateProductUrl(productCode, skipInventoryCheck, quantity, skipDefaults, purchaseLocation, responseFields); const string verb = "POST"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -198,15 +202,15 @@ public partial class ProductClient { } /// - /// Evaluates whether a collection of discounts specified in the request can be redeemed for the supplied product code. + /// /// - /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// The unique identifier of the customer account for which to retrieve wish lists. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. + /// If true, this operation returns inactive product discounts as part of the POST. + /// Unique ID of the customer account associated with the shopper requesting the discount. + /// + /// + /// If true, do not validate the product inventory when evaluating the list of discounts. /// Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// The discounts to evaluate for a specified product code at the time of purchase. + /// List of discount IDs to evaluate for the specified product. /// /// {} /// @@ -228,10 +232,10 @@ public partial class ProductClient { } /// - /// Retrieves the product cost based on a list of product codes. The product cost is the amount the merchant pays for the product—it is not the price that the shopper sees on the storefront (which is usually higher). + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties for the product location inventory provided for queries to locate products by their location. + /// + /// /// /// {} /// @@ -254,10 +258,10 @@ public partial class ProductClient { } /// - /// Retrieves product inventories for the storefront displayed products. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties for the product location inventory provided for queries to locate products by their location. + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Storefront/ProductSearchResultClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Storefront/ProductSearchResultClient.cs old mode 100644 new mode 100755 index cdf05a6a..73bc5876 --- a/Mozu.Api/Clients/Commerce/Catalog/Storefront/ProductSearchResultClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Storefront/ProductSearchResultClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Storefront { @@ -22,12 +23,12 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Storefront public partial class ProductSearchResultClient { /// - /// Random access paging computes a set of , which can each then be provided to the operation in the resource or the operation in the resource. You can provide the computed groups in any order to the operations, and can therefore parallelize calls to retrieve products more quickly. To generate the set of , call this () operation, in which you can optionally provide query and/or filter parameters to limit the products matched by the cursor. After executing this operation, pass one of the returned to the parameter of the or operations. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// {} /// @@ -49,33 +50,33 @@ public partial class ProductSearchResultClient { } /// - /// Searches the categories displayed on the web storefront for products or product options that the shopper types in a search query. + /// /// - /// In your first deep paged request, set this parameter to . Then, in all subsequent requests, set this parameter to the subsequent values of that's returned in each response to continue paging through the results. Continue this pattern until is null, which signifies the end of the paged results. - /// Enables search tuning rules on your site. + /// + /// /// Individually list the facet fields you want to display in a web storefront product search. /// Display a range facet not specified in a template in a web storefront product search by listing the facet field and the range to display. /// If filtering using category facets in a hierarchy, the number of category hierarchy levels to return for the facet. This option is only available for category facets. /// If filtering using category facets in a hierarchy, the parent categories you want to skip in the storefront product search. This parameter is only available for category facets. /// If filtering using category facets in a hierarchy, the category in the hierarchy to begin faceting on. This parameter is only available for category facets. /// The number of facet values to return for one or more facets. - /// Use this parameter to filter facet values that are returned by an associated search result by a prefix.For example, to filter on colors that start with b, such as blue, black, or brown you can specify the following: + /// /// Settings reserved for future facet search functionality on a web storefront product search. /// When paging through multiple facets, the startIndex value for each facet. /// The facet template to use on the storefront. A template displays all facets associated with the template on the web storefront product search. Currently, only category-level facet templates are available. - /// A comma-separated list of the facets to exclude from the facetTemplate. + /// /// Display a subset of the facets defined in the template specified in facetTemplate parameter. /// The facet values to apply to the filter. - /// Use this parameter to specify facet sorting outside the predefined facet definitions (which require a category). The most common options are:* (default)—Sorts by product count (highest count first).* —Sorts by lexicographic order. In most cases, this means alphabetical order.The following code demonstrates an example of sort: - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Use this field to include those fields which are not included by default. - /// Options you can specify for the response. This parameter is null by default.You can primarily use this parameter to return volume price band information in product details, which you can then display on category pages and search results depanding on your theme configuration. To return volume price band information, set this parameter to . - /// The settings to control product search and indexing behavior. - /// The unique identifier of the search tuning rule. - /// The category ID that the search tuning rule applies to. - /// + /// + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product search results by any of its properties, including product code, type, category, and name. 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=categoryId+eq+12" + /// Used to page results from a query. Indicates the maximum number of entities to return from a query. Default value: 12. Max value is 200. + /// The terms to search on. + /// + /// + /// + /// + /// + /// The element to sort the results by and the order in which the results appear. Either ascending order (a-z) which accepts 'asc' or 'asc' or descending order (z-a) which accepts 'desc' or 'desc'. The sortBy parameter follows an available property. /// /// /// {} @@ -98,12 +99,12 @@ public partial class ProductSearchResultClient { } /// - /// Suggests possible search terms as the shopper enters search text. + /// /// - /// Specifies the group that you want this operation to return in the response. This parameter accepts one or more values, separated by comma.For example, if you set this parameter to , then this operation returns a object that contains suggestions for products that match the user entered characters in the search field.The valid values for this parameter are the following:* — Indicates that products should be matched against and returned in the response. The search value is compared against product name and code. The response contains a with a name of and a collection of . Each collection item has a of Product and contains a equal to a complete product object.* — Indicates that categories should be matched against and returned in the response. The search value is compared to category name. The response contains a with a name of and a collection of . Each collection item has a of Category and contains a equal to a complete category object.* — Indicates that previously used search terms (keywords) should be matched against and returned in the response, sorted by frequency of use. Keep in mind that it is not currently possible to edit or remove search terms that may be considered undesirable via the API. The response contains a with a name of and a collection of . Each collection item has a of Term and contains a equal to a string value of the matched search term.The default value is ; however, the Core Theme only integrates and ignores the group.This operation only returns data that is then made available to your theme. If you set this paramter to multiple values, returns multiple in the response. Depending on your requirements, you can then customize your theme to display the groups together or as separate lists in the displayed search suggestions. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Use this field to include those fields which are not included by default. + /// + /// Indicates the maximum number of entities to return from a query. Default value: 10. Max value: 200. + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Catalog/Storefront/ShippingClient.cs b/Mozu.Api/Clients/Commerce/Catalog/Storefront/ShippingClient.cs old mode 100644 new mode 100755 index c6988671..919652f3 --- a/Mozu.Api/Clients/Commerce/Catalog/Storefront/ShippingClient.cs +++ b/Mozu.Api/Clients/Commerce/Catalog/Storefront/ShippingClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Catalog.Storefront { @@ -22,11 +23,36 @@ namespace Mozu.Api.Clients.Commerce.Catalog.Storefront public partial class ShippingClient { /// - /// Retrieves the shipping rates applicable for the site. + /// /// - /// Set this parameter to to retrieve the full raw JSON response from a shipping carrier (instead of just the shipping rate). - /// Use this field to include those fields which are not included by default. - /// Properties required to request a shipping rate calculation. + /// + /// + /// + /// {List{}} + /// + /// + /// + /// var mozuClient=GetMultiRates( rateRequestGroupList, includeRawResponse); + /// var ratesResponseGroupClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient> GetMultiRatesClient(List rateRequestGroupList, bool? includeRawResponse = null) + { + var url = Mozu.Api.Urls.Commerce.Catalog.Storefront.ShippingUrl.GetMultiRatesUrl(includeRawResponse); + const string verb = "POST"; + var mozuClient = new MozuClient>() + .WithVerb(verb).WithResourceUrl(url) + .WithBody>(rateRequestGroupList); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// Properties of the shipping rate request sent on behalf of the storefront website. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/ChannelClient.cs b/Mozu.Api/Clients/Commerce/ChannelClient.cs old mode 100644 new mode 100755 index 716783e8..3f466fef --- a/Mozu.Api/Clients/Commerce/ChannelClient.cs +++ b/Mozu.Api/Clients/Commerce/ChannelClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce { @@ -22,13 +23,13 @@ namespace Mozu.Api.Clients.Commerce public partial class ChannelClient { /// - /// Retrieves a list of channels defined for a tenant according to any filter or sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class ChannelClient { } /// - /// Retrieves the details of the channel specified in the request. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the channel to retrieve. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class ChannelClient { } /// - /// Creates a new channel that defines a new logical business division to use for financial reporting. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a channel used to divide a company into logical business divisions, such as "US Retail," "US Online," or "Amazon." All sites and orders are associated with a channel. + /// + /// Properties of the channel to create. /// /// {} /// @@ -100,11 +101,11 @@ public partial class ChannelClient { } /// - /// Updates one or more details of a defined channel, including the associated sites. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of a channel used to divide a company into logical business divisions, such as "US Retail," "US Online," or "Amazon." All sites and orders are associated with a channel. + /// User-defined code that identifies the channel to update. + /// + /// Properties of a the channel to update. /// /// {} /// @@ -126,9 +127,9 @@ public partial class ChannelClient { } /// - /// Deletes a defined channel for the tenant and removes the defined site associations. After deleting this channel, assign its associated sites to another channel. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// User-defined code that identifies the channel to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/ChannelGroupClient.cs b/Mozu.Api/Clients/Commerce/ChannelGroupClient.cs old mode 100644 new mode 100755 index e314f282..bdbecaa3 --- a/Mozu.Api/Clients/Commerce/ChannelGroupClient.cs +++ b/Mozu.Api/Clients/Commerce/ChannelGroupClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce { @@ -22,13 +23,13 @@ namespace Mozu.Api.Clients.Commerce public partial class ChannelGroupClient { /// - /// Retrieves a list of defined channel groups according to any filter and sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class ChannelGroupClient { } /// - /// Retrieves the details of a defined channel group. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// The code that uniquely identifies the channel group. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class ChannelGroupClient { } /// - /// Creates a new group of channels with common information. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a group of channels that share common information. + /// + /// Properties of the channel group to create. /// /// {} /// @@ -100,11 +101,11 @@ public partial class ChannelGroupClient { } /// - /// Updates one or more properties of a defined channel group. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of a group of channels that share common information. + /// Code that identifies the channel group. + /// + /// Properties of the channel group to update. /// /// {} /// @@ -126,7 +127,7 @@ public partial class ChannelGroupClient { } /// - /// Deletes a defined group of channels, which removes the group association with each channel in the group but does not delete the channel definitions themselves. + /// /// /// User-defined code that uniqely identifies the channel group. /// diff --git a/Mozu.Api/Clients/Commerce/CheckoutClient.cs b/Mozu.Api/Clients/Commerce/CheckoutClient.cs new file mode 100755 index 00000000..5b2bdc28 --- /dev/null +++ b/Mozu.Api/Clients/Commerce/CheckoutClient.cs @@ -0,0 +1,313 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Commerce +{ + /// + /// + /// + public partial class CheckoutClient { + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetCheckouts( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); + /// var checkoutCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetCheckoutsClient(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.GetCheckoutsUrl(startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// {List{string}} + /// + /// + /// + /// var mozuClient=GetAvailableActions( checkoutId); + /// var stringClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient> GetAvailableActionsClient(string checkoutId) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.GetAvailableActionsUrl(checkoutId); + const string verb = "GET"; + var mozuClient = new MozuClient>() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// {List{}} + /// + /// + /// + /// var mozuClient=GetAvailableShippingMethods( checkoutId); + /// var checkoutGroupRatesClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient> GetAvailableShippingMethodsClient(string checkoutId) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.GetAvailableShippingMethodsUrl(checkoutId); + const string verb = "GET"; + var mozuClient = new MozuClient>() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetCheckout( checkoutId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetCheckoutClient(string checkoutId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.GetCheckoutUrl(checkoutId, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=CreateCheckoutFromCart( cartId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient CreateCheckoutFromCartClient(string cartId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.CreateCheckoutFromCartUrl(cartId, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=PerformCheckoutAction( action, checkoutId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient PerformCheckoutActionClient(Mozu.Api.Contracts.CommerceRuntime.Checkouts.CheckoutAction action, string checkoutId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.PerformCheckoutActionUrl(checkoutId, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(action); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var mozuClient=ResendCheckoutConfirmationEmail( checkoutId); + ///mozuClient.WithBaseAddress(url).Execute(); + /// + /// + public static MozuClient ResendCheckoutConfirmationEmailClient(string checkoutId) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.ResendCheckoutConfirmationEmailUrl(checkoutId); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=SetShippingMethods( groupShippingMethods, checkoutId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient SetShippingMethodsClient(List groupShippingMethods, string checkoutId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.SetShippingMethodsUrl(checkoutId, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody>(groupShippingMethods); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=UpdateCheckout( checkout, checkoutId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient UpdateCheckoutClient(Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout checkout, string checkoutId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.UpdateCheckoutUrl(checkoutId, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(checkout); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=ProcessDigitalWallet( digitalWallet, checkoutId, digitalWalletType, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient ProcessDigitalWalletClient(Mozu.Api.Contracts.CommerceRuntime.Orders.DigitalWallet digitalWallet, string checkoutId, string digitalWalletType, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.ProcessDigitalWalletUrl(checkoutId, digitalWalletType, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(digitalWallet); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=ChangeCheckoutPriceList( priceListCode, checkoutId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient ChangeCheckoutPriceListClient(string priceListCode, string checkoutId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.CheckoutUrl.ChangeCheckoutPriceListUrl(checkoutId, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(priceListCode); + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Commerce/Checkouts/AppliedDiscountClient.cs b/Mozu.Api/Clients/Commerce/Checkouts/AppliedDiscountClient.cs new file mode 100755 index 00000000..021807d5 --- /dev/null +++ b/Mozu.Api/Clients/Commerce/Checkouts/AppliedDiscountClient.cs @@ -0,0 +1,105 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Commerce.Checkouts +{ + /// + /// + /// + public partial class AppliedDiscountClient { + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=ApplyCoupon( checkoutId, couponCode, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient ApplyCouponClient(string checkoutId, string couponCode, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.AppliedDiscountUrl.ApplyCouponUrl(checkoutId, couponCode, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=RemoveCoupons( checkoutId); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient RemoveCouponsClient(string checkoutId) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.AppliedDiscountUrl.RemoveCouponsUrl(checkoutId); + const string verb = "DELETE"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=RemoveCoupon( checkoutId, couponCode); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient RemoveCouponClient(string checkoutId, string couponCode) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.AppliedDiscountUrl.RemoveCouponUrl(checkoutId, couponCode); + const string verb = "DELETE"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Commerce/Checkouts/DestinationClient.cs b/Mozu.Api/Clients/Commerce/Checkouts/DestinationClient.cs new file mode 100755 index 00000000..42c55337 --- /dev/null +++ b/Mozu.Api/Clients/Commerce/Checkouts/DestinationClient.cs @@ -0,0 +1,158 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Commerce.Checkouts +{ + /// + /// + /// + public partial class DestinationClient { + + /// + /// + /// + /// + /// + /// {List{}} + /// + /// + /// + /// var mozuClient=GetDestinations( checkoutId); + /// var destinationClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient> GetDestinationsClient(string checkoutId) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.DestinationUrl.GetDestinationsUrl(checkoutId); + const string verb = "GET"; + var mozuClient = new MozuClient>() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetDestination( checkoutId, destinationId, responseFields); + /// var destinationClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetDestinationClient(string checkoutId, string destinationId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.DestinationUrl.GetDestinationUrl(checkoutId, destinationId, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=AddDestination( destination, checkoutId, responseFields); + /// var destinationClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient AddDestinationClient(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Destination destination, string checkoutId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.DestinationUrl.AddDestinationUrl(checkoutId, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(destination); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=UpdateDestination( destination, checkoutId, destinationId, responseFields); + /// var destinationClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient UpdateDestinationClient(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Destination destination, string checkoutId, string destinationId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.DestinationUrl.UpdateDestinationUrl(checkoutId, destinationId, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(destination); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var mozuClient=RemoveDestination( checkoutId, destinationId); + ///mozuClient.WithBaseAddress(url).Execute(); + /// + /// + public static MozuClient RemoveDestinationClient(string checkoutId, string destinationId) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.DestinationUrl.RemoveDestinationUrl(checkoutId, destinationId); + const string verb = "DELETE"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Commerce/Checkouts/OrderAttributeClient.cs b/Mozu.Api/Clients/Commerce/Checkouts/OrderAttributeClient.cs new file mode 100755 index 00000000..e5caed71 --- /dev/null +++ b/Mozu.Api/Clients/Commerce/Checkouts/OrderAttributeClient.cs @@ -0,0 +1,105 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Commerce.Checkouts +{ + /// + /// + /// + public partial class OrderAttributeClient { + + /// + /// + /// + /// + /// + /// {List{}} + /// + /// + /// + /// var mozuClient=GetCheckoutAttributes( checkoutId); + /// var orderAttributeClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient> GetCheckoutAttributesClient(string checkoutId) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.OrderAttributeUrl.GetCheckoutAttributesUrl(checkoutId); + const string verb = "GET"; + var mozuClient = new MozuClient>() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// {List{}} + /// + /// + /// + /// var mozuClient=CreateCheckoutAttributes( checkoutAttributes, checkoutId); + /// var orderAttributeClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient> CreateCheckoutAttributesClient(List checkoutAttributes, string checkoutId) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.OrderAttributeUrl.CreateCheckoutAttributesUrl(checkoutId); + const string verb = "POST"; + var mozuClient = new MozuClient>() + .WithVerb(verb).WithResourceUrl(url) + .WithBody>(checkoutAttributes); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {List{}} + /// + /// + /// + /// var mozuClient=UpdateCheckoutAttribute( checkoutAttributes, checkoutId, removeMissing); + /// var orderAttributeClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient> UpdateCheckoutAttributeClient(List checkoutAttributes, string checkoutId, bool? removeMissing = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.OrderAttributeUrl.UpdateCheckoutAttributeUrl(checkoutId, removeMissing); + const string verb = "PUT"; + var mozuClient = new MozuClient>() + .WithVerb(verb).WithResourceUrl(url) + .WithBody>(checkoutAttributes); + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Commerce/Checkouts/OrderItemClient.cs b/Mozu.Api/Clients/Commerce/Checkouts/OrderItemClient.cs new file mode 100755 index 00000000..36b9bf95 --- /dev/null +++ b/Mozu.Api/Clients/Commerce/Checkouts/OrderItemClient.cs @@ -0,0 +1,110 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Commerce.Checkouts +{ + /// + /// + /// + public partial class OrderItemClient { + + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=SplitItem( checkoutId, itemId, quantity, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient SplitItemClient(string checkoutId, string itemId, int? quantity = null, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.OrderItemUrl.SplitItemUrl(checkoutId, itemId, quantity, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=BulkUpdateItemDestinations( itemsForDestination, checkoutId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient BulkUpdateItemDestinationsClient(List itemsForDestination, string checkoutId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.OrderItemUrl.BulkUpdateItemDestinationsUrl(checkoutId, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody>(itemsForDestination); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=UpdateItemDestination( checkoutId, itemId, destinationId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient UpdateItemDestinationClient(string checkoutId, string itemId, string destinationId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.OrderItemUrl.UpdateItemDestinationUrl(checkoutId, itemId, destinationId, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Commerce/Checkouts/PaymentClient.cs b/Mozu.Api/Clients/Commerce/Checkouts/PaymentClient.cs new file mode 100755 index 00000000..169e24c8 --- /dev/null +++ b/Mozu.Api/Clients/Commerce/Checkouts/PaymentClient.cs @@ -0,0 +1,83 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Commerce.Checkouts +{ + /// + /// + /// + public partial class PaymentClient { + + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=PerformPaymentAction( action, checkoutId, paymentId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient PerformPaymentActionClient(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string checkoutId, string paymentId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.PaymentUrl.PerformPaymentActionUrl(checkoutId, paymentId, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(action); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=CreatePaymentAction( action, checkoutId, responseFields); + /// var checkoutClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient CreatePaymentActionClient(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string checkoutId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Checkouts.PaymentUrl.CreatePaymentActionUrl(checkoutId, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(action); + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Commerce/Customer/Accounts/CardClient.cs b/Mozu.Api/Clients/Commerce/Customer/Accounts/CardClient.cs old mode 100644 new mode 100755 index ee927f45..a41d7845 --- a/Mozu.Api/Clients/Commerce/Customer/Accounts/CardClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Accounts/CardClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Accounts { /// - /// Use the Cards subresource to manage stored credit cards for customer accounts. stores limited card data in the Customer service for expedited ordering purposes; however, the complete card data is stored in the Payment service. + /// Use the Cards subresource to manage stored credit cards for customer accounts. Mozu stores limited card data in the Customer service for expedited ordering purposes; however, the complete card data is stored in the Payment service. /// public partial class CardClient { /// - /// Retrieves the details of a credit card stored with a customer account billing contact. + /// /// /// Unique identifier of the customer account. /// Unique identifier of the card associated with the customer account billing contact. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -48,10 +49,10 @@ public partial class CardClient { } /// - /// Retrieves all stored credit cards for the customer account. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -73,11 +74,11 @@ public partial class CardClient { } /// - /// Creates a new credit card record and stores it for the customer account. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of a credit card used to submit payment for an order. + /// + /// Properties of the customer credit card to add to the account. /// /// {} /// @@ -99,12 +100,12 @@ public partial class CardClient { } /// - /// Update one or more properties of a credit card defined for a customer account. + /// /// /// Unique identifier of the customer account. - /// Unique identifier of the card associated with the customer account billing contact. - /// Use this field to include those fields which are not included by default. - /// Properties of a credit card used to submit payment for an order. + /// Unique identifier of the credit card. + /// + /// Properties of the customer account credit card to update. /// /// {} /// @@ -126,10 +127,10 @@ public partial class CardClient { } /// - /// Removes a stored credit card from a customer account. + /// /// /// Unique identifier of the customer account. - /// Unique identifier of the card associated with the customer account billing contact. + /// Unique identifier of the credit card to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerAttributeClient.cs b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerAttributeClient.cs old mode 100644 new mode 100755 index 1b35db12..0836239b --- a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerAttributeClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerAttributeClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Accounts { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Customer.Accounts public partial class CustomerAttributeClient { /// - /// Retrieves the contents of an attribute associated with the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// Identifier of the customer account associated with the attribute to retrieve. + /// + /// /// /// {} /// @@ -48,12 +49,12 @@ public partial class CustomerAttributeClient { } /// - /// Retrieves the list of customer account attributes. + /// /// - /// Unique identifier of the customer account. + /// Identifier of the customer account associated with the attributes to retrieve. /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -77,11 +78,11 @@ public partial class CustomerAttributeClient { } /// - /// Applies a defined attribute to the customer account specified in the request and assigns a value to the customer attribute. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of an attribute associated with a customer account. + /// + /// The attribute to add to the customer account. /// /// {} /// @@ -103,12 +104,12 @@ public partial class CustomerAttributeClient { } /// - /// Updates one or more details of a customer account attribute. + /// /// - /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// Properties of an attribute associated with a customer account. + /// Identifier of the customer account associated with the attribute. + /// + /// + /// Properties of the customer account attribute to update. /// /// {} /// @@ -130,10 +131,10 @@ public partial class CustomerAttributeClient { } /// - /// Removes the attribute specified in the request from the customer account. + /// /// /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerAuditEntryClient.cs b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerAuditEntryClient.cs old mode 100644 new mode 100755 index cc428bad..354247d2 --- a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerAuditEntryClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerAuditEntryClient.cs @@ -13,23 +13,24 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Accounts { /// - /// Use the Audit Log resource to retrieve audit logs for customer accounts. + /// /// public partial class CustomerAuditEntryClient { /// - /// Retrieves audit log entries for the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerContactClient.cs b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerContactClient.cs old mode 100644 new mode 100755 index 5ea66183..d36e37c8 --- a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerContactClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerContactClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Accounts { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Customer.Accounts public partial class CustomerContactClient { /// - /// Retrieves the specified contact for a customer account such as a billing or shipping contact. + /// /// - /// Unique identifier of the customer account. - /// Unique identifer of the customer account contact being updated. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account whose contact information is being retrieved. + /// Unique identifier of the customer account contact to retrieve. + /// /// /// {} /// @@ -48,12 +49,12 @@ public partial class CustomerContactClient { } /// - /// Retrieves a list of contacts for a customer according to any specified filter criteria and sort options. + /// /// - /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account associated with the contact information to retrieve. + /// + /// + /// /// /// /// @@ -77,11 +78,11 @@ public partial class CustomerContactClient { } /// - /// Creates a new contact for a customer account such as a new shipping address. + /// /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Contact information, including the contact's name, address, phone numbers, email addresses, and company (if supplied). Also indicates whether this is a billing, shipping, or billing and shipping contact. + /// Unique identifier of the customer account containing the new contact. + /// + /// Properties of the new contact. Required properties: Contact.Email, ContactType. /// /// {} /// @@ -103,12 +104,12 @@ public partial class CustomerContactClient { } /// - /// Updates a contact for a specified customer account such as to update addresses or change which contact is the primary contact for billing. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account whose contact information is being updated. /// Unique identifer of the customer account contact being updated. - /// Use this field to include those fields which are not included by default. - /// Contact information, including the contact's name, address, phone numbers, email addresses, and company (if supplied). Also indicates whether this is a billing, shipping, or billing and shipping contact. + /// + /// All properties the updated contact will have. Required properties: Name and email address. /// /// {} /// @@ -130,10 +131,36 @@ public partial class CustomerContactClient { } /// - /// Deletes a contact for the specified customer account. + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=AddAccountContactList( contactList, accountId, responseFields); + /// var customerContactCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient AddAccountContactListClient(List contactList, int accountId, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Customer.Accounts.CustomerContactUrl.AddAccountContactListUrl(accountId, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody>(contactList); + return mozuClient; + + } + + /// + /// /// /// Unique identifier of the customer account. - /// Unique identifer of the customer account contact being updated. + /// Unique identifier of the customer account contact to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerNoteClient.cs b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerNoteClient.cs old mode 100644 new mode 100755 index ddcc83bc..ff4d216e --- a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerNoteClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerNoteClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Accounts { /// - /// This resources manages notes for a customer account. For example, a client can track a shopper's interests or complaints. Only clients can add and view notes. Shoppers cannot view these notes from the My Account page. + /// Tenant administrators can add and view internal notes for a customer account. For example, a client can track a shopper's interests or complaints. Only clients can add and view notes. Shoppers cannot view these notes from the My Account page. /// public partial class CustomerNoteClient { /// - /// Retrieves the contents of a particular note attached to a specified customer account. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account that contains the note being retrieved. /// Unique identifier of a particular note to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -48,14 +49,14 @@ public partial class CustomerNoteClient { } /// - /// Retrieves a list of notes added to a customer account according to any specified filter criteria and sort options. + /// /// /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -77,11 +78,11 @@ public partial class CustomerNoteClient { } /// - /// Adds a new note to the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of a note configured for a customer account. + /// Unique identifier of the customer account for which to create the note. + /// + /// Properties of the customer account note to create. /// /// {} /// @@ -103,12 +104,12 @@ public partial class CustomerNoteClient { } /// - /// Modifies an existing note for a customer account. + /// /// - /// Unique identifier of the customer account. - /// Unique identifier of a particular note to retrieve. - /// Use this field to include those fields which are not included by default. - /// Properties of a note configured for a customer account. + /// Unique identifier of the customer account note to modify. + /// Unique identifier of the note to update. + /// + /// The new content to replace the existing note. /// /// {} /// @@ -130,10 +131,10 @@ public partial class CustomerNoteClient { } /// - /// Removes a note from the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// Unique identifier of a particular note to retrieve. + /// Unique identifier of the customer account that contains the note being deleted. + /// Unique identifier of the customer account note being deleted. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountClient.cs b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountClient.cs old mode 100644 new mode 100755 index cb047f60..c9cf0f4f --- a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Accounts { /// - /// Use the Customer Account Purchase Order resource to manage purchase order details for specific customer acocunts. + /// /// public partial class CustomerPurchaseOrderAccountClient { /// - /// Retrieves the details of the specified customer purchase order account. + /// /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -47,14 +48,14 @@ public partial class CustomerPurchaseOrderAccountClient { } /// - /// Retrieves a list of purchase order transactions for the specified customer account according to any specified sort options. + /// /// - /// Unique identifier of the customer account. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -76,11 +77,11 @@ public partial class CustomerPurchaseOrderAccountClient { } /// - /// Adds a purchase order account to the specified customer account.This adds the ability for the specified customer account to use the purchase order payment method. + /// /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the customer purchase order account. + /// + /// + /// /// /// {} /// @@ -102,11 +103,11 @@ public partial class CustomerPurchaseOrderAccountClient { } /// - /// Creates a purchase order transaction on the specified customer purchase order account. + /// /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The purchase order transaction type to add to the specified customer account. + /// + /// + /// /// /// {} /// @@ -128,11 +129,11 @@ public partial class CustomerPurchaseOrderAccountClient { } /// - /// Updates the details of the purchase order account for the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the customer purchase order account. + /// + /// + /// /// /// {} /// @@ -154,9 +155,9 @@ public partial class CustomerPurchaseOrderAccountClient { } /// - /// Deletes the specified customer purchase order account.This removes the ability for the specified customer account to use the purchase order payment method. + /// /// - /// Unique identifier of the customer account. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerSegmentClient.cs b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerSegmentClient.cs old mode 100644 new mode 100755 index ac69b11e..0c227bea --- a/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerSegmentClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Accounts/CustomerSegmentClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Accounts { @@ -22,14 +23,14 @@ namespace Mozu.Api.Clients.Commerce.Customer.Accounts public partial class CustomerSegmentClient { /// - /// Retrieves the list of segments associated with a customer account. + /// /// /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Accounts/TransactionClient.cs b/Mozu.Api/Clients/Commerce/Customer/Accounts/TransactionClient.cs old mode 100644 new mode 100755 index c1009191..64f11065 --- a/Mozu.Api/Clients/Commerce/Customer/Accounts/TransactionClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Accounts/TransactionClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Accounts { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Customer.Accounts public partial class TransactionClient { /// - /// Retrieves a list of transactions associated with the customer account specified in the request. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account for which to retrieve transactions. /// /// {List{}} /// @@ -46,11 +47,11 @@ public partial class TransactionClient { } /// - /// Creates a new transaction for the customer account specified in the request. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of a transaction performed by a customer account. The system creates a transaction each time the customer submits an order, returns an item, picks up items for an order, or manages items on a wish list. + /// + /// Properties of the transaction to create for the customer account. /// /// {} /// @@ -72,9 +73,9 @@ public partial class TransactionClient { } /// - /// Deletes a transaction from the customer account specified in the request. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account from which to delete the transaction. /// Unique identifier of the transaction to delete. /// /// diff --git a/Mozu.Api/Clients/Commerce/Customer/AddressValidationRequestClient.cs b/Mozu.Api/Clients/Commerce/Customer/AddressValidationRequestClient.cs old mode 100644 new mode 100755 index d1e6f6c6..38ac8a95 --- a/Mozu.Api/Clients/Commerce/Customer/AddressValidationRequestClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/AddressValidationRequestClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Customer public partial class AddressValidationRequestClient { /// - /// Validates the customer address supplied in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// 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. + /// + /// Properties of the address to validate. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Attributedefinition/AttributeClient.cs b/Mozu.Api/Clients/Commerce/Customer/Attributedefinition/AttributeClient.cs old mode 100644 new mode 100755 index 81c89a1b..f3ee0f73 --- a/Mozu.Api/Clients/Commerce/Customer/Attributedefinition/AttributeClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Attributedefinition/AttributeClient.cs @@ -13,23 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Attributedefinition { /// - /// Attributes are used to add custom definitions and characteristics to the following objects: - + /// Use the Customer Attribute Definition resource to manage the attributes to define for your shoppers. /// public partial class AttributeClient { /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -51,9 +51,9 @@ public partial class AttributeClient { } /// - /// Retrieve a list of the vocabulary values defined for the customer attribute specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// {List{}} /// @@ -75,10 +75,10 @@ public partial class AttributeClient { } /// - /// Retrieves the details of the specified product attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// {} /// @@ -99,6 +99,57 @@ public partial class AttributeClient { } + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=CreateAttribute( attribute, responseFields); + /// var attributeClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient CreateAttributeClient(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Customer.Attributedefinition.AttributeUrl.CreateAttributeUrl(responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(attribute); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=UpdateAttribute( attribute, attributeFQN, responseFields); + /// var attributeClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient UpdateAttributeClient(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Customer.Attributedefinition.AttributeUrl.UpdateAttributeUrl(attributeFQN, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(attribute); + return mozuClient; + + } + } diff --git a/Mozu.Api/Clients/Commerce/Customer/CreditClient.cs b/Mozu.Api/Clients/Commerce/Customer/CreditClient.cs old mode 100644 new mode 100755 index 2d9de028..ffcbf0d5 --- a/Mozu.Api/Clients/Commerce/Customer/CreditClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/CreditClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer { @@ -22,13 +23,13 @@ namespace Mozu.Api.Clients.Commerce.Customer public partial class CreditClient { /// - /// Retrieves a list of store credits applied to customer accounts, according any filter and sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class CreditClient { } /// - /// Retrieves the details of a store credit applied to a customer account. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the store credit to retrieve. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class CreditClient { } /// - /// Creates a new store credit for the customer account specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the store credit of gift card applied to a customer account. At this time, gift card functionality is reserved for future use. + /// + /// Properties of the store credit to create. /// /// {} /// @@ -100,10 +101,10 @@ public partial class CreditClient { } /// - /// Associates an unclaimed customer credit with the shopper user authenticated in the request header. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// The code that represents the credit to claim for the shopper. + /// /// /// {} /// @@ -125,9 +126,9 @@ public partial class CreditClient { } /// - /// Resend the notification email that informs a shopper that a credit has been created. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// /// /// /// @@ -149,11 +150,11 @@ public static MozuClient ResendCreditCreatedEmailClient(string code) } /// - /// Updates one or more properties of a defined store credit applied to a customer account. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of the store credit of gift card applied to a customer account. At this time, gift card functionality is reserved for future use. + /// User-defined code of the store credit to update. + /// + /// Properties of the store credit to update. /// /// {} /// @@ -175,9 +176,9 @@ public static MozuClient ResendCreditCreatedEmailClient(string code) } /// - /// Deletes a store credit previously applied to a customer account. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// User-defined code of the store credit to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Credits/CreditAuditEntryClient.cs b/Mozu.Api/Clients/Commerce/Customer/Credits/CreditAuditEntryClient.cs old mode 100644 new mode 100755 index f2e986e5..ab2a44ef --- a/Mozu.Api/Clients/Commerce/Customer/Credits/CreditAuditEntryClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Credits/CreditAuditEntryClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Credits { @@ -22,14 +23,14 @@ namespace Mozu.Api.Clients.Commerce.Customer.Credits public partial class CreditAuditEntryClient { /// - /// Retrieves the list of audit entries for the credit, according to any filter or sort criteria specified in the request. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// User-defined code of the credit for which to retrieve audit entries. + /// + /// + /// + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Customer/Credits/CreditTransactionClient.cs b/Mozu.Api/Clients/Commerce/Customer/Credits/CreditTransactionClient.cs old mode 100644 new mode 100755 index 1471e282..725c60a2 --- a/Mozu.Api/Clients/Commerce/Customer/Credits/CreditTransactionClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/Credits/CreditTransactionClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer.Credits { @@ -22,14 +23,14 @@ namespace Mozu.Api.Clients.Commerce.Customer.Credits public partial class CreditTransactionClient { /// - /// Retrieves a list of the transactions performed using a customer credit that update the balance of the credit. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// User-defined code that identifies the customer credit. + /// + /// + /// + /// + /// /// /// {} /// @@ -51,11 +52,11 @@ public partial class CreditTransactionClient { } /// - /// Creates a new transaction and updates the amount of a store credit or gift card. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of a transaction performed for a customer credit that update the remaining balance of the credit. + /// User-defined code that identifies the customer credit to update. + /// + /// Properties of the transaction to create for the customer credit. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Customer/CustomerAccountClient.cs b/Mozu.Api/Clients/Commerce/Customer/CustomerAccountClient.cs old mode 100644 new mode 100755 index 3162a449..284a7dd9 --- a/Mozu.Api/Clients/Commerce/Customer/CustomerAccountClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/CustomerAccountClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer { @@ -22,15 +23,15 @@ namespace Mozu.Api.Clients.Commerce.Customer public partial class CustomerAccountClient { /// - /// Retrieves a list of customer accounts. + /// /// /// The fields to include in the response. - /// 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" + /// /// If true, retrieve anonymous shopper accounts in the response. /// - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// A list of customer account search terms to use in the query when searching across customer name and email. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -54,10 +55,10 @@ public partial class CustomerAccountClient { } /// - /// Retrieves the current login state of the customer account specified in the request. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -79,10 +80,10 @@ public partial class CustomerAccountClient { } /// - /// Retrieve details of a customer account. + /// /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account to retrieve. + /// /// /// {} /// @@ -104,10 +105,10 @@ public partial class CustomerAccountClient { } /// - /// Creates a new customer account based on the information specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the customer account. + /// + /// Properties of the customer account to update. /// /// {} /// @@ -129,11 +130,11 @@ public partial class CustomerAccountClient { } /// - /// Modifies the password associated with a customer account. + /// /// - /// Unique identifier of the customer account. - /// Specifies whether to unlock the specified customer account. - /// The information required to modify a shopper account password. + /// The customer account information required to change the userpassword. + /// + /// The password information required to change the user password. /// /// /// @@ -155,11 +156,11 @@ public static MozuClient ChangePasswordClient(Mozu.Api.Contracts.Customer.Passwo } /// - /// Adds a new user login to a defined customer account. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// The login information for a customer account. + /// + /// The authentication information for the customer account. /// /// {} /// @@ -181,9 +182,9 @@ public static MozuClient ChangePasswordClient(Mozu.Api.Contracts.Customer.Passwo } /// - /// Updates the customer lifetime value of the specified customer account in the event of an order import or a lifetime value calculation error. + /// /// - /// Unique identifier of the customer account. + /// The unique identifier of the customer account for which to calculate customer lifetime value. /// /// /// @@ -205,9 +206,9 @@ public static MozuClient RecomputeCustomerLifetimeValueClient(int accountId) } /// - /// Lock or unlock a customer account. + /// /// - /// Unique identifier of the customer account. + /// The unique identifier of the customer account. /// If true, the customer account is locked from logging in. /// /// @@ -230,7 +231,7 @@ public static MozuClient SetLoginLockedClient(bool isLocked, int accountId) } /// - /// Requires the password for the customer account to be changed. + /// /// /// Unique identifier of the customer account. /// If true, the password for the customer account must be changed. @@ -255,10 +256,10 @@ public static MozuClient SetPasswordChangeRequiredClient(bool isPasswordChangeRe } /// - /// Creates a new customer account and logs the user associated with the customer account into the site. + /// /// - /// Use this field to include those fields which are not included by default. - /// The authentication information associated with a customer account. The data includes the account properties such as the name, username, authorization access, and email address, the required password to match, and indicates if the account was imported from a third party resource. + /// + /// Properties of the customer account to create, including the user authentication information. /// /// {} /// @@ -280,10 +281,10 @@ public static MozuClient SetPasswordChangeRequiredClient(bool isPasswordChangeRe } /// - /// Creates multiple customer accounts based on the information specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// The authentication information associated with a customer account. The data includes the account properties such as the name, username, authorization access, and email address, the required password to match, and indicates if the account was imported from a third party resource. + /// + /// Properties of the customer accounts to create. /// /// {} /// @@ -305,10 +306,10 @@ public static MozuClient SetPasswordChangeRequiredClient(bool isPasswordChangeRe } /// - /// Changes a collection of customer account passwords. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the changed customer account passwords. + /// + /// /// /// {} /// @@ -330,11 +331,11 @@ public static MozuClient SetPasswordChangeRequiredClient(bool isPasswordChangeRe } /// - /// Retrieves the current login state of a customer account by providing the customer's email address. + /// /// - /// The unique idenfitier of the customer set. + /// /// The email address associated with the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -356,10 +357,10 @@ public static MozuClient SetPasswordChangeRequiredClient(bool isPasswordChangeRe } /// - /// Retrieves the current login state of a customer account by providing the user name associated with the customer account. + /// /// - /// The unique idenfitier of the customer set. - /// Use this field to include those fields which are not included by default. + /// + /// /// The user name associated with the customer account. /// /// {} @@ -382,12 +383,12 @@ public static MozuClient SetPasswordChangeRequiredClient(bool isPasswordChangeRe } /// - /// Retrieves a list of customer purchase order accounts according to according to any specified sort options. + /// /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// /// /// {} /// @@ -409,7 +410,7 @@ public static MozuClient SetPasswordChangeRequiredClient(bool isPasswordChangeRe } /// - /// Resets the password for a customer account. + /// /// /// Information required to reset the password for a customer account. /// @@ -433,11 +434,11 @@ public static MozuClient ResetPasswordClient(Mozu.Api.Contracts.Customer.ResetPa } /// - /// Updates a customer account. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of the customer account. + /// + /// Properties of the customer account to update. /// /// {} /// @@ -459,9 +460,9 @@ public static MozuClient ResetPasswordClient(Mozu.Api.Contracts.Customer.ResetPa } /// - /// Deletes a customer account. A customer account cannot be deleted if any orders exist, past or present. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Customer/CustomerAuthTicketClient.cs b/Mozu.Api/Clients/Commerce/Customer/CustomerAuthTicketClient.cs old mode 100644 new mode 100755 index 42be3d4c..b0a3440b --- a/Mozu.Api/Clients/Commerce/Customer/CustomerAuthTicketClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/CustomerAuthTicketClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Customer public partial class CustomerAuthTicketClient { /// - /// Creates an authentication ticket for an anonymous shopper user. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// @@ -46,10 +47,10 @@ public partial class CustomerAuthTicketClient { } /// - /// Generates a new authentication ticket for a customer account. + /// /// - /// Use this field to include those fields which are not included by default. - /// The authentication information required to generate an authentication ticket for a customer account. + /// + /// The authentication information required to generate an authetication ticket for a user, which consists of a user name and password. /// /// {} /// @@ -71,10 +72,10 @@ public partial class CustomerAuthTicketClient { } /// - /// Refreshes an existing authentication ticket for a customer account by providing the refresh token string. + /// /// - /// 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. - /// Use this field to include those fields which are not included by default. + /// The refresh token string required to refresh a user's authentication ticket. + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Customer/CustomerSegmentClient.cs b/Mozu.Api/Clients/Commerce/Customer/CustomerSegmentClient.cs old mode 100644 new mode 100755 index ecae2b80..74a0eb42 --- a/Mozu.Api/Clients/Commerce/Customer/CustomerSegmentClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/CustomerSegmentClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer { @@ -22,13 +23,13 @@ namespace Mozu.Api.Clients.Commerce.Customer public partial class CustomerSegmentClient { /// - /// Retrieves a list of defined customer segments according to any filter and sort criteria. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class CustomerSegmentClient { } /// - /// Retrieves the details of the customer segment specified in the request. This operation does not return a list of the customer accounts associated with the segment. + /// /// /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class CustomerSegmentClient { } /// - /// Creates a new customer segments. New customer segments do not have any associated customer accounts. + /// /// - /// Use this field to include those fields which are not included by default. - /// The Customer Segment object includes properties of a defined customer segment used to group customer accounts. + /// + /// Properties of the customer segment to add. /// /// {} /// @@ -100,9 +101,9 @@ public partial class CustomerSegmentClient { } /// - /// Adds one or more customer accounts to a defined customer segment. + /// /// - /// Unique identifier of the customer segment to retrieve. + /// Unique identifier of the customer segment for which to add the associated customer accounts. /// List of customer account IDs to add to the customer segment specified in the request. /// /// @@ -125,11 +126,11 @@ public static MozuClient AddSegmentAccountsClient(List accountIds, int id) } /// - /// Updates the details of the customer segment specified in the request. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// The Customer Segment object includes properties of a defined customer segment used to group customer accounts. + /// Unique identifier of the customer segment. + /// + /// Properties of the customer segment to update. /// /// {} /// @@ -151,9 +152,9 @@ public static MozuClient AddSegmentAccountsClient(List accountIds, int id) } /// - /// Deletes a customer segment specified by its unique identifier. Deleting a segment removes any customer account associations, but does not delete the customer account itself. + /// /// - /// Unique identifier of the customer segment to retrieve. + /// Unique identifier of the customer segment to delete. /// /// /// @@ -175,10 +176,10 @@ public static MozuClient DeleteSegmentClient(int id) } /// - /// Removes single account from a segment. + /// /// - /// Unique identifier of the customer account. - /// Unique identifier of the customer segment to retrieve. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Customer/CustomerSetClient.cs b/Mozu.Api/Clients/Commerce/Customer/CustomerSetClient.cs old mode 100644 new mode 100755 index cf6fa267..6fd98af7 --- a/Mozu.Api/Clients/Commerce/Customer/CustomerSetClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/CustomerSetClient.cs @@ -13,21 +13,22 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer { /// - /// Use the Customer Sets resource to manage your customer sets. You can use customer sets to control the specific sites your customers can access using the same login credentials, as well as what customer My Account information is shared between sites.Refer to [Customer Sets](../../../guides/settings/customer-sets.htm) in the Guides section for more information. + /// /// public partial class CustomerSetClient { /// - /// Retrieves a collection of customer sets according to any specified filter criteria. + /// /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// /// /// {} /// @@ -49,10 +50,10 @@ public partial class CustomerSetClient { } /// - /// Retrieves the details of the specified customer set. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Customer/VisitClient.cs b/Mozu.Api/Clients/Commerce/Customer/VisitClient.cs old mode 100644 new mode 100755 index 6c5b4849..50b23c66 --- a/Mozu.Api/Clients/Commerce/Customer/VisitClient.cs +++ b/Mozu.Api/Clients/Commerce/Customer/VisitClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Customer { @@ -22,13 +23,13 @@ namespace Mozu.Api.Clients.Commerce.Customer public partial class VisitClient { /// - /// Retrieves a list of customer visits according to any filter or sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class VisitClient { } /// - /// Retrieves the details of the customer visit specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the customer visit to update. + /// + /// Unique identifier of the customer visit to retrieve. /// /// {} /// @@ -75,10 +76,10 @@ public partial class VisitClient { } /// - /// Creates a new visit for the customer account specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a customer visit to one of a company's sites. + /// + /// Properties of the visit to add to the customer account. /// /// {} /// @@ -100,11 +101,11 @@ public partial class VisitClient { } /// - /// Updates one or more properties of a defined customer visit. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// Unique identifier of the customer visit to update. - /// Properties of a customer visit to one of a company's sites. + /// Properties of the customer visit to update. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/InStockNotificationSubscriptionClient.cs b/Mozu.Api/Clients/Commerce/InStockNotificationSubscriptionClient.cs old mode 100644 new mode 100755 index b83a27a4..7ae73da4 --- a/Mozu.Api/Clients/Commerce/InStockNotificationSubscriptionClient.cs +++ b/Mozu.Api/Clients/Commerce/InStockNotificationSubscriptionClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce { @@ -22,13 +23,13 @@ namespace Mozu.Api.Clients.Commerce public partial class InStockNotificationSubscriptionClient { /// - /// Retrieves a list of in-stock notification subscriptions. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class InStockNotificationSubscriptionClient { } /// - /// Retrieves the details of a subscription that sends a push notification when a product is available in a site's active stock. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the in-stock notification subscription to retrieve. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class InStockNotificationSubscriptionClient { } /// - /// Creates a new subscription that notifies the customer when the product specified in the request is available in the active inventory of the defined location. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a push notification to which the shopper subscribes. This notification sends the shopper an alert when a new product or a product previously out of stock becomes available in the specified location's active product inventory. + /// + /// Properties of a subscription that sends the customer a notification when a product is available in a site's active stock. /// /// {} /// @@ -100,9 +101,9 @@ public partial class InStockNotificationSubscriptionClient { } /// - /// Deletes a subscription for a customer in-stock notification. + /// /// - /// Unique identifier of the customer segment to retrieve. + /// Unique identifier of the customer in-stock notification subscription to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/LocationClient.cs b/Mozu.Api/Clients/Commerce/LocationClient.cs old mode 100644 new mode 100755 index 0ce988a0..bd7fa82c --- a/Mozu.Api/Clients/Commerce/LocationClient.cs +++ b/Mozu.Api/Clients/Commerce/LocationClient.cs @@ -13,31 +13,33 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce { /// - /// Use the Location resource to retrieve details about a location from a hosted storefront. + /// Use the Location resource to retrieve details about a location from a Mozu hosted storefront. /// public partial class LocationClient { /// - /// Retrieves the details of the location specified in the request. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// {} /// /// /// - /// var mozuClient=GetLocation( code, responseFields); + /// var mozuClient=GetLocation( locationCode, includeAttributeDefinition, responseFields); /// var locationClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient GetLocationClient(string code, string responseFields = null) + public static MozuClient GetLocationClient(string locationCode, bool? includeAttributeDefinition = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.LocationUrl.GetLocationUrl(code, responseFields); + var url = Mozu.Api.Urls.Commerce.LocationUrl.GetLocationUrl(locationCode, includeAttributeDefinition, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -47,26 +49,27 @@ public partial class LocationClient { } /// - /// Retrieves a list of the locations configured for a specified location usage type for the specified site, according to any defined filter or sort criteria. + /// /// - /// 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" + /// + /// /// System-defined location usage type code, which is DS for direct ship, SP for in-store pickup, or storeFinder. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// /// /// {} /// /// /// - /// var mozuClient=GetLocationsInUsageType( locationUsageType, startIndex, pageSize, sortBy, filter, responseFields); + /// var mozuClient=GetLocationsInUsageType( locationUsageType, startIndex, pageSize, sortBy, filter, includeAttributeDefinition, responseFields); /// var locationCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient GetLocationsInUsageTypeClient(string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public static MozuClient GetLocationsInUsageTypeClient(string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeAttributeDefinition = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.LocationUrl.GetLocationsInUsageTypeUrl(locationUsageType, startIndex, pageSize, sortBy, filter, responseFields); + var url = Mozu.Api.Urls.Commerce.LocationUrl.GetLocationsInUsageTypeUrl(locationUsageType, startIndex, pageSize, sortBy, filter, includeAttributeDefinition, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -76,21 +79,22 @@ public partial class LocationClient { } /// - /// Retrieves the details of the location configured for the direct shipping (DS) location usage type for the site specified in the request. This location acts as an origin address from which order packages will ship, as well as the location where product reservations are created when order items are submitted with the direct ship fulfillment type (DS). If the direct ship location usage type is not configured for this site, the operation returns an error. + /// /// - /// Use this field to include those fields which are not included by default. + /// + /// /// /// {} /// /// /// - /// var mozuClient=GetDirectShipLocation( responseFields); + /// var mozuClient=GetDirectShipLocation( includeAttributeDefinition, responseFields); /// var locationClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient GetDirectShipLocationClient(string responseFields = null) + public static MozuClient GetDirectShipLocationClient(bool? includeAttributeDefinition = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.LocationUrl.GetDirectShipLocationUrl(responseFields); + var url = Mozu.Api.Urls.Commerce.LocationUrl.GetDirectShipLocationUrl(includeAttributeDefinition, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -100,22 +104,23 @@ public partial class LocationClient { } /// - /// Retrieves the details of the location configured for the in-store pickup (SP) location usage type for the site specified in the request. If the location is not associated with a location type configured for the in-store pickup location usage type (SP), the operation returns an error. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// {} /// /// /// - /// var mozuClient=GetInStorePickupLocation( code, responseFields); + /// var mozuClient=GetInStorePickupLocation( locationCode, includeAttributeDefinition, responseFields); /// var locationClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient GetInStorePickupLocationClient(string code, string responseFields = null) + public static MozuClient GetInStorePickupLocationClient(string locationCode, bool? includeAttributeDefinition = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.LocationUrl.GetInStorePickupLocationUrl(code, responseFields); + var url = Mozu.Api.Urls.Commerce.LocationUrl.GetInStorePickupLocationUrl(locationCode, includeAttributeDefinition, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -125,25 +130,26 @@ public partial class LocationClient { } /// - /// Retrieves a list of locations valid for in-store pickup of an item in an order according to any filter and sort criteria. For example, an application could use this operation to provide a store finder feature based on the shopper's GPS coordinates. If the location types for the in-store pickup location usage type are not configured for the site, this operation returns an error. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// {} /// /// /// - /// var mozuClient=GetInStorePickupLocations( startIndex, pageSize, sortBy, filter, responseFields); + /// var mozuClient=GetInStorePickupLocations( startIndex, pageSize, sortBy, filter, includeAttributeDefinition, responseFields); /// var locationCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient GetInStorePickupLocationsClient(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public static MozuClient GetInStorePickupLocationsClient(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeAttributeDefinition = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.LocationUrl.GetInStorePickupLocationsUrl(startIndex, pageSize, sortBy, filter, responseFields); + var url = Mozu.Api.Urls.Commerce.LocationUrl.GetInStorePickupLocationsUrl(startIndex, pageSize, sortBy, filter, includeAttributeDefinition, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) diff --git a/Mozu.Api/Clients/Commerce/OrderClient.cs b/Mozu.Api/Clients/Commerce/OrderClient.cs old mode 100644 new mode 100755 index 9ff6fe89..e5881711 --- a/Mozu.Api/Clients/Commerce/OrderClient.cs +++ b/Mozu.Api/Clients/Commerce/OrderClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce { @@ -22,27 +23,28 @@ namespace Mozu.Api.Clients.Commerce public partial class OrderClient { /// - /// Retrieves a list of orders according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter an order's search results by any of its properties, including status, contact information, or total. 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=Status+eq+Submitted" + /// + /// Used to page results from a query. Indicates the maximum number of entities to return from a query. Default value: 20. Max value: 200. + /// A list of order search terms to use in the query when searching across order number and the name or email of the billing contact. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// + /// + /// The element to sort the results by and the order in which the results appear. Either ascending order (a-z) which accepts 'asc' or 'asc' or descending order (z-a) which accepts 'desc' or 'desc'. The sortBy parameter follows an available property. For examp /// /// /// {} /// /// /// - /// var mozuClient=GetOrders( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); + /// var mozuClient=GetOrders( startIndex, pageSize, sortBy, filter, q, qLimit, includeBin, responseFields); /// var orderCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient GetOrdersClient(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null) + public static MozuClient GetOrdersClient(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, bool? includeBin = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.OrderUrl.GetOrdersUrl(startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); + var url = Mozu.Api.Urls.Commerce.OrderUrl.GetOrdersUrl(startIndex, pageSize, sortBy, filter, q, qLimit, includeBin, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -52,9 +54,9 @@ public partial class OrderClient { } /// - /// Retrieves the actions available to perform for an order based on its current status. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the available order actions to get. /// /// {List{string}} /// @@ -76,9 +78,9 @@ public static MozuClient> GetAvailableActionsClient(string orderId) } /// - /// Retrieves an order for the purpose of splitting it into multiple taxable orders in order to fulfill the order in multiple locations. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order to retrieve. /// /// {List{}} /// @@ -100,23 +102,24 @@ public static MozuClient> GetAvailableActionsClient(string orderId) } /// - /// Retrieves the details of an order specified by the order ID. + /// /// /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// + /// Unique identifier of the order details to get. + /// /// /// {} /// /// /// - /// var mozuClient=GetOrder( orderId, draft, responseFields); + /// var mozuClient=GetOrder( orderId, draft, includeBin, responseFields); /// var orderClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient GetOrderClient(string orderId, bool? draft = null, string responseFields = null) + public static MozuClient GetOrderClient(string orderId, bool? draft = null, bool? includeBin = null, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.OrderUrl.GetOrderUrl(orderId, draft, responseFields); + var url = Mozu.Api.Urls.Commerce.OrderUrl.GetOrderUrl(orderId, draft, includeBin, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -126,10 +129,10 @@ public static MozuClient> GetAvailableActionsClient(string orderId) } /// - /// Creates a new order from an existing cart when the customer chooses to proceed to checkout. + /// /// - /// Identifier of the cart to delete. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the cart. This is the original cart ID expressed as a GUID. + /// /// /// {} /// @@ -151,10 +154,10 @@ public static MozuClient> GetAvailableActionsClient(string orderId) } /// - /// Creates a new order for no-cart quick-ordering scenarios. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of an order, including its components. + /// + /// Properties of the order to create and submit. /// /// {} /// @@ -176,10 +179,10 @@ public static MozuClient> GetAvailableActionsClient(string orderId) } /// - /// Perform the specified action for an order. The actions you can perform depend on the current status of the order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// The action to perform for the order. /// /// {} @@ -202,12 +205,39 @@ public static MozuClient> GetAvailableActionsClient(string orderId) } /// - /// Processes a digital wallet (used to hold 3rd party payment and shipping information). + /// /// - /// The type of digital wallet to be processed. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the digitial wallet. + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=PriceOrder( order, refreshShipping, couponCodeToApply, responseFields); + /// var orderClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient PriceOrderClient(Mozu.Api.Contracts.CommerceRuntime.Orders.Order order, bool refreshShipping, string couponCodeToApply = null, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.OrderUrl.PriceOrderUrl(refreshShipping, couponCodeToApply, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(order); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -229,14 +259,14 @@ public static MozuClient> GetAvailableActionsClient(string orderId) } /// - /// Update the properties of a discount applied to an order. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of all applied discounts for an associated cart, order, or product. + /// Unique identifier of the discount. System-supplied and read only. + /// Unique identifier of the order discount. System-supplied and read only. + /// + /// Specifies whether to modify the discount by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Properties of the order discount to update. /// /// {} /// @@ -258,10 +288,10 @@ public static MozuClient> GetAvailableActionsClient(string orderId) } /// - /// Deletes the current draft version of the order, which also deletes any uncommitted changes made to the order in draft mode. + /// /// - /// Unique identifier of the order. - /// Determines whether or not to check versioning of items for concurrency purposes. + /// Unique identifier of the order associated with the draft to delete. + /// If applicable, the version of the order draft to delete. /// /// /// @@ -283,10 +313,10 @@ public static MozuClient DeleteOrderDraftClient(string orderId, string version = } /// - /// Triggers an order confirmation email to be resent. + /// /// - /// Unique identifier of the order. - /// The action to perform for the order. + /// + /// /// /// /// @@ -308,13 +338,13 @@ public static MozuClient ResendOrderConfirmationEmailClient(Mozu.Api.Contracts.C } /// - /// Changes the price list associated with an order. The desired price list code should be specified in the ApiContext. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The unique price list code. + /// + /// + /// + /// + /// /// /// {} /// @@ -336,10 +366,10 @@ public static MozuClient ResendOrderConfirmationEmailClient(Mozu.Api.Contracts.C } /// - /// Updates the user ID of the shopper who placed the order to the current user. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -361,13 +391,13 @@ public static MozuClient ResendOrderConfirmationEmailClient(Mozu.Api.Contracts.C } /// - /// Updates the specified order when additional order information, such as shipping or billing information, is modified during the checkout process. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order to update. + /// /// 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." - /// 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. - /// Properties of an order, including its components. + /// + /// The properties of the order to update. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/AdjustmentClient.cs b/Mozu.Api/Clients/Commerce/Orders/AdjustmentClient.cs old mode 100644 new mode 100755 index 5b14f087..b774d6b4 --- a/Mozu.Api/Clients/Commerce/Orders/AdjustmentClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/AdjustmentClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,12 +23,12 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class AdjustmentClient { /// - /// Updates the order handling adjustment. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// /// /// /// {} @@ -50,13 +51,13 @@ public partial class AdjustmentClient { } /// - /// Applies a shipping adjustment to the specified order. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of an ad-hoc price adjustment for an order. + /// Unique identifier of the order associated with the shipping adjustment. + /// + /// Specifies whether to apply the shipping adjustment by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Properties of the shipping adjustment to apply to the order. /// /// {} /// @@ -78,13 +79,13 @@ public partial class AdjustmentClient { } /// - /// Applies a price adjustment to the specified order. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of an ad-hoc price adjustment for an order. + /// Unique identifier of the order for which to apply the adjustment. + /// + /// Specifies whether to apply the adjustment by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Properties of the price adjustment to apply to the order. /// /// {} /// @@ -106,11 +107,11 @@ public partial class AdjustmentClient { } /// - /// Removes an adjustment to the order handling fee. + /// /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// /// /// {} /// @@ -132,11 +133,11 @@ public partial class AdjustmentClient { } /// - /// Removes a shipping adjustment previously applied to an order or draft. + /// /// - /// Unique identifier of the order. - /// 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." - /// 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. + /// Unique identifier of the order with the applied shipping adjustment. + /// Specifies whether to remove the shipping adjustment by updating the original order, updating the order in draft mode, or updating 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." + /// /// /// {} /// @@ -158,11 +159,11 @@ public partial class AdjustmentClient { } /// - /// Removes a price adjustment from the specified order. + /// /// - /// Unique identifier of the order. - /// 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." - /// 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. + /// Unique identifier of the order for which to delete the adjustment. + /// Specifies whether to remove the adjustment by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/AppliedDiscountClient.cs b/Mozu.Api/Clients/Commerce/Orders/AppliedDiscountClient.cs old mode 100644 new mode 100755 index 9bb448b4..be12f042 --- a/Mozu.Api/Clients/Commerce/Orders/AppliedDiscountClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/AppliedDiscountClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,13 +23,13 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class AppliedDiscountClient { /// - /// Apply a coupon to the order. + /// /// - /// Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// + /// Unique identifier of the order to associate the coupon. System-supplied and read-only. + /// + /// Specifies whether to apply the coupon by updating the original order, updating the order in draft mode, or updating 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." + /// /// /// {} /// @@ -50,12 +51,12 @@ public partial class AppliedDiscountClient { } /// - /// Removes a coupon previously applied to the order. + /// /// - /// Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// Unique identifier of the order. - /// 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." - /// 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. + /// + /// Unique identifier of the order with the coupon to remove. + /// Specifies whether to remove the coupon by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// {} /// @@ -77,11 +78,11 @@ public partial class AppliedDiscountClient { } /// - /// Removes all coupons previously applied to the order. + /// /// - /// Unique identifier of the order. - /// 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." - /// 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. + /// Unique identifier of the order with the coupons to remove. + /// Specifies whether to remove coupons by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/Attributedefinition/AttributeClient.cs b/Mozu.Api/Clients/Commerce/Orders/Attributedefinition/AttributeClient.cs old mode 100644 new mode 100755 index 862affb6..3777be67 --- a/Mozu.Api/Clients/Commerce/Orders/Attributedefinition/AttributeClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/Attributedefinition/AttributeClient.cs @@ -13,24 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders.Attributedefinition { /// - /// Attributes are used to add custom definitions and characteristics to the following objects: - - + /// Use the Order Attribute Definition resource to manage the attributes that uniquely describe orders, such as the associated shopping season or "How did you hear about us?". Merchants can display order attributes on the order summary, the order confirmation page, invoices, or packing slips. /// public partial class AttributeClient { /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// {} /// @@ -52,9 +51,9 @@ public partial class AttributeClient { } /// - /// Retrieve a list of the vocabulary values defined for the customer attribute specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// {List{}} /// @@ -76,10 +75,10 @@ public partial class AttributeClient { } /// - /// Retrieves the details of the specified product attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// {} /// @@ -101,10 +100,10 @@ public partial class AttributeClient { } /// - /// Create and save a new attribute. These attributes are used in products and product options. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an attribute used to describe customers or orders. + /// + /// The properties of the order attribute to create. /// /// {} /// @@ -126,11 +125,11 @@ public partial class AttributeClient { } /// - /// Updates an existing attribute with attribute properties to set. + /// /// - /// Fully qualified name for an attribute. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an attribute used to describe customers or orders. + /// + /// + /// The properties of the order attribute to update. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/BillingInfoClient.cs b/Mozu.Api/Clients/Commerce/Orders/BillingInfoClient.cs old mode 100644 new mode 100755 index 30fa53be..39327a8a --- a/Mozu.Api/Clients/Commerce/Orders/BillingInfoClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/BillingInfoClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class BillingInfoClient { /// - /// Retrieves the billing information associated with an order. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. + /// If true, retrieve the draft version of the order billing information, which might include uncommitted changes. /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -48,13 +49,13 @@ public partial class BillingInfoClient { } /// - /// Updates the billing information supplied for an order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of the billing information entered for an order during checkout. + /// + /// Specifies whether to set the billing information by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// The properties of the order billing information to update. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/DigitalPackageClient.cs b/Mozu.Api/Clients/Commerce/Orders/DigitalPackageClient.cs old mode 100644 new mode 100755 index 91187c27..04126ac7 --- a/Mozu.Api/Clients/Commerce/Orders/DigitalPackageClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/DigitalPackageClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class DigitalPackageClient { /// - /// Retrieves a collection of fulfillment options for digital packages. Options may include emailed files/links or provided links. + /// /// /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. + /// This parameter provides the unique identifier of the order on which to get a list of available actions. /// /// {List{string}} /// @@ -47,11 +48,11 @@ public static MozuClient> GetAvailableDigitalPackageFulfillmentActi } /// - /// This operation retreives a digital package within an order and it requires two parameters: orderId and digitalPackageId. + /// /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// This parameter provides the digital package Id. + /// This parameter provides the unique identifier of the order with which to associate the digital package. + /// /// /// {} /// @@ -73,11 +74,11 @@ public static MozuClient> GetAvailableDigitalPackageFulfillmentActi } /// - /// Lets you apply a digital package to the order using the orderId and digitalPackage parameters. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Lets you manage an order's digital packages, by applying a digital package to the order. + /// The orderID is a required paramter for the digitalpackages operation. The orderId is a unique identifier of the order with which to associate the digital package. + /// + /// The digitalPackage parameter is a required parameter for the CreateDigitalPackages operation. The digitalPackage is the digital package to create and add to the order. /// /// {} /// @@ -99,12 +100,12 @@ public static MozuClient> GetAvailableDigitalPackageFulfillmentActi } /// - /// This method operates on one digital package, specified by the id given. This method ensures that the digital package ID provided is in the order with the id given, and then updates the properties of that package with the properties of the one passed in using the ‘digitalpackage’ parameter. + /// /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Lets you manage an order's digital packages, by applying a digital package to the order. + /// This parameter specifies the digital package to update in the order. + /// This parameter provides the unique identifier of the order with which to associate the digital package. + /// + /// This parameter provides the package content to update in the order. /// /// {} /// @@ -126,10 +127,10 @@ public static MozuClient> GetAvailableDigitalPackageFulfillmentActi } /// - /// This operation deletes a digital package from an order. This operation requires three parameters: orderId, digitalPackageId, and digitalPackage. + /// /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. + /// The digitalPackage ID is unique package ID to update on the order. + /// The orderId is unique identifier of the order with which to associate the package. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Orders/ExtendedPropertyClient.cs b/Mozu.Api/Clients/Commerce/Orders/ExtendedPropertyClient.cs old mode 100644 new mode 100755 index 01d783b8..920ca17d --- a/Mozu.Api/Clients/Commerce/Orders/ExtendedPropertyClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/ExtendedPropertyClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { /// - /// Use the Extended Properties resource to store tracking strings for your orders. Extended properties can help you track affiliate sources. + /// /// public partial class ExtendedPropertyClient { /// - /// Retrieves the extended property string associated with the order. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. + /// + /// /// /// {List{}} /// @@ -47,12 +48,12 @@ public partial class ExtendedPropertyClient { } /// - /// Creates an extended property for the order. + /// /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The details of the extended property. + /// + /// + /// + /// /// /// {List{}} /// @@ -74,15 +75,15 @@ public partial class ExtendedPropertyClient { } /// - /// Updates one ore more extended properties. + /// /// - /// The extended property key. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Inserts and updates an extended property. - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The details of the updated extended property. + /// + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -104,13 +105,13 @@ public partial class ExtendedPropertyClient { } /// - /// Updates one or more extended properties. + /// /// - /// Unique identifier of the order. - /// 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." - /// Inserts and updates the extended property. - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The details of the updated extended properties. + /// + /// + /// + /// + /// /// /// {List{}} /// @@ -132,12 +133,12 @@ public partial class ExtendedPropertyClient { } /// - /// Deletes one or more extended properties. + /// /// - /// The extended property key. - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// /// /// /// @@ -159,12 +160,12 @@ public static MozuClient DeleteExtendedPropertyClient(string orderId, string key } /// - /// Deletes the extended property associated with the order. + /// /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The extended property keys. + /// + /// + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Orders/FulfillmentActionClient.cs b/Mozu.Api/Clients/Commerce/Orders/FulfillmentActionClient.cs old mode 100644 new mode 100755 index 34c40613..79b3e3c9 --- a/Mozu.Api/Clients/Commerce/Orders/FulfillmentActionClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/FulfillmentActionClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class FulfillmentActionClient { /// - /// Sets the fulfillment action to "Ship" or "PickUp". To ship an order or prepare it for in-store pickup, the order must have a customer name, the "Open" or "OpenAndProcessing" status. To ship the order, it must also have the full shipping address and shipping method. Shipping all packages or picking up all pickups for an order will complete a paid order. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an action to perform when fulfilling an item in an order, whether through in-store pickup or direct shipping. + /// Unique identifier of the order for which to perform the fulfillment action. + /// Updated order with a new fulfillment status resulting from the action supplied in the request. + /// The action to perform for the order fulfillment. /// /// {} /// @@ -48,11 +49,11 @@ public partial class FulfillmentActionClient { } /// - /// Resends an email with details about the package fulfillment to the shopper. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an action to perform when fulfilling an item in an order, whether through in-store pickup or direct shipping. + /// + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/FulfillmentInfoClient.cs b/Mozu.Api/Clients/Commerce/Orders/FulfillmentInfoClient.cs old mode 100644 new mode 100755 index 08646098..8c74f7b9 --- a/Mozu.Api/Clients/Commerce/Orders/FulfillmentInfoClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/FulfillmentInfoClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class FulfillmentInfoClient { /// - /// Retrieves a list of the fulfillment information for the specified order. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. + /// If true, retrieve the draft version of the order's fulfillment information, which might include uncommitted changes. /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -48,13 +49,13 @@ public partial class FulfillmentInfoClient { } /// - /// Updates one or more properties of fulfillment information for the specified order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of the information needed to fulfill an order, whether via in-store pickup or direct shipping. + /// + /// Specifies whether to set the fulfillment information by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Array list of fulfillment information associated with an order. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/OrderAttributeClient.cs b/Mozu.Api/Clients/Commerce/Orders/OrderAttributeClient.cs old mode 100644 new mode 100755 index 066dfe51..f75b70af --- a/Mozu.Api/Clients/Commerce/Orders/OrderAttributeClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/OrderAttributeClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class OrderAttributeClient { /// - /// Retrieves a list of the attributes defined for the order specified in the request. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order for which to retrieve a list of defined attributes. /// /// {List{}} /// @@ -46,10 +47,10 @@ public partial class OrderAttributeClient { } /// - /// Applies a list of attributes to the order specified in the request and defines a value for each attribute in the request body. + /// /// - /// Unique identifier of the order. - /// Properties of an attribute applied to an order. + /// Unique identifier of the order for which to assign the attributes. + /// The list of attributes to associate with the order, and the properties of each attribute to define for the order. /// /// {List{}} /// @@ -71,11 +72,11 @@ public partial class OrderAttributeClient { } /// - /// Updates one or more properties of an attribute defined for the order specified in the request. + /// /// - /// Unique identifier of the order. + /// Identifier of the order for which to update attributes. /// If true, the operation removes missing properties so that the updated order attributes will not show properties with a null value. - /// Properties of an attribute applied to an order. + /// List of order attributes to update, including the properties of each defined attribute in the list. /// /// {List{}} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/OrderItemClient.cs b/Mozu.Api/Clients/Commerce/Orders/OrderItemClient.cs old mode 100644 new mode 100755 index 09cc5b18..467b5bcf --- a/Mozu.Api/Clients/Commerce/Orders/OrderItemClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/OrderItemClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,12 +23,12 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class OrderItemClient { /// - /// Retrieves an order item with the order line ID. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// The specific line id that's associated with the order item. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// {} /// @@ -49,12 +50,12 @@ public partial class OrderItemClient { } /// - /// Retrieves the details of a single order item. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. + /// If true, retrieve the draft version of this order item, which might include uncommitted changes to the order item, the order, or other order components. + /// Unique identifier of the order item to retrieve. + /// Unique identifier of the order item details to retrieve. + /// /// /// {} /// @@ -76,11 +77,11 @@ public partial class OrderItemClient { } /// - /// Retrieves the details of all items in an order. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// If true, retrieve the draft version of the order's items, which might include uncommitted changes to one or more order items, the order itself, or other order components. + /// Unique identifier of the order items to retrieve. + /// /// /// {} /// @@ -102,14 +103,14 @@ public partial class OrderItemClient { } /// - /// Adds a new item to a defined order. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// If true, skip the process to validate inventory when creating this product reservation. - /// 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." - /// 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. - /// The details associated with a specific item in an order. + /// Unique identifier of the order for which to add the item. + /// + /// If true, do not validate the product inventory when adding this item to the order. + /// Specifies whether to add the item by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// The properties of the item to create in the existing order. /// /// {} /// @@ -131,15 +132,15 @@ public partial class OrderItemClient { } /// - /// Update the discount applied to an item in an order. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of all applied discounts for an associated cart, order, or product. + /// Unique identifier of the discount. System-supplied and read only. + /// Unique identifier of the order associated with the item discount. + /// Unique identifier of the item in the order. + /// + /// Specifies whether to change the item discount by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Properties of the discount to modify for the order item. /// /// {} /// @@ -161,14 +162,14 @@ public partial class OrderItemClient { } /// - /// Update the duty fee information for an order item. + /// /// - /// The amount added to the order item for duty fees. - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -190,14 +191,14 @@ public partial class OrderItemClient { } /// - /// Updates the item fulfillment information for the order specified in the request. + /// /// /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// The details associated with a specific item in an order. + /// Unique identifier of the item in the order. + /// + /// Specifies whether to apply the coupon by updating the original order, updating the order in draft mode, or updating 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." + /// + /// Properties of the order item to update for fulfillment. /// /// {} /// @@ -219,14 +220,14 @@ public partial class OrderItemClient { } /// - /// Override the price of an individual product on a line item in the specified order. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. + /// Unique identifier of the order containing the item to price override. + /// Unique identifier of the item in the order to price override. /// The override price to specify for this item in the specified order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// + /// Specifies whether to change the product price by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// {} /// @@ -248,14 +249,14 @@ public partial class OrderItemClient { } /// - /// Update the quantity of an item in an order. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// Unique identifier of the order containing the item to update quantity. + /// Unique identifier of the item in the order to update quantity. + /// The quantity of the item in the order to update. + /// + /// Specifies whether to change the item quantity by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// {} /// @@ -277,12 +278,12 @@ public partial class OrderItemClient { } /// - /// Removes a previously added item from a defined order. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order with the item to remove. /// Unique identifier of the item to remove from the order. - /// 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." - /// 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. + /// Specifies whether to remove the item by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/OrderNoteClient.cs b/Mozu.Api/Clients/Commerce/Orders/OrderNoteClient.cs old mode 100644 new mode 100755 index 426ba0b2..8e688cf7 --- a/Mozu.Api/Clients/Commerce/Orders/OrderNoteClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/OrderNoteClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,7 +23,7 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class OrderNoteClient { /// - /// Retrieves a list of all notes for an order. + /// /// /// Unique identifier of the order. /// @@ -46,11 +47,11 @@ public partial class OrderNoteClient { } /// - /// Retrieves the details of a specific order note. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order note to retrieve. + /// Unique identifier of the order associated with the note. + /// /// /// {} /// @@ -72,11 +73,11 @@ public partial class OrderNoteClient { } /// - /// Creates a new merchant note for the specified order. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of an order note for a merchant, which is internal only for administrative purposes and not available to the shopper. + /// Unique identifier of the order for which to add a note. + /// + /// The alphanumeric text contained in the note. The maximum length is 256 characters. /// /// {} /// @@ -98,12 +99,12 @@ public partial class OrderNoteClient { } /// - /// Updates a specific note for an order. + /// /// - /// Unique identifier of a particular note to retrieve. + /// Unique identifier of the order note. /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of an order note for a merchant, which is internal only for administrative purposes and not available to the shopper. + /// + /// The content of the order note. The maximum length is 256 characters. /// /// {} /// @@ -125,10 +126,10 @@ public partial class OrderNoteClient { } /// - /// Deletes the specified order note. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the order. + /// Unique identifier of the order note to delete. + /// Unique identifier of the order associated with the note. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Orders/OrderReturnableItemClient.cs b/Mozu.Api/Clients/Commerce/Orders/OrderReturnableItemClient.cs old mode 100644 new mode 100755 index 08e2aa50..e626a5b5 --- a/Mozu.Api/Clients/Commerce/Orders/OrderReturnableItemClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/OrderReturnableItemClient.cs @@ -13,22 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { /// - /// Use this subresource to view which order items are eligible for return. + /// /// public partial class OrderReturnableItemClient { /// - /// Retrieves information about which items are eligible for return on an order.Each item displays the following information: - - - + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/OrderValidationResultClient.cs b/Mozu.Api/Clients/Commerce/Orders/OrderValidationResultClient.cs old mode 100644 new mode 100755 index 98f1e964..03d15f25 --- a/Mozu.Api/Clients/Commerce/Orders/OrderValidationResultClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/OrderValidationResultClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,7 +23,7 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class OrderValidationResultClient { /// - /// Retrieves a list of the validation results associated with the order. + /// /// /// Unique identifier of the order. /// @@ -46,11 +47,11 @@ public partial class OrderValidationResultClient { } /// - /// Add a new order validation result to a submitted order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of the resulting order validation performed by an order validation capability. + /// + /// Properties of the validation result to add for the order. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/PackageClient.cs b/Mozu.Api/Clients/Commerce/Orders/PackageClient.cs old mode 100644 new mode 100755 index 2d61fbff..06770603 --- a/Mozu.Api/Clients/Commerce/Orders/PackageClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/PackageClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class PackageClient { /// - /// Retrieves a list of the actions available to perform for a package associated with order fulfillment. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. + /// Unique identifier of the order associated with the package fulfillment. + /// Unique identifier of the package associated with the fulfillment actions to retrieve. /// /// {List{string}} /// @@ -47,9 +48,9 @@ public static MozuClient> GetAvailablePackageFulfillmentActionsClie } /// - /// Retrieves the package label image supplied by the carrier. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order associated with the package label to retrieve. /// Unique identifier of the package for which to retrieve the label. /// /// {} @@ -72,11 +73,11 @@ public static MozuClient> GetAvailablePackageFulfillmentActionsClie } /// - /// Retrieves the details of a package of order items. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the package to retrieve. + /// Unique identifier of the package to retrieve. + /// /// /// {} /// @@ -98,11 +99,11 @@ public static MozuClient> GetAvailablePackageFulfillmentActionsClie } /// - /// Creates a new physical package of order items. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of a physical package shipped for an order. + /// Unique identifier of the order associated with this package. + /// + /// Properties of the physical package of order items. /// /// {} /// @@ -124,12 +125,12 @@ public static MozuClient> GetAvailablePackageFulfillmentActionsClie } /// - /// Updates one or more properties of a physical package of order items. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Properties of a physical package shipped for an order. + /// Unique identifier of the order associated with the package to update. + /// Unique identifier of the package of order items to update. + /// + /// Wrapper of properties for the package of order items to update. /// /// {} /// @@ -151,10 +152,10 @@ public static MozuClient> GetAvailablePackageFulfillmentActionsClie } /// - /// Removes a physical package of items from the specified order. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. + /// Unique identifier of the order associated with the package to delete. + /// Unique identifier of the package to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Orders/PaymentClient.cs b/Mozu.Api/Clients/Commerce/Orders/PaymentClient.cs old mode 100644 new mode 100755 index d40d3a88..7d39dd18 --- a/Mozu.Api/Clients/Commerce/Orders/PaymentClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/PaymentClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class PaymentClient { /// - /// Retrieves information about all payment transactions submitted for the specified order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -47,10 +48,10 @@ public partial class PaymentClient { } /// - /// Retrieves the list of all available payment actions dependent on the order payment status by specifying the order ID. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. + /// Unique identifier of the order associated with the payment. + /// Unique identifer of the payment for which to retrieve available actions. /// /// {List{string}} /// @@ -72,11 +73,11 @@ public static MozuClient> GetAvailablePaymentActionsClient(string o } /// - /// Retrieves information about a specific payment transaction submitted for the specified order. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the payment transaction. + /// Unique identifier of the payment transaction submitted for the order. + /// /// /// {} /// @@ -98,12 +99,12 @@ public static MozuClient> GetAvailablePaymentActionsClient(string o } /// - /// Performs the specified action for an individual order payment transaction. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Properties of the payment action performed for an order. + /// Unique identifier of the order associated with the payment. + /// Unique identifer of the payment for which to perform the action. + /// + /// The action to perform for the payment. Possible values are AuthAndCapture, AuthorizePayment, CapturePayment, VoidPayment, CreditPayment, RequestCheck, ApplyCheck, DeclineCheck. /// /// {} /// @@ -125,11 +126,11 @@ public static MozuClient> GetAvailablePaymentActionsClient(string o } /// - /// Creates a new payment transaction for the specified order and performs the specified action. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of the payment action performed for an order. + /// Unique identifier of the order for which to apply the payment. + /// + /// To action to perform for the newly created payment. Possible values are AuthAndCapture, AuthorizePayment, CapturePayment, VoidPayment, CreditPayment, RequestCheck, ApplyCheck, DeclineCheck. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Orders/PickupClient.cs b/Mozu.Api/Clients/Commerce/Orders/PickupClient.cs old mode 100644 new mode 100755 index 5ef5b904..d26400e5 --- a/Mozu.Api/Clients/Commerce/Orders/PickupClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/PickupClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class PickupClient { /// - /// Retrieves a list of the actions available to perform for the pickup specified in the request. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. + /// Unique identifier of the order associated with the pickup. + /// Unique identifier of the pickup for which to retrieve available actions. /// /// {List{string}} /// @@ -47,11 +48,11 @@ public static MozuClient> GetAvailablePickupFulfillmentActionsClien } /// - /// Retrieves the details of the in-store pickup specified in the request. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the pickup. + /// Unique identifier of the pickup to retrieve. + /// /// /// {} /// @@ -73,11 +74,11 @@ public static MozuClient> GetAvailablePickupFulfillmentActionsClien } /// - /// Create a new pickup for the order specified in the request for in-store fufillment. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of an in-store pickup defined to fulfill items in an order. + /// + /// Properties of the in-store pickup to create. /// /// {} /// @@ -99,12 +100,12 @@ public static MozuClient> GetAvailablePickupFulfillmentActionsClien } /// - /// Updates one or more details of a defined in-store pickup. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// Use this field to include those fields which are not included by default. - /// Properties of an in-store pickup defined to fulfill items in an order. + /// Unique identifier of the order associated with the in-store pickup. + /// Unique identifier of the pickup to update. + /// + /// Properties of the in-store pickup to update. /// /// {} /// @@ -126,9 +127,9 @@ public static MozuClient> GetAvailablePickupFulfillmentActionsClien } /// - /// Removes a pickup previously defined for order item in-store pickup fulfillment. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order associated with the pickup. /// Unique identifier of the pickup to remove. /// /// diff --git a/Mozu.Api/Clients/Commerce/Orders/RefundClient.cs b/Mozu.Api/Clients/Commerce/Orders/RefundClient.cs old mode 100644 new mode 100755 index 861f06d8..4931ee65 --- a/Mozu.Api/Clients/Commerce/Orders/RefundClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/RefundClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { /// - /// Use the refunds resource to create a refund. + /// /// public partial class RefundClient { /// - /// Creates a refund based on the information supplied in the request. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the refund. + /// + /// + /// /// /// {} /// @@ -48,10 +49,10 @@ public partial class RefundClient { } /// - /// Resends the order refund email previously sent to the shopper. + /// /// - /// Unique identifier of the order. - /// Unique ID of the refund. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Orders/ShipmentClient.cs b/Mozu.Api/Clients/Commerce/Orders/ShipmentClient.cs old mode 100644 new mode 100755 index 0a2ca589..124fc651 --- a/Mozu.Api/Clients/Commerce/Orders/ShipmentClient.cs +++ b/Mozu.Api/Clients/Commerce/Orders/ShipmentClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Orders { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Orders public partial class ShipmentClient { /// - /// Retrieves the details of the order shipment specified in the request. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the shipment to retrieve. + /// /// Unique identifier of the shipment to retrieve. /// /// {} @@ -48,10 +49,10 @@ public partial class ShipmentClient { } /// - /// Retrieves the available shipping methods applicable to the order. Typically used to display available shipping method options on the checkout page. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. + /// + /// Unique identifier of the order for the available shipment methods being retrieved. /// /// {List{}} /// @@ -73,9 +74,9 @@ public partial class ShipmentClient { } /// - /// Creates a shipment from one or more package associated with an order and assign a label and tracking number to an order shipment. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order for this shipment. /// List of unique identifiers for each package associated with this shipment. Not all packages must belong to the same shipment. /// /// {List{}} @@ -98,10 +99,10 @@ public partial class ShipmentClient { } /// - /// Deletes the shipment specified in the request. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the shipment to retrieve. + /// Unique identifier of the order to cancel shipment. + /// Unique identifier of the shipment to cancel. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Payments/FraudScreenClient.cs b/Mozu.Api/Clients/Commerce/Payments/FraudScreenClient.cs old mode 100644 new mode 100755 index daf41acd..e477b3c0 --- a/Mozu.Api/Clients/Commerce/Payments/FraudScreenClient.cs +++ b/Mozu.Api/Clients/Commerce/Payments/FraudScreenClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Payments { /// - /// commerce/payments/fraudscreen related resources. DOCUMENT_HERE + /// /// public partial class FraudScreenClient { /// - /// payments-fraudscreen Post Screen description DOCUMENT_HERE + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Mozu.PaymentService.Contracts.Request.FraudScreenRequest ApiType DOCUMENT_HERE + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Payments/PublicCardClient.cs b/Mozu.Api/Clients/Commerce/Payments/PublicCardClient.cs old mode 100644 new mode 100755 index c5364adc..ba2cffd6 --- a/Mozu.Api/Clients/Commerce/Payments/PublicCardClient.cs +++ b/Mozu.Api/Clients/Commerce/Payments/PublicCardClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Payments { /// - /// commerce/payments/cards related resources. DOCUMENT_HERE + /// /// public partial class PublicCardClient { /// - /// payments-cards Post Create description DOCUMENT_HERE + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Mozu.PaymentService.Contracts.PublicCard ApiType DOCUMENT_HERE + /// + /// /// /// {} /// @@ -47,11 +48,11 @@ public partial class PublicCardClient { } /// - /// payments-cards Put Update description DOCUMENT_HERE + /// /// - /// Unique identifier of the card associated with the customer account billing contact. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Mozu.PaymentService.Contracts.PublicCard ApiType DOCUMENT_HERE + /// + /// + /// /// /// {} /// @@ -73,9 +74,9 @@ public partial class PublicCardClient { } /// - /// payments-cards Delete Delete description DOCUMENT_HERE + /// /// - /// Unique identifier of the card associated with the customer account billing contact. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/ReturnClient.cs b/Mozu.Api/Clients/Commerce/ReturnClient.cs old mode 100644 new mode 100755 index 502539d3..4f0cf10e --- a/Mozu.Api/Clients/Commerce/ReturnClient.cs +++ b/Mozu.Api/Clients/Commerce/ReturnClient.cs @@ -13,23 +13,24 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce { /// - /// Use the Returns resource to manage returned items that were previously fufilled. Returns can include any number of items associated with an original order. Each return must either be associated with an original order or a product definition to represent each returned item.Refer to the [Returns API](https://www.mozu.com/docs/developer/api-guides/returns.htm) topic for more information about creating and processing returns using the API. + /// Use the Returns resource to manage returned items that were previously fufilled. Returns can include any number of items associated with an original Mozu order. Each return must either be associated with an original order or a product definition to represent each returned item. /// public partial class ReturnClient { /// - /// Retrieves a list of all returns according to any filter and sort criteria. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -51,9 +52,9 @@ public partial class ReturnClient { } /// - /// Retrieves a list of the actions available to perform for the specified return based on its current state. + /// /// - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return for which to retrieve available actions. /// /// {List{string}} /// @@ -75,11 +76,11 @@ public static MozuClient> GetAvailableReturnActionsClient(string re } /// - /// Retrieves the details of a single return item. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the return item whose details you want to get. + /// + /// + /// /// /// {} /// @@ -101,10 +102,10 @@ public static MozuClient> GetAvailableReturnActionsClient(string re } /// - /// Retrieves the details of all return items in an order. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// {} /// @@ -126,10 +127,10 @@ public static MozuClient> GetAvailableReturnActionsClient(string re } /// - /// Retrieves a list of the payment actions available to perform for the specified return when a return results in a refund to the customer. + /// /// /// Unique identifier of the payment for which to perform the action. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return associated with the payment. /// /// {List{string}} /// @@ -151,11 +152,11 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Retrieves the details of a payment submitted as part of a refund associated with a customer return. + /// /// - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return payment to retrieve. + /// + /// Unique identifier of the return associated with the payment. /// /// {} /// @@ -177,10 +178,10 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Retrieves a list of all payments submitted as part of a refund associated with a customer return. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// Returns the details of the refund payment associated with the return specified in the request. /// /// {} /// @@ -202,10 +203,10 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Retrieves a list of properties for the specified return. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// Returns the properties of the return specified in the request as well as system-supplied information. /// /// {} /// @@ -227,9 +228,9 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Returns a list of reasons for a return. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// @@ -251,13 +252,10 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Creates a return for previously fulfilled items. Each return must either be associated with an original order or a product definition to represent each returned item.When you create a return, you must specify the following fields: - - - + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a return of one or more previously fulfilled items. + /// + /// Wrapper for the properties of the return to create. /// /// {} /// @@ -279,11 +277,11 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Adds a return item to the return. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a previously fulfilled item associated with a return. + /// + /// + /// /// /// {} /// @@ -305,12 +303,12 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Updates a refund payment associated with a customer return by performing the specified action. + /// /// - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of the payment action performed for an order. + /// Unique identifier of the return payment to update. + /// + /// Unique identifier of the return associated with the refund payment. + /// The payment action to perform for the refund payment. /// /// {} /// @@ -332,11 +330,11 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Creates a new payment for a return that results in a refund to the customer. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of the payment action performed for an order. + /// + /// Unique identifier of the return associated with the payment action. + /// The payment action to perform for the customer return. /// /// {} /// @@ -358,10 +356,10 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Creates a replacement order for the return. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// /// {} @@ -384,10 +382,10 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Updates the return by performing the action specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of an action a user can perform for a return. + /// + /// The name of the return action to perform, such as "Reject" or "Authorize". /// /// {} /// @@ -409,11 +407,11 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Updates one or more properties of a return for items previously shipped in a completed order. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a return of one or more previously fulfilled items. + /// + /// Unique identifier of the return. + /// Wrapper for the array of properties to update for the return. /// /// {} /// @@ -435,9 +433,9 @@ public static MozuClient> GetAvailablePaymentActionsForReturnClient } /// - /// Resend the email notification to a shopper that a return has been created. + /// /// - /// Properties of an action a user can perform for a return. + /// /// /// /// @@ -459,10 +457,10 @@ public static MozuClient ResendReturnEmailClient(Mozu.Api.Contracts.CommerceRunt } /// - /// Removes a particular order item from the order of the current shopper. + /// /// - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the return item whose details you want to get. + /// + /// /// /// {} /// @@ -484,9 +482,9 @@ public static MozuClient ResendReturnEmailClient(Mozu.Api.Contracts.CommerceRunt } /// - /// Deletes the return specified in the request. + /// /// - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Returns/OrderNoteClient.cs b/Mozu.Api/Clients/Commerce/Returns/OrderNoteClient.cs old mode 100644 new mode 100755 index bf4afca1..67a91c59 --- a/Mozu.Api/Clients/Commerce/Returns/OrderNoteClient.cs +++ b/Mozu.Api/Clients/Commerce/Returns/OrderNoteClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Returns { /// - /// Use the Return Notes resource to access and modify internal notes associated with returns. These notes can be useful to customer service representatives viewing them in . + /// /// public partial class OrderNoteClient { /// - /// Retrieves all internal notes associated with a return. + /// /// - /// Unique identifier of the return whose items you want to get. + /// /// /// {List{}} /// @@ -46,11 +47,11 @@ public partial class OrderNoteClient { } /// - /// Retrieves a specific internal note from a return. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// + /// /// /// {} /// @@ -72,10 +73,10 @@ public partial class OrderNoteClient { } /// - /// Creates an internal note on a given return. This note is visible in for customer service representatives to see. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// /// {} @@ -98,11 +99,11 @@ public partial class OrderNoteClient { } /// - /// Updates an internal note on a given return. This note is visible in for customer service representatives to see. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// + /// /// /// /// {} @@ -125,10 +126,10 @@ public partial class OrderNoteClient { } /// - /// Deletes an internal note from a given return. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Returns/PackageClient.cs b/Mozu.Api/Clients/Commerce/Returns/PackageClient.cs old mode 100644 new mode 100755 index 10d58ec3..7d059161 --- a/Mozu.Api/Clients/Commerce/Returns/PackageClient.cs +++ b/Mozu.Api/Clients/Commerce/Returns/PackageClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Returns { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Returns public partial class PackageClient { /// - /// Retrieves the package label image supplied by the carrier for a return replacement. + /// /// - /// Unique identifier of the package for which to retrieve the label. - /// Specifies whether to return the RMA label image as Base64-encoded PNG image instead of as a byte array encoded in the original image format. The default is . - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package for which to retrieve the label. + /// + /// Unique identifier of the return associated with the replacement package label to retrieve. /// /// {} /// @@ -48,11 +49,11 @@ public partial class PackageClient { } /// - /// Retrieves the details of a package of return replacement items. + /// /// - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package to retrieve. + /// + /// Unique identifier of the return associated with the replacement package to retrieve. /// /// {} /// @@ -74,11 +75,11 @@ public partial class PackageClient { } /// - /// Creates a new physical package of return replacement items. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a physical package shipped for an order. + /// + /// Unique identifier of the return for which to create a replacement package. + /// Properties of the physical package for a return replacement. /// /// {} /// @@ -100,12 +101,12 @@ public partial class PackageClient { } /// - /// Updates one or more properties of a package associated with a return replacement. + /// /// - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a physical package shipped for an order. + /// Unique identifier of the return replacement package to update. + /// + /// Unique identifier of the return associated with the replacement package to update. + /// Properties of the return replacement package to update. /// /// {} /// @@ -127,10 +128,10 @@ public partial class PackageClient { } /// - /// Deletes a package associated with a return replacement. + /// /// - /// Unique identifier of the package for which to retrieve the label. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package to delete. + /// Unique identifier of the return associated with the replacement package to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Returns/ShipmentClient.cs b/Mozu.Api/Clients/Commerce/Returns/ShipmentClient.cs old mode 100644 new mode 100755 index 9456e8d7..81e5db57 --- a/Mozu.Api/Clients/Commerce/Returns/ShipmentClient.cs +++ b/Mozu.Api/Clients/Commerce/Returns/ShipmentClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Returns { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Returns public partial class ShipmentClient { /// - /// Retrieves the details of the specified return replacement shipment. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the shipment to retrieve. + /// + /// Unique identifier of the return associated with the replacement shipment to retrieve. + /// Unique identifier of the return replacement shipment to retrieve. /// /// {} /// @@ -48,10 +49,10 @@ public partial class ShipmentClient { } /// - /// Creates a shipment from one or more packages associated with a return replacement. + /// /// - /// Unique identifier of the return whose items you want to get. - /// List of unique identifiers for each package associated with this shipment. Not all packages must belong to the same shipment. + /// Unique identifier of the return for which to create replacement package shipments. + /// List of packages in the return replacement shipment. /// /// {List{}} /// @@ -73,10 +74,10 @@ public partial class ShipmentClient { } /// - /// Deletes a shipment for a return replacement. + /// /// - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the shipment to retrieve. + /// Unique identifier of the return associated with the replacement shipment to delete. + /// Unique identifier of the return replacement shipment to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Settings/ApplicationClient.cs b/Mozu.Api/Clients/Commerce/Settings/ApplicationClient.cs old mode 100644 new mode 100755 index 7530a299..f28cf0c9 --- a/Mozu.Api/Clients/Commerce/Settings/ApplicationClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/ApplicationClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Settings public partial class ApplicationClient { /// - /// Retrieve the settings of a third-party application. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -46,10 +47,10 @@ public partial class ApplicationClient { } /// - /// Initializes an application with the necessary configured settings. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of an application installed in a tenant. + /// + /// Properties of the application to update. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Settings/CartSettingsClient.cs b/Mozu.Api/Clients/Commerce/Settings/CartSettingsClient.cs old mode 100644 new mode 100755 index f8bcddd2..2c7a99dc --- a/Mozu.Api/Clients/Commerce/Settings/CartSettingsClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/CartSettingsClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings { /// - /// Use the cart subresource to manage settings for the cart, such as whether to include handling fees in the cost calculations. + /// /// public partial class CartSettingsClient { /// - /// Retrieves cart settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// @@ -46,9 +47,9 @@ public partial class CartSettingsClient { } /// - /// Creates cart settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// {} @@ -71,9 +72,9 @@ public partial class CartSettingsClient { } /// - /// Updates cart settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// {} diff --git a/Mozu.Api/Clients/Commerce/Settings/Checkout/CustomerCheckoutSettingsClient.cs b/Mozu.Api/Clients/Commerce/Settings/Checkout/CustomerCheckoutSettingsClient.cs old mode 100644 new mode 100755 index e6cdd249..68619256 --- a/Mozu.Api/Clients/Commerce/Settings/Checkout/CustomerCheckoutSettingsClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/Checkout/CustomerCheckoutSettingsClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings.Checkout { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Settings.Checkout public partial class CustomerCheckoutSettingsClient { /// - /// Retrieves all checkout settings defined for the site: Payment settings, such as the payment gateway ID and credentials, supported credit cards, and more; Customer Checkout settings, such as whether login is required, and any custom attributes; and Order Processing settings, such as when payment is authorized and captured, and any custom attributes. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -46,10 +47,10 @@ public partial class CustomerCheckoutSettingsClient { } /// - /// Modifies existing site checkout settings. Modify Payment, Customer Checkout, and Order Processing settings in one PUT. + /// /// - /// Use this field to include those fields which are not included by default. - /// The properties of the customer checkout settings such as whether shoppers must be logged in. + /// + /// All the properties to update in the checkout settings. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Settings/Checkout/PaymentSettingsClient.cs b/Mozu.Api/Clients/Commerce/Settings/Checkout/PaymentSettingsClient.cs old mode 100644 new mode 100755 index 24b0e138..514ac049 --- a/Mozu.Api/Clients/Commerce/Settings/Checkout/PaymentSettingsClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/Checkout/PaymentSettingsClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings.Checkout { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Commerce.Settings.Checkout public partial class PaymentSettingsClient { /// - /// Retrieves the schema and definition along with the actual instance values of the third-party payment service workflow configured for the corresponding fully qualified name. + /// /// - /// Fully qualified name of the attribute for the third-party payment workflow. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -47,7 +48,7 @@ public partial class PaymentSettingsClient { } /// - /// Retrieves the schema and definition of all third-party payment service workflows configured for the site. + /// /// /// /// {List{}} @@ -70,9 +71,9 @@ public partial class PaymentSettingsClient { } /// - /// Adds a third-party payment workflow to the site. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the platform. + /// /// - /// Properties of an external payment processing workflow defined for the site. At this time, only PayPal Express is supported. + /// /// /// /// @@ -94,9 +95,9 @@ public static MozuClient AddThirdPartyPaymentWorkflowClient(Mozu.Api.Contracts.S } /// - /// Deletes a third-party payment workflow. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the platform. + /// /// - /// Fully qualified name of the attribute for the third-party payment workflow. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Settings/CheckoutSettingsClient.cs b/Mozu.Api/Clients/Commerce/Settings/CheckoutSettingsClient.cs old mode 100644 new mode 100755 index 110e5e53..52e800ea --- a/Mozu.Api/Clients/Commerce/Settings/CheckoutSettingsClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/CheckoutSettingsClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Settings public partial class CheckoutSettingsClient { /// - /// Retrieves all checkout settings defined for the site including payment settings (payment gateway ID and credentials), shopper checkout settings (login requirement or guest mode and custom attributes), and order processing settings (when payment is authorized and captured plus any custom attributes). + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Settings/General/CustomRouteSettingsClient.cs b/Mozu.Api/Clients/Commerce/Settings/General/CustomRouteSettingsClient.cs old mode 100644 new mode 100755 index 9dbc8371..7ae8f0c9 --- a/Mozu.Api/Clients/Commerce/Settings/General/CustomRouteSettingsClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/General/CustomRouteSettingsClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings.General { /// - /// Use the Custom Routes resource to manage your custom route settings. Custom routing allows you to display SEO-friendly URLs on your site that map behind-the-scenes to conventional resources such as a product page or a search results page. With custom routing, you gain advanced control over the URL structures on your site and can more visibly highlight the products or categories your shoppers are interested in purchasing.To learn more about custom routing, refer to the [Custom Route Settings](../../../guides/settings/custom-routes.htm) topic. + /// /// public partial class CustomRouteSettingsClient { /// - /// Retrieves the custom route settings configured for a site. These are the same settings configured through in the Custom Routing JSON Editor. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// @@ -46,10 +47,10 @@ public partial class CustomRouteSettingsClient { } /// - /// Create new custom route settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new custom route setting. + /// + /// /// /// {} /// @@ -71,10 +72,10 @@ public partial class CustomRouteSettingsClient { } /// - /// Updates custom route settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The updated details of the custom route settings. + /// + /// /// /// {} /// @@ -96,7 +97,7 @@ public partial class CustomRouteSettingsClient { } /// - /// Deletes all the custom route settings for a site, returning all routes to their defaults. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Settings/General/TaxableTerritoryClient.cs b/Mozu.Api/Clients/Commerce/Settings/General/TaxableTerritoryClient.cs old mode 100644 new mode 100755 index 54b58aa9..9dc5c0d9 --- a/Mozu.Api/Clients/Commerce/Settings/General/TaxableTerritoryClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/General/TaxableTerritoryClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings.General { @@ -22,7 +23,7 @@ namespace Mozu.Api.Clients.Commerce.Settings.General public partial class TaxableTerritoryClient { /// - /// Retrieves a list of the taxable territories configured for the site. + /// /// /// /// {List{}} @@ -45,10 +46,10 @@ public partial class TaxableTerritoryClient { } /// - /// Creates a new territory for which to calculate sales tax. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the territory which is subject to sales tax. + /// + /// Properties of the taxable territory to create. /// /// {} /// @@ -70,9 +71,9 @@ public partial class TaxableTerritoryClient { } /// - /// Updates one or more taxable territories configured for a site. + /// /// - /// Properties of the territory which is subject to sales tax. + /// Properties of the taxable territories to update. /// /// {List{}} /// diff --git a/Mozu.Api/Clients/Commerce/Settings/GeneralSettingsClient.cs b/Mozu.Api/Clients/Commerce/Settings/GeneralSettingsClient.cs old mode 100644 new mode 100755 index 981f8562..040f0130 --- a/Mozu.Api/Clients/Commerce/Settings/GeneralSettingsClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/GeneralSettingsClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Settings public partial class GeneralSettingsClient { /// - /// Retrieve a site's general global settings. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -46,10 +47,10 @@ public partial class GeneralSettingsClient { } /// - /// Updates a site's general global settings. + /// /// - /// Use this field to include those fields which are not included by default. - /// General settings used on the storefront site. + /// + /// The properties of the site's general settings to update. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Settings/LocationUsageClient.cs b/Mozu.Api/Clients/Commerce/Settings/LocationUsageClient.cs old mode 100644 new mode 100755 index 89ec4f41..86419a8c --- a/Mozu.Api/Clients/Commerce/Settings/LocationUsageClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/LocationUsageClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Settings public partial class LocationUsageClient { /// - /// Retrieves the configured site location usages for the location usage code specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -46,10 +47,10 @@ public partial class LocationUsageClient { } /// - /// Retrieves the location usages for the site specified in the request header. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// Code that identifies the location usage type, which is "DS" for direct ship, "SP" for in-store pickup, or "storeFinder" for store finder. + /// /// /// {} /// @@ -71,11 +72,11 @@ public partial class LocationUsageClient { } /// - /// Updates the location usage for the site based on the location usage code specified in the request. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// 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. + /// Code that identifies the location usage type, which is "DS" for direct ship, "SP" for in-store pickup, or "storeFinder" for store finder. + /// + /// Properties of the location usage type to update. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Settings/Shipping/SiteShippingHandlingFeeClient.cs b/Mozu.Api/Clients/Commerce/Settings/Shipping/SiteShippingHandlingFeeClient.cs old mode 100644 new mode 100755 index 4c8ea0b2..3a21725f --- a/Mozu.Api/Clients/Commerce/Settings/Shipping/SiteShippingHandlingFeeClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/Shipping/SiteShippingHandlingFeeClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings.Shipping { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Settings.Shipping public partial class SiteShippingHandlingFeeClient { /// - /// Retrieves the details of the order handling fee configured for the site. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -46,10 +47,10 @@ public partial class SiteShippingHandlingFeeClient { } /// - /// Creates a new order handling fee for the site. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the handling fee to apply to order shipments for the site. + /// + /// Properties of the order handling fee to assess for order shipment. /// /// {} /// @@ -71,10 +72,10 @@ public partial class SiteShippingHandlingFeeClient { } /// - /// Updates the order handling fee amount for the site. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the handling fee to apply to order shipments for the site. + /// + /// The combined price for all items in the order, including all selected options but excluding any discounts. /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Settings/SiteShippingSettingsClient.cs b/Mozu.Api/Clients/Commerce/Settings/SiteShippingSettingsClient.cs old mode 100644 new mode 100755 index eb53b550..af319b6d --- a/Mozu.Api/Clients/Commerce/Settings/SiteShippingSettingsClient.cs +++ b/Mozu.Api/Clients/Commerce/Settings/SiteShippingSettingsClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Settings { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Commerce.Settings public partial class SiteShippingSettingsClient { /// - /// Retrieves a list of the shipping settings configured for a site. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Commerce/Shipping/Admin/CarrierConfigurationClient.cs b/Mozu.Api/Clients/Commerce/Shipping/Admin/CarrierConfigurationClient.cs old mode 100644 new mode 100755 index b5fec333..70744978 --- a/Mozu.Api/Clients/Commerce/Shipping/Admin/CarrierConfigurationClient.cs +++ b/Mozu.Api/Clients/Commerce/Shipping/Admin/CarrierConfigurationClient.cs @@ -13,22 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Shipping.Admin { /// - /// Use the Carriers resource to configure and manage your supported shipping carrier configurations. + /// /// public partial class CarrierConfigurationClient { /// - /// Retrieves a list of carrier configurations and their details according to any specified facets, filter criteria, and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class CarrierConfigurationClient { } /// - /// Retrieves the details of the specified carrier configuration. + /// /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -75,11 +76,11 @@ public partial class CarrierConfigurationClient { } /// - /// Creates a new carrier configuration. + /// /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of a carrier configured in the shipping admin. + /// + /// + /// /// /// {} /// @@ -101,11 +102,11 @@ public partial class CarrierConfigurationClient { } /// - /// Updates the details of the specified carrier configuration. + /// /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of a carrier configured in the shipping admin. + /// + /// + /// /// /// {} /// @@ -127,9 +128,9 @@ public partial class CarrierConfigurationClient { } /// - /// Deletes the specified carrier configuration. + /// /// - /// The unique identifier of the carrier configuration. + /// /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesClient.cs b/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesClient.cs new file mode 100755 index 00000000..b1e2b3a5 --- /dev/null +++ b/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesClient.cs @@ -0,0 +1,164 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles +{ + /// + /// + /// + public partial class OrderHandlingFeeRulesClient { + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// {} + /// + /// + /// + /// var mozuClient=GetOrderHandlingFeeRule( profilecode, id, responseFields); + /// var handlingFeeRuleClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetOrderHandlingFeeRuleClient(string profilecode, string id, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesUrl.GetOrderHandlingFeeRuleUrl(profilecode, id, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// {} + /// + /// {} + /// + /// + /// + /// var mozuClient=GetOrderHandlingFeeRules( profilecode, responseFields); + /// var handlingFeeRuleCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetOrderHandlingFeeRulesClient(string profilecode, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesUrl.GetOrderHandlingFeeRulesUrl(profilecode, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=CreateOrderHandlingFeeRule( rule, profilecode, responseFields); + /// var handlingFeeRuleClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient CreateOrderHandlingFeeRuleClient(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesUrl.CreateOrderHandlingFeeRuleUrl(profilecode, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(rule); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=UpdateOrderHandlingFeeRule( rule, profilecode, id, responseFields); + /// var handlingFeeRuleClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient UpdateOrderHandlingFeeRuleClient(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string id, string responseFields = null) + { + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesUrl.UpdateOrderHandlingFeeRuleUrl(profilecode, id, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(rule); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// var mozuClient=DeleteOrderHandlingFeeRule( profilecode, id); + ///mozuClient.WithBaseAddress(url).Execute(); + /// + /// + public static MozuClient DeleteOrderHandlingFeeRuleClient(string profilecode, string id) + { + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesUrl.DeleteOrderHandlingFeeRuleUrl(profilecode, id); + const string verb = "DELETE"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/HandlingFeeRuleClient.cs b/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesClient.cs old mode 100644 new mode 100755 similarity index 61% rename from Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/HandlingFeeRuleClient.cs rename to Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesClient.cs index aad2ee90..6de77339 --- a/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/HandlingFeeRuleClient.cs +++ b/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles { /// - /// Use the ProductHandlingFeeRules sub-resource to manage your product handling fee rules that are associated with a specific shipping profile. + /// /// - public partial class HandlingFeeRuleClient { + public partial class ProductHandlingFeeRulesClient { /// - /// Retrieves the details of the specified product handling fee rule. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// {} /// /// {} @@ -39,7 +40,7 @@ public partial class HandlingFeeRuleClient { /// public static MozuClient GetProductHandlingFeeRuleClient(DataViewMode dataViewMode, string profilecode, string id, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleUrl.GetProductHandlingFeeRuleUrl(profilecode, id, responseFields); + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesUrl.GetProductHandlingFeeRuleUrl(profilecode, id, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -50,10 +51,10 @@ public partial class HandlingFeeRuleClient { } /// - /// Retrieves a list of product handling fee rules and their details. + /// /// - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} /// /// {} @@ -66,7 +67,7 @@ public partial class HandlingFeeRuleClient { /// public static MozuClient GetProductHandlingFeeRulesClient(DataViewMode dataViewMode, string profilecode, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleUrl.GetProductHandlingFeeRulesUrl(profilecode, responseFields); + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesUrl.GetProductHandlingFeeRulesUrl(profilecode, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -77,12 +78,12 @@ public partial class HandlingFeeRuleClient { } /// - /// Creates a new product handling fee rule. + /// /// - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} - /// The details of the new product handling fee rule. + /// /// /// {} /// @@ -94,7 +95,7 @@ public partial class HandlingFeeRuleClient { /// public static MozuClient CreateProductHandlingFeeRuleClient(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleUrl.CreateProductHandlingFeeRuleUrl(profilecode, responseFields); + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesUrl.CreateProductHandlingFeeRuleUrl(profilecode, responseFields); const string verb = "POST"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -104,13 +105,13 @@ public partial class HandlingFeeRuleClient { } /// - /// Updates the details of the specified product handling fee rule. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// {} - /// The updated details of the product handling fee rule. + /// /// /// {} /// @@ -122,7 +123,7 @@ public partial class HandlingFeeRuleClient { /// public static MozuClient UpdateProductHandlingFeeRuleClient(DataViewMode dataViewMode, Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string id, string responseFields = null) { - var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleUrl.UpdateProductHandlingFeeRuleUrl(profilecode, id, responseFields); + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesUrl.UpdateProductHandlingFeeRuleUrl(profilecode, id, responseFields); const string verb = "PUT"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -133,10 +134,10 @@ public partial class HandlingFeeRuleClient { } /// - /// Deletes the specified product handling fee rule. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. + /// + /// /// {} /// /// @@ -149,7 +150,7 @@ public partial class HandlingFeeRuleClient { /// public static MozuClient DeleteProductHandlingFeeRuleClient(DataViewMode dataViewMode, string profilecode, string id) { - var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleUrl.DeleteProductHandlingFeeRuleUrl(profilecode, id); + var url = Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesUrl.DeleteProductHandlingFeeRuleUrl(profilecode, id); const string verb = "DELETE"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) diff --git a/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleClient.cs b/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleClient.cs old mode 100644 new mode 100755 index 2f0849cc..c8330e2b --- a/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleClient.cs +++ b/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles { /// - /// Use the ShippingInclusionRules sub-resource to manage your shipping inclusion rules that are associated with a specific shipping profile. + /// /// public partial class ShippingInclusionRuleClient { /// - /// Retrieves the details of the specified shipping inclusion rule. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// {} /// /// {} @@ -49,10 +50,10 @@ public partial class ShippingInclusionRuleClient { } /// - /// Retrieves a list of shipping inclusion rules and their details. + /// /// - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} /// /// {} @@ -75,12 +76,12 @@ public partial class ShippingInclusionRuleClient { } /// - /// Creates a new shipping inclusion rule. + /// /// - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} - /// The details of the new shipping inclusion rule. + /// /// /// {} /// @@ -102,13 +103,13 @@ public partial class ShippingInclusionRuleClient { } /// - /// Updates the details of the specified shipping inclusion rule. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// {} - /// The updated details of the shipping inclusion rule. + /// /// /// {} /// @@ -130,10 +131,10 @@ public partial class ShippingInclusionRuleClient { } /// - /// Deletes the specified shipping inclusion rule. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. + /// + /// /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ShippingStatesClient.cs b/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ShippingStatesClient.cs old mode 100644 new mode 100755 index 06f1367f..b17dfecc --- a/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ShippingStatesClient.cs +++ b/Mozu.Api/Clients/Commerce/Shipping/Admin/Profiles/ShippingStatesClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles { /// - /// Use the ShippingStates sub-resource to manage the states your shipping profile supports. For example, you can specify one of your shipping profiles to only support Texas, Oklahoma, Arkansas, Louisiana, and New Mexico.Each shipping state is composed of a user-definied code and name. + /// /// public partial class ShippingStatesClient { /// - /// Retrieves a list of shipping states and their details. + /// /// - /// The unique, user-defined code of the profile with which the shipping state is associated. + /// /// {} /// /// {List{}} @@ -47,11 +48,11 @@ public partial class ShippingStatesClient { } /// - /// Updates the details of the shipping states. + /// /// - /// The unique, user-defined code of the profile with which the shipping state is associated. + /// /// {} - /// The updated details of the shipping states associated with the specified profilecode. + /// /// /// {List{}} /// diff --git a/Mozu.Api/Clients/Commerce/Shipping/Admin/ShippingProfileClient.cs b/Mozu.Api/Clients/Commerce/Shipping/Admin/ShippingProfileClient.cs old mode 100644 new mode 100755 index 0f706f44..d3ac1ae9 --- a/Mozu.Api/Clients/Commerce/Shipping/Admin/ShippingProfileClient.cs +++ b/Mozu.Api/Clients/Commerce/Shipping/Admin/ShippingProfileClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Shipping.Admin { /// - /// Use the Profiles resource to manage your shipping profiles. + /// /// public partial class ShippingProfileClient { /// - /// Retrieves a list of shipping profiles. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// {} /// /// {} diff --git a/Mozu.Api/Clients/Commerce/TargetRuleClient.cs b/Mozu.Api/Clients/Commerce/TargetRuleClient.cs old mode 100644 new mode 100755 index b80f10da..40abeb03 --- a/Mozu.Api/Clients/Commerce/TargetRuleClient.cs +++ b/Mozu.Api/Clients/Commerce/TargetRuleClient.cs @@ -13,22 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce { /// - /// Use the TargetRules resource to manage your target rules for products and zones. For example, you can set specific rules that dictate shipping options for specific products. + /// /// public partial class TargetRuleClient { /// - /// Retrieves a list of target rules and their details according to any specified facets, filter criteria, and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// {} /// /// {} @@ -51,10 +52,10 @@ public partial class TargetRuleClient { } /// - /// Retrieves the details of the specified target rule. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} /// /// {} @@ -77,11 +78,11 @@ public partial class TargetRuleClient { } /// - /// Creates a new target rule. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// {} - /// The details of the new target rule. + /// /// /// {} /// @@ -103,10 +104,10 @@ public partial class TargetRuleClient { } /// - /// Validates the details of a target rule. + /// /// /// {} - /// The details of the target rule you want to validate. + /// /// /// /// @@ -128,12 +129,12 @@ public static MozuClient ValidateTargetRuleClient(Mozu.Api.Contracts.ShippingAdm } /// - /// Updates the details of the specified target rule. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} - /// The details of the updated target rule. + /// /// /// {} /// @@ -155,9 +156,9 @@ public static MozuClient ValidateTargetRuleClient(Mozu.Api.Contracts.ShippingAdm } /// - /// Deletes the specified target rule. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// /// {} /// /// diff --git a/Mozu.Api/Clients/Commerce/WishlistClient.cs b/Mozu.Api/Clients/Commerce/WishlistClient.cs old mode 100644 new mode 100755 index 59baab1c..0c0852ca --- a/Mozu.Api/Clients/Commerce/WishlistClient.cs +++ b/Mozu.Api/Clients/Commerce/WishlistClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce { @@ -22,15 +23,15 @@ namespace Mozu.Api.Clients.Commerce public partial class WishlistClient { /// - /// Retrieves a list of shopper wish lists according to any filter and sort criteria. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// + /// + /// A list of search terms to use in the query when searching across wish list name. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// /// /// {} /// @@ -52,10 +53,10 @@ public partial class WishlistClient { } /// - /// Retrieves the details of the shopper wish list specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. + /// + /// Unique identifier of the shopper wish list to retrieve. /// /// {} /// @@ -77,10 +78,10 @@ public partial class WishlistClient { } /// - /// Retrieves the details of a wish list by supplying the wish list name. + /// /// /// The unique identifier of the customer account for which to retrieve wish lists. - /// Use this field to include those fields which are not included by default. + /// /// The name of the wish list to retrieve. /// /// {} @@ -103,10 +104,10 @@ public partial class WishlistClient { } /// - /// Creates a new shopper wish list for the associated customer account. Although customer accounts are maintained at the tenant level, the system stores wish lists at the site level. Newly created wish lists do not have any items. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a shopper wish list defined for a site, associated with a customer account. + /// + /// Properties of the wish list to create. /// /// {} /// @@ -128,11 +129,11 @@ public partial class WishlistClient { } /// - /// Updates one or more properties of a shopper wish list defined for a customer account. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Properties of a shopper wish list defined for a site, associated with a customer account. + /// + /// Unique identifier of the shopper wish list to update. + /// Properties of the shopper wish list to update. /// /// {} /// @@ -154,9 +155,9 @@ public partial class WishlistClient { } /// - /// Deletes the shopper wish list specified in the request and all items associated with it. + /// /// - /// Unique identifier of the wish list. + /// Unique identifier of the wish list to delete. /// /// /// diff --git a/Mozu.Api/Clients/Commerce/Wishlists/WishlistItemClient.cs b/Mozu.Api/Clients/Commerce/Wishlists/WishlistItemClient.cs old mode 100644 new mode 100755 index c6db1f55..756ff5a0 --- a/Mozu.Api/Clients/Commerce/Wishlists/WishlistItemClient.cs +++ b/Mozu.Api/Clients/Commerce/Wishlists/WishlistItemClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Commerce.Wishlists { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Commerce.Wishlists public partial class WishlistItemClient { /// - /// Retrieves the details of an item in a shopper wish list. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. + /// + /// Unique identifier of the wish list item to retrieve. + /// Unique identifier of the wish list associated with the item to retrieve. /// /// {} /// @@ -48,14 +49,14 @@ public partial class WishlistItemClient { } /// - /// Retrieves a list of items in a shopper wish list according to any specified filter and sort criteria. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// Unique identifier of the wish list. + /// + /// + /// + /// + /// + /// Unique identifier of the wish list associated with the items to retrieve. /// /// {} /// @@ -77,15 +78,15 @@ public partial class WishlistItemClient { } /// - /// Retrieve a list of items in a customer wish list by supplying the wish list name. + /// /// - /// The unique identifier of the customer account for which to retrieve wish lists. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// The name of the wish list to retrieve. + /// The unique identifier of the customer account associated with the wish list. + /// + /// + /// + /// + /// + /// The name of the wish list that contains the items to retrieve. /// /// {} /// @@ -107,11 +108,11 @@ public partial class WishlistItemClient { } /// - /// Adds a product in a site's catalog as an item in a shopper wish list. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Properties of an item in a shopper wish list. + /// + /// Unique identifier of the wish list associated with the item to add. + /// Properties of the item to add to the wish list. /// /// {} /// @@ -133,12 +134,12 @@ public partial class WishlistItemClient { } /// - /// Updates the quantity of an item in a shopper wish list. + /// /// - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. + /// The quantity of the item in the wish list. + /// + /// Unique identifier of the wish list associated with the item quantity to update. + /// Unique identifier of the item in the wish list to update quantity. /// /// {} /// @@ -160,12 +161,12 @@ public partial class WishlistItemClient { } /// - /// Updates the details of an item in a shopper wish list. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. - /// Properties of an item in a shopper wish list. + /// + /// Unique identifier of the wish list associated with the item to update. + /// Unique identifier of the item in the shopper wish list to update. + /// Properties of the shopper wish list item to update. /// /// {} /// @@ -187,9 +188,9 @@ public partial class WishlistItemClient { } /// - /// Removes all items associated with a shopper wish list. + /// /// - /// Unique identifier of the wish list. + /// Unique identifier of the wish list associated with the items to remove. /// /// {} /// @@ -211,9 +212,9 @@ public partial class WishlistItemClient { } /// - /// Removes an item from the wish list specified in the request. + /// /// - /// Unique identifier of the wish list. + /// Unique identifier of the wish list associated with the item to remove. /// Unique identifier of the item to remove from the shopper wish list. /// /// diff --git a/Mozu.Api/Clients/Content/DocumentDraftSummaryClient.cs b/Mozu.Api/Clients/Content/DocumentDraftSummaryClient.cs old mode 100644 new mode 100755 index 586fdd78..fce706b6 --- a/Mozu.Api/Clients/Content/DocumentDraftSummaryClient.cs +++ b/Mozu.Api/Clients/Content/DocumentDraftSummaryClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content { @@ -22,12 +23,12 @@ namespace Mozu.Api.Clients.Content public partial class DocumentDraftSummaryClient { /// - /// Retrieves a list of the documents currently in draft state, according to any defined filter and sort criteria. + /// /// - /// List of document lists that contain documents to delete. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. + /// Lists that contain the document drafts. + /// + /// + /// /// /// {} /// @@ -49,7 +50,7 @@ public partial class DocumentDraftSummaryClient { } /// - /// Deletes the drafts of the specified documents. Published documents cannot be deleted. + /// /// /// List of document lists that contain documents to delete. /// Unique identifiers of the documents to delete. @@ -74,10 +75,10 @@ public static MozuClient DeleteDocumentDraftsClient(List documentIds, st } /// - /// Publish one or more document drafts to live content on the site. + /// /// - /// List of document lists that contain documents to delete. - /// Unique identifiers of the documents to delete. + /// List of document lists that contain documents to publish. + /// List of unique identifiers of the document drafts to publish. /// /// /// diff --git a/Mozu.Api/Clients/Content/DocumentListClient.cs b/Mozu.Api/Clients/Content/DocumentListClient.cs old mode 100644 new mode 100755 index 7176e66a..7376dc75 --- a/Mozu.Api/Clients/Content/DocumentListClient.cs +++ b/Mozu.Api/Clients/Content/DocumentListClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Content public partial class DocumentListClient { /// - /// Retrieves a collection of document lists. + /// /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// {} @@ -49,10 +50,10 @@ public partial class DocumentListClient { } /// - /// Retrieve the details of a document list by providing the list name. + /// /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. + /// The name of the document list. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class DocumentListClient { } /// - /// Creates a new documentList + /// /// - /// Use this field to include those fields which are not included by default. - /// The list of document types and related properties that define content used by the content management system (CMS). + /// + /// /// /// {} /// @@ -101,11 +102,11 @@ public partial class DocumentListClient { } /// - /// Updates a `DocumentListName`. + /// /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// The list of document types and related properties that define content used by the content management system (CMS). + /// + /// + /// /// /// {} /// @@ -127,9 +128,9 @@ public partial class DocumentListClient { } /// - /// Deletes the specified `DocumentListName`. + /// /// - /// Name of content documentListName to delete + /// /// /// /// diff --git a/Mozu.Api/Clients/Content/DocumentListTypeClient.cs b/Mozu.Api/Clients/Content/DocumentListTypeClient.cs old mode 100644 new mode 100755 index 25662f57..de0b75b3 --- a/Mozu.Api/Clients/Content/DocumentListTypeClient.cs +++ b/Mozu.Api/Clients/Content/DocumentListTypeClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content { /// - /// Use the Document List Types resource to manage the types of document lists in your site's document hierarchy. The type denotes a content type for that list of folders, sub-folders, and documents such as `web_pages`. + /// /// public partial class DocumentListTypeClient { /// - /// Gets all the available documentListTypes. + /// /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// /// /// {} /// @@ -49,10 +50,10 @@ public partial class DocumentListTypeClient { } /// - /// Gets a documentListType. + /// /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class DocumentListTypeClient { } /// - /// Creates a new documentListType. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties for the document list type. Document lists contain documents with an associated document type, such as web pages. + /// + /// /// /// {} /// @@ -101,11 +102,11 @@ public partial class DocumentListTypeClient { } /// - /// Updates a DocumentListType + /// /// /// - /// Use this field to include those fields which are not included by default. - /// Properties for the document list type. Document lists contain documents with an associated document type, such as web pages. + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Content/DocumentTypeClient.cs b/Mozu.Api/Clients/Content/DocumentTypeClient.cs old mode 100644 new mode 100755 index 19bf4fa9..314f6791 --- a/Mozu.Api/Clients/Content/DocumentTypeClient.cs +++ b/Mozu.Api/Clients/Content/DocumentTypeClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Content public partial class DocumentTypeClient { /// - /// Retrieves a paged list of the system-defined document types. + /// /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. + /// + /// + /// /// /// {} /// @@ -49,10 +50,10 @@ public partial class DocumentTypeClient { } /// - /// Retrieves a system-defined document type. + /// /// /// The name of the document type to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class DocumentTypeClient { } /// - /// Creates a new DocumentType + /// /// - /// Use this field to include those fields which are not included by default. - /// The type of documents used in the CMS such as "web_page" or "template" or "image_url". + /// + /// /// /// {} /// @@ -101,11 +102,11 @@ public partial class DocumentTypeClient { } /// - /// Updates a DocumentType + /// /// - /// The name of the document type to retrieve. - /// Use this field to include those fields which are not included by default. - /// The type of documents used in the CMS such as "web_page" or "template" or "image_url". + /// + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Content/Documentlists/DocumentClient.cs b/Mozu.Api/Clients/Content/Documentlists/DocumentClient.cs old mode 100644 new mode 100755 index 3d3a6261..52a4ebae --- a/Mozu.Api/Clients/Content/Documentlists/DocumentClient.cs +++ b/Mozu.Api/Clients/Content/Documentlists/DocumentClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content.Documentlists { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Content.Documentlists public partial class DocumentClient { /// - /// Retrieve the content associated with a document, such as a product image or PDF specifications file, by supplying the document ID. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Unique identifier of the document. + /// The name of the document list associated with the document. /// /// {} /// @@ -48,17 +49,17 @@ public partial class DocumentClient { } /// - /// Performs transformations on a document. For example, resizing an image. + /// /// - /// Crops the image based on the specified coordinates. The reference point for positive coordinates is the top-left corner of the image, and the reference point for negative coordinates is the bottom-right corner of the image.Usage: Example: removes 10 pixels from all edges of the image. leaves the image uncropped. - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Specifies an exact height dimension for the image, in pixels. - /// Specifies a pixel limitation for the largest side of an image. - /// Specifies a pixel limitation for the height of the image, preserving the aspect ratio if the image needs resizing. - /// Specifies a pixel limitation for the width of the image, preserving the aspect ratio if the image needs resizing. - /// Adjusts the image compression. Accepts values from 0-100, where 100 = highest quality, least compression. - /// Specifies an exact width dimension for the image, in pixels. + /// + /// + /// + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -80,12 +81,12 @@ public partial class DocumentClient { } /// - /// Retrieves a document within the specified document list. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Include inactive content. - /// Use this field to include those fields which are not included by default. + /// Identifier of the document being retrieved. + /// The name of the document list associated with the document to retrieve. + /// + /// /// /// {} /// @@ -108,15 +109,15 @@ public partial class DocumentClient { } /// - /// Retrieves a collection of documents according to any filter and sort criteria. + /// /// - /// Name of content documentListName to delete - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Include inactive content. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// The name of the document list. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter a document's search results by any of its properties, including its name or folder path. 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=Name+sw+Events" + /// + /// + /// + /// + /// /// /// {} /// @@ -139,11 +140,11 @@ public partial class DocumentClient { } /// - /// Creates a new document in an defined document list. + /// /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// The document properties that define the content used by the content management system (CMS). + /// The descriptive alphanumeric document list name being created. + /// + /// The descriptive name of the newly created document. /// /// {} /// @@ -166,11 +167,11 @@ public partial class DocumentClient { } /// - /// Updates the binary data or content associated with a document, such as a product image or PDF specifications file, by supplying the document ID. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Data stream that delivers information. Used to input and output data. + /// Unique identifier of the document. + /// The name of the document list associated with the document. + /// Input output stream that delivers information. /// /// /// @@ -193,12 +194,12 @@ public static MozuClient UpdateDocumentContentClient(System.IO.Stream stream, st } /// - /// Updates a document in a document list. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// The document properties that define the content used by the content management system (CMS). + /// Unique identifier of the document to update. + /// Name of the document list associated with the document. + /// + /// Properties of the document to update. /// /// {} /// @@ -220,10 +221,10 @@ public static MozuClient UpdateDocumentContentClient(System.IO.Stream stream, st } /// - /// Deletes a specific document based on the specified document ID. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Identifier of the document being deleted. + /// The name of the document list associated with the document list being deleted. /// /// /// @@ -245,10 +246,10 @@ public static MozuClient DeleteDocumentClient(string documentListName, string do } /// - /// Deletes the content associated with a document, such as a product image or PDF specification, by supplying the document ID. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Unique identifier of the document. + /// The name of the document list associated with the document. /// /// /// diff --git a/Mozu.Api/Clients/Content/Documentlists/DocumentTreeClient.cs b/Mozu.Api/Clients/Content/Documentlists/DocumentTreeClient.cs old mode 100644 new mode 100755 index fb8f36ff..a067e612 --- a/Mozu.Api/Clients/Content/Documentlists/DocumentTreeClient.cs +++ b/Mozu.Api/Clients/Content/Documentlists/DocumentTreeClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content.Documentlists { @@ -22,10 +23,10 @@ namespace Mozu.Api.Clients.Content.Documentlists public partial class DocumentTreeClient { /// - /// Retrieve the content associated with the document, such as a product image or PDF specifications file. + /// /// - /// Name of content documentListName to delete - /// The name of the document in the site. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. /// /// {} /// @@ -48,17 +49,17 @@ public partial class DocumentTreeClient { } /// - /// Performs transformations on a document. For example, resizing an image. + /// /// - /// Crops the image based on the specified coordinates. The reference point for positive coordinates is the top-left corner of the image, and the reference point for negative coordinates is the bottom-right corner of the image.Usage: Example: removes 10 pixels from all edges of the image. leaves the image uncropped. - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Specifies an exact height dimension for the image, in pixels. - /// Specifies a pixel limitation for the largest side of an image. - /// Specifies a pixel limitation for the height of the image, preserving the aspect ratio if the image needs resizing. - /// Specifies a pixel limitation for the width of the image, preserving the aspect ratio if the image needs resizing. - /// Adjusts the image compression. Accepts values from 0-100, where 100 = highest quality, least compression. - /// Specifies an exact width dimension for the image, in pixels. + /// + /// + /// + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -80,12 +81,12 @@ public partial class DocumentTreeClient { } /// - /// Retrieves a document based on its document list and folder path in the document hierarchy. + /// /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Include inactive content. - /// Use this field to include those fields which are not included by default. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. + /// + /// /// /// {} /// @@ -108,11 +109,11 @@ public partial class DocumentTreeClient { } /// - /// Updates the binary data or content associated with a document, such as a product image or PDF specifications file, by supplying the document name. + /// /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Data stream that delivers information. Used to input and output data. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. + /// Input output stream that delivers information. /// /// /// @@ -135,11 +136,11 @@ public static MozuClient UpdateTreeDocumentContentClient(System.IO.Stream stream } /// - /// Deletes the content associated with a document, such as a product image or PDF specifications file. + /// /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Data stream that delivers information. Used to input and output data. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. + /// Input output stream that delivers information. /// /// /// diff --git a/Mozu.Api/Clients/Content/Documentlists/FacetClient.cs b/Mozu.Api/Clients/Content/Documentlists/FacetClient.cs old mode 100644 new mode 100755 index bf991e7d..b1532020 --- a/Mozu.Api/Clients/Content/Documentlists/FacetClient.cs +++ b/Mozu.Api/Clients/Content/Documentlists/FacetClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content.Documentlists { @@ -22,9 +23,9 @@ namespace Mozu.Api.Clients.Content.Documentlists public partial class FacetClient { /// - /// Retrieves the properties of facets that aid in indexing and searching. + /// /// - /// Name of content documentListName to delete + /// The document list associated with the facets to retrieve. /// The property name associated with the facets to retrieve. /// /// {List{}} diff --git a/Mozu.Api/Clients/Content/Documentlists/ViewClient.cs b/Mozu.Api/Clients/Content/Documentlists/ViewClient.cs old mode 100644 new mode 100755 index a8205bc1..e2854743 --- a/Mozu.Api/Clients/Content/Documentlists/ViewClient.cs +++ b/Mozu.Api/Clients/Content/Documentlists/ViewClient.cs @@ -13,25 +13,26 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content.Documentlists { /// - /// Properties and content for views within a site/tenant. Views provide the schema, formatting, and associated content and entities for displaying content within a site/tenant. + /// /// public partial class ViewClient { /// - /// Retrieves a collection of documents associated with a view. + /// /// - /// Name of content documentListName to delete - /// 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" - /// Include inactive content. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// + /// + /// + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Content/PropertyTypeClient.cs b/Mozu.Api/Clients/Content/PropertyTypeClient.cs old mode 100644 new mode 100755 index fa5f1940..0477ec00 --- a/Mozu.Api/Clients/Content/PropertyTypeClient.cs +++ b/Mozu.Api/Clients/Content/PropertyTypeClient.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content { @@ -22,11 +23,11 @@ namespace Mozu.Api.Clients.Content public partial class PropertyTypeClient { /// - /// Retrieves a list of the content property types. + /// /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. + /// + /// + /// /// /// {} /// @@ -49,10 +50,10 @@ public partial class PropertyTypeClient { } /// - /// Retrieves the details of the content property type. + /// /// - /// The name of the property type. - /// Use this field to include those fields which are not included by default. + /// The name of the content property type. + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class PropertyTypeClient { } /// - /// Creates a new + /// /// - /// Use this field to include those fields which are not included by default. - /// Property type available for content. Property types are like templates that can be reused. + /// + /// /// /// {} /// @@ -100,11 +101,11 @@ public partial class PropertyTypeClient { } /// - /// Updates a + /// /// - /// The name of the property type. - /// Use this field to include those fields which are not included by default. - /// Property type available for content. Property types are like templates that can be reused. + /// + /// + /// /// /// {} /// @@ -127,9 +128,9 @@ public partial class PropertyTypeClient { } /// - /// Delete a specific + /// /// - /// The name of the property type. + /// /// /// /// diff --git a/Mozu.Api/Clients/Content/PublishSetSummaryClient.cs b/Mozu.Api/Clients/Content/PublishSetSummaryClient.cs old mode 100644 new mode 100755 index 06dfe0f7..b6170b13 --- a/Mozu.Api/Clients/Content/PublishSetSummaryClient.cs +++ b/Mozu.Api/Clients/Content/PublishSetSummaryClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Content { /// - /// Use the Content Publish Set resource to manage content publish sets and the pending content drafts.You can use content publish sets to group pending content changes together and publish them all at the same time. + /// /// public partial class PublishSetSummaryClient { /// - /// Returns a list of content publish sets. + /// /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// /// /// {} /// @@ -48,14 +49,14 @@ public partial class PublishSetSummaryClient { } /// - /// Retrieves a list of content publish sets and their properties. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -77,11 +78,11 @@ public partial class PublishSetSummaryClient { } /// - /// Deletes the specified content publish set. You can use the shouldDiscard parameter to specify whether to discard the content drafts assigned to the content publish set. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Specifies whether to discard the pending content changes assigned to the content publish set when the publish set is deleted. + /// + /// + /// /// /// {object} /// @@ -103,11 +104,11 @@ public static MozuClient DeletePublishSetClient(string code, bool? shoul } /// - /// Adds a set of documents by id to a specified publish set. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the items that you want to add to a specified publish set. + /// + /// + /// /// /// {object} /// diff --git a/Mozu.Api/Clients/Event/EventNotificationClient.cs b/Mozu.Api/Clients/Event/EventNotificationClient.cs old mode 100644 new mode 100755 index 04b34275..90f8379b --- a/Mozu.Api/Clients/Event/EventNotificationClient.cs +++ b/Mozu.Api/Clients/Event/EventNotificationClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Event { /// - /// Events are notifications publishes to the application when a create, read, update, or delete operation is performed. If the application subscribes to the event, you can use the Events resource to query for recent events published to your application or events that were not published successfully. + /// Events are notifications Mozu publishes to the application when a create, read, update, or delete operation is performed. If the application subscribes to the event, you can use the Events resource to query for recent events Mozu published to your application or events that were not published successfully. /// public partial class EventNotificationClient { /// - /// Retrieves a list of events. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -50,10 +51,10 @@ public partial class EventNotificationClient { } /// - /// Retrieves an event by providing the event ID. + /// /// /// The unique identifier of the event being retrieved. An event is a notification about a create, read, update, or delete on an order, product, discount or category. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Event/Push/SubscriptionClient.cs b/Mozu.Api/Clients/Event/Push/SubscriptionClient.cs old mode 100644 new mode 100755 index 8b4fcc19..b8bf4e30 --- a/Mozu.Api/Clients/Event/Push/SubscriptionClient.cs +++ b/Mozu.Api/Clients/Event/Push/SubscriptionClient.cs @@ -13,22 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Event.Push { /// - /// The Subscriptions resource triggers a push service to sent immediate notifications to the subscribed tenants and applications when triggers. The resource sends messages regarding a subscription event tha occurs in the tenant or site. + /// /// public partial class SubscriptionClient { /// - /// Retrieves a list of events according to any specified filter criteria and sort options. + /// /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Event/Push/Subscriptions/EventDeliverySummaryClient.cs b/Mozu.Api/Clients/Event/Push/Subscriptions/EventDeliverySummaryClient.cs old mode 100644 new mode 100755 index 0cd37643..0542f53e --- a/Mozu.Api/Clients/Event/Push/Subscriptions/EventDeliverySummaryClient.cs +++ b/Mozu.Api/Clients/Event/Push/Subscriptions/EventDeliverySummaryClient.cs @@ -13,32 +13,33 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Event.Push.Subscriptions { /// - /// Provides details for each attempted delivery of the event to the endpoint. + /// /// public partial class EventDeliverySummaryClient { /// - /// This operation method is the external/public event entity used specifically in pull/poll event scenarios. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// Unique identifier for a subscription, such as subscribing tenants for an event or to receive a notification. + /// + /// + /// This operation paramenter is the unique identifer for a subscription. /// /// {} /// /// /// - /// var mozuClient=GetDeliveryAttemptSummary( subscriptionId, id, responseFields); + /// var mozuClient=GetDeliveryAttemptSummary( subscriptionId, processId, responseFields); /// var eventDeliverySummaryClient = mozuClient.WithBaseAddress(url).Execute().Result(); /// /// - public static MozuClient GetDeliveryAttemptSummaryClient(string subscriptionId, int? id = null, string responseFields = null) + public static MozuClient GetDeliveryAttemptSummaryClient(string subscriptionId, int? processId = null, string responseFields = null) { - var url = Mozu.Api.Urls.Event.Push.Subscriptions.EventDeliverySummaryUrl.GetDeliveryAttemptSummaryUrl(subscriptionId, id, responseFields); + var url = Mozu.Api.Urls.Event.Push.Subscriptions.EventDeliverySummaryUrl.GetDeliveryAttemptSummaryUrl(subscriptionId, processId, responseFields); const string verb = "GET"; var mozuClient = new MozuClient() .WithVerb(verb).WithResourceUrl(url) @@ -48,14 +49,14 @@ public partial class EventDeliverySummaryClient { } /// - /// Retrieves a collection of data for delivery attempts of events and notifications. These are notifications sent to subscribing sites and tenants. A paged list is returned sorted and filtered per the entered parameters. + /// /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// Unique identifier for a subscription, such as subscribing tenants for an event or to receive a notification. + /// + /// + /// + /// + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Platform/Adminuser/AdminUserClient.cs b/Mozu.Api/Clients/Platform/Adminuser/AdminUserClient.cs old mode 100644 new mode 100755 index 56229156..b24318b7 --- a/Mozu.Api/Clients/Platform/Adminuser/AdminUserClient.cs +++ b/Mozu.Api/Clients/Platform/Adminuser/AdminUserClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform.Adminuser { /// - /// The Accounts resource displays the user accounts and account details associated with a developer or tenant administrator. Email addresses uniquely identify admin user accounts. + /// Displays the user accounts and account details associated with a developer or Mozu tenant administrator. Email addresses uniquely identify admin user accounts. /// public partial class AdminUserClient { /// - /// Retrieves a list of the tenants or development stores for which the specified user has an assigned role. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// Unique identifier of the user whose tenant scopes you want to retrieve. /// /// {} @@ -47,10 +48,10 @@ public partial class AdminUserClient { } /// - /// Retrieves the details of the specified administrator user account. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. + /// + /// Unique identifier of the administrator account to retrieve. /// /// {} /// diff --git a/Mozu.Api/Clients/Platform/Adminuser/TenantAdminUserAuthTicketClient.cs b/Mozu.Api/Clients/Platform/Adminuser/TenantAdminUserAuthTicketClient.cs old mode 100644 new mode 100755 index 17845459..40bec1d4 --- a/Mozu.Api/Clients/Platform/Adminuser/TenantAdminUserAuthTicketClient.cs +++ b/Mozu.Api/Clients/Platform/Adminuser/TenantAdminUserAuthTicketClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform.Adminuser { /// - /// Use the Admin User authentication tickets resource to generate and refresh authentication tickets that enable administrator or developer account users to access development or production tenants. + /// Use the Admin User authentication tickets resource to generate and refresh authentication tickets that enable Mozu administrator or developer account users to access development or production tenants. /// public partial class TenantAdminUserAuthTicketClient { /// - /// Creates an authentication ticket for the supplied user to specify in API requests associated with the supplied tenant. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// Unique identifier of the development or production tenant for which to generate the user authentication ticket. - /// Information required to authenticate a user. + /// The user authentication information required to generate the user authentication ticket, which consists of a user name and password. /// /// {} /// @@ -48,11 +49,11 @@ public partial class TenantAdminUserAuthTicketClient { } /// - /// Generates a new user authentication ticket for the specified tenant by supplying the user's existing refresh token information. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// - /// Properties of the authentication ticket to be used in user claims with the API. + /// Properties of the authentication ticket to refresh. The refresh token is required to complete this request. /// /// {} /// @@ -74,9 +75,9 @@ public partial class TenantAdminUserAuthTicketClient { } /// - /// Deletes the authentication ticket for the user by supplying the refresh token. + /// /// - /// 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. + /// Refresh token string associated with the user authentication ticket. /// /// /// diff --git a/Mozu.Api/Clients/Platform/Appdev/AppPackageClient.cs b/Mozu.Api/Clients/Platform/Appdev/AppPackageClient.cs new file mode 100755 index 00000000..63c6324a --- /dev/null +++ b/Mozu.Api/Clients/Platform/Appdev/AppPackageClient.cs @@ -0,0 +1,293 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Platform.Appdev +{ + /// + /// + /// + public partial class AppPackageClient { + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetAllPackages( startIndex, pageSize, sortBy, filter, responseFields); + /// var packageSummaryCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetAllPackagesClient(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.GetAllPackagesUrl(startIndex, pageSize, sortBy, filter, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetPackage( applicationKey, includeChildren, skipDevAccountCheck, responseFields); + /// var packageClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetPackageClient(string applicationKey, bool? includeChildren = null, bool? skipDevAccountCheck = null, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.GetPackageUrl(applicationKey, includeChildren, skipDevAccountCheck, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetPackages( applicationKey, startIndex, pageSize, sortBy, filter, responseFields); + /// var packageCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetPackagesClient(string applicationKey, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.GetPackagesUrl(applicationKey, startIndex, pageSize, sortBy, filter, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// {List{}} + /// + /// + /// + /// var mozuClient=GetApplicationSummaryChildren( appId); + /// var applicationSummaryClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient> GetApplicationSummaryChildrenClient(string appId) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.GetApplicationSummaryChildrenUrl(appId); + const string verb = "GET"; + var mozuClient = new MozuClient>() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetApplicationSummaryParents( startIndex, pageSize, sortBy, filter, responseFields); + /// var applicationSummaryCollectionClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetApplicationSummaryParentsClient(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.GetApplicationSummaryParentsUrl(startIndex, pageSize, sortBy, filter, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=ClonePackage( applicationKey, packageName, responseFields); + /// var packageClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient ClonePackageClient(string applicationKey, string packageName, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.ClonePackageUrl(applicationKey, packageName, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=CreateNewCorePackage( packageRequest, responseFields); + /// var packageClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient CreateNewCorePackageClient(Mozu.Api.Contracts.AppDev.PackageRequest packageRequest, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.CreateNewCorePackageUrl(responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(packageRequest); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=CreatePackage( pkg, projectId, responseFields); + /// var packageClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient CreatePackageClient(Mozu.Api.Contracts.AppDev.Package pkg, int? projectId = null, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.CreatePackageUrl(projectId, responseFields); + const string verb = "POST"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(pkg); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=UpdatePackage( pkg, applicationKey, responseFields); + /// var packageClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient UpdatePackageClient(Mozu.Api.Contracts.AppDev.Package pkg, string applicationKey, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.UpdatePackageUrl(applicationKey, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(pkg); + return mozuClient; + + } + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var mozuClient=DeletePackage( applicationKey); + ///mozuClient.WithBaseAddress(url).Execute(); + /// + /// + public static MozuClient DeletePackageClient(string applicationKey) + { + var url = Mozu.Api.Urls.Platform.Appdev.AppPackageUrl.DeletePackageUrl(applicationKey); + const string verb = "DELETE"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Platform/Appdev/PackageClient.cs b/Mozu.Api/Clients/Platform/Appdev/PackageClient.cs old mode 100644 new mode 100755 index 24e864b3..7d0a301c --- a/Mozu.Api/Clients/Platform/Appdev/PackageClient.cs +++ b/Mozu.Api/Clients/Platform/Appdev/PackageClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform.Appdev { /// - /// This resource is not public. + /// /// public partial class PackageClient { /// - /// This operation is not public. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. + /// /// /// /// {} diff --git a/Mozu.Api/Clients/Platform/ApplicationClient.cs b/Mozu.Api/Clients/Platform/ApplicationClient.cs old mode 100644 new mode 100755 index c2e85862..4a094ab3 --- a/Mozu.Api/Clients/Platform/ApplicationClient.cs +++ b/Mozu.Api/Clients/Platform/ApplicationClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform { /// - /// Use the Developer resource to view and update information and files related to application packages. + /// /// public partial class ApplicationClient { /// - /// Returns a collection of package names for the application specified in the request. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -47,10 +48,10 @@ public partial class ApplicationClient { } /// - /// Retrieves the available versions for the application specified in the request. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -72,11 +73,11 @@ public partial class ApplicationClient { } /// - /// Retrieves the metadata for a file in an application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Represents the file name and location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// {} /// @@ -98,10 +99,10 @@ public partial class ApplicationClient { } /// - /// Retrieves the metadata for a folder in an application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {} /// @@ -123,13 +124,13 @@ public partial class ApplicationClient { } /// - /// Insert or update the specified file into the specified application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// The date and time of the last file insert or update. This parameter is optional. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Data stream that delivers information. Used to input and output data. + /// + /// + /// + /// + /// /// /// {} /// @@ -152,11 +153,11 @@ public partial class ApplicationClient { } /// - /// Renames a file in an application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Information required to update the name of a file in a package, which consists of the original name and the new name. + /// + /// + /// /// /// {} /// @@ -178,10 +179,10 @@ public partial class ApplicationClient { } /// - /// Deletes the specified file from the specified application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Represents the file name and location. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Platform/Applications/AuthTicketClient.cs b/Mozu.Api/Clients/Platform/Applications/AuthTicketClient.cs old mode 100644 new mode 100755 index 15e95926..6cd1d71a --- a/Mozu.Api/Clients/Platform/Applications/AuthTicketClient.cs +++ b/Mozu.Api/Clients/Platform/Applications/AuthTicketClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform.Applications { /// - /// Use the Authetickets for applications resource to manage authentication tickets for your apps. + /// Use this resource to manage authentication tickets for your applications. /// public partial class AuthTicketClient { /// - /// Generate an authentication ticket for an application. + /// /// - /// Use this field to include those fields which are not included by default. - /// The information required to authenticate third party applications against the API. + /// + /// Authentication information required to generate an authentication ticket includes the application id and the shared secret. /// /// {} /// @@ -47,10 +48,10 @@ public partial class AuthTicketClient { } /// - /// Refreshes the application's authentication ticket and generates a new access token by providing the refresh token string. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the authentication ticket refresh requests, which includes the refresh token string. + /// + /// The refresh token string required to update the application authentication ticket. /// /// {} /// @@ -72,9 +73,9 @@ public partial class AuthTicketClient { } /// - /// Deletes an authentication for an application based on the specified refresh token. + /// /// - /// 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. + /// The refresh token string from the application's authentication ticket. /// /// /// diff --git a/Mozu.Api/Clients/Platform/Developer/DeveloperAdminUserAuthTicketClient.cs b/Mozu.Api/Clients/Platform/Developer/DeveloperAdminUserAuthTicketClient.cs old mode 100644 new mode 100755 index f1e16574..1c9aea5d --- a/Mozu.Api/Clients/Platform/Developer/DeveloperAdminUserAuthTicketClient.cs +++ b/Mozu.Api/Clients/Platform/Developer/DeveloperAdminUserAuthTicketClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform.Developer { /// - /// Use the Authtickets resource to manage authentication tickets for your developer account. + /// Use this resource to manage authentication tickets for your developer account. /// public partial class DeveloperAdminUserAuthTicketClient { /// - /// Generate an authentication ticket for a developer account. + /// /// /// Unique identifier of the developer account. - /// Use this field to include those fields which are not included by default. - /// Information required to authenticate a user. + /// + /// The user authentication information required to generate the developer account user authentication ticket, which consists of a user name and password. /// /// {} /// @@ -48,11 +49,11 @@ public partial class DeveloperAdminUserAuthTicketClient { } /// - /// Generates a new developer account authentication ticket for the specified tenant by supplying the defined refresh token information. + /// /// /// Unique identifier of the developer account. - /// Use this field to include those fields which are not included by default. - /// Properties of the authentication ticket to be used in developer account claims with the API. + /// + /// Properties of the authentication ticket to refresh. The refresh token is required to complete this request. /// /// {} /// @@ -74,9 +75,9 @@ public partial class DeveloperAdminUserAuthTicketClient { } /// - /// Deletes the authentication ticket for the developer account by supplying the refresh token. + /// /// - /// 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. + /// Refresh token string associated with the developer account authentication ticket. /// /// /// diff --git a/Mozu.Api/Clients/Platform/EntityListClient.cs b/Mozu.Api/Clients/Platform/EntityListClient.cs old mode 100644 new mode 100755 index 622e83de..1c7c9e64 --- a/Mozu.Api/Clients/Platform/EntityListClient.cs +++ b/Mozu.Api/Clients/Platform/EntityListClient.cs @@ -13,22 +13,23 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform { /// - /// The Entity Lists resource manages all dynamic entities in your document store of the cloud. The content is JSON and can have up to five indexed properties (integer, decimal, string, date, and boolean) with support for additional customized elements as needed. Every document in the entity list has a validated unique ID. + /// /// public partial class EntityListClient { /// - /// Get a filtered list of EntityLists for a specific tenant. + /// /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// {} /// @@ -50,10 +51,10 @@ public partial class EntityListClient { } /// - /// Get an existing EntityList definition for a specific tenant + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. + /// + /// /// /// {} /// @@ -75,10 +76,10 @@ public partial class EntityListClient { } /// - /// Create a new EntityList for a specific tenant. + /// /// - /// Use this field to include those fields which are not included by default. - /// The definition of an MZDB EntityList which describes the characteristics of the EntityList on a per tenant basis. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList. + /// + /// /// /// {} /// @@ -100,11 +101,11 @@ public partial class EntityListClient { } /// - /// Update an existing Entitylist for a specific tenant. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The definition of an MZDB EntityList which describes the characteristics of the EntityList on a per tenant basis. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList. + /// + /// + /// /// /// {} /// @@ -126,9 +127,9 @@ public partial class EntityListClient { } /// - /// Delete an existing EntityList for a specific tenant. This will also delete all Entities in all instances of this EntityList for the tenant. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format + /// /// /// /// diff --git a/Mozu.Api/Clients/Platform/Entitylists/EntityClient.cs b/Mozu.Api/Clients/Platform/Entitylists/EntityClient.cs old mode 100644 new mode 100755 index aa439ff5..ef33cd1a --- a/Mozu.Api/Clients/Platform/Entitylists/EntityClient.cs +++ b/Mozu.Api/Clients/Platform/Entitylists/EntityClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform.Entitylists { /// - /// Entities are JSON entries within the MZDB ( Mongo DB) for handling large data sets to heavily filter (>2,000 items). Each entity is associated to an EntityList with schema, rules, and formatting for storing the content. This content can be accessed via the API and Hypr tags. + /// /// public partial class EntityClient { /// - /// Retrieves an entity with an associated entity list and context level at tenant, master catalog, catalog, or site. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// {JObject} /// @@ -48,14 +49,14 @@ public static MozuClient GetEntityClient(string entityListFullName, str } /// - /// Retrieves a collection of entities with an associated entity list and context level at tenant, master catalog, catalog, or site. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -77,11 +78,11 @@ public static MozuClient GetEntityClient(string entityListFullName, str } /// - /// Inserts a new entity per the entered item, the entity list full name, and associated response fields. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// JSON code for objects. + /// + /// + /// /// /// {JObject} /// @@ -103,12 +104,12 @@ public static MozuClient InsertEntityClient(JObject item, string entity } /// - /// Updates the content and associations for an existing entity. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// JSON code for objects. + /// + /// + /// + /// /// /// {JObject} /// @@ -130,10 +131,10 @@ public static MozuClient UpdateEntityClient(JObject item, string entity } /// - /// Deletes an entity depending on the context of tenant, master catalog, catalog, or site level. Entities are associated to an entity list (schema and formatting) for displaying within a namespace and context level. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Platform/Entitylists/EntityContainerClient.cs b/Mozu.Api/Clients/Platform/Entitylists/EntityContainerClient.cs old mode 100644 new mode 100755 index f94d9206..10e81748 --- a/Mozu.Api/Clients/Platform/Entitylists/EntityContainerClient.cs +++ b/Mozu.Api/Clients/Platform/Entitylists/EntityContainerClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform.Entitylists { /// - /// Entity containers provide all properties and data for entities within a site/tenant. This data encapsulates all associated IDs including entity lists, entity views, site, tenant, entities, and more. + /// /// public partial class EntityContainerClient { /// - /// Retrieves an entity container, providing all schema and rules and associated IDs for entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// {} /// @@ -48,14 +49,14 @@ public partial class EntityContainerClient { } /// - /// Retrieves a collection of entity containers. Each container holds a set of entities per ID. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Platform/Entitylists/ListViewClient.cs b/Mozu.Api/Clients/Platform/Entitylists/ListViewClient.cs old mode 100644 new mode 100755 index 181d46f6..5279fde2 --- a/Mozu.Api/Clients/Platform/Entitylists/ListViewClient.cs +++ b/Mozu.Api/Clients/Platform/Entitylists/ListViewClient.cs @@ -13,21 +13,22 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform.Entitylists { /// - /// Provides settings and options for displaying associated content within a context level of site, tenant, catalog, or master catalog. ListViews can be associated with entity lists and entities. + /// /// public partial class ListViewClient { /// - /// Retrieves a view for associated entities. A view provides display context levels (site, tenant, catalog, master catalog) and settings. + /// /// - /// Unique identifier for an entity, which defines the schema, rules, and formats for JSON entities within the MZDB ( Mongo DB). - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// /// /// {JObject} /// @@ -49,14 +50,14 @@ public static MozuClient GetViewEntityClient(string entityListFullName, } /// - /// Retrieves a collection of views for associated entities. Each view provides display context levels (site, tenant, catalog, master catalog) and settings. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -78,12 +79,12 @@ public static MozuClient GetViewEntityClient(string entityListFullName, } /// - /// Retrieves a collection of container data for creating and displaying a view of entities. + /// /// - /// Unique identifier for an entity, which defines the schema, rules, and formats for JSON entities within the MZDB ( Mongo DB). - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// /// /// {} /// @@ -105,14 +106,14 @@ public static MozuClient GetViewEntityClient(string entityListFullName, } /// - /// Retrieves a collection of container data for creating and displaying a view of entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// + /// + /// /// /// {} /// @@ -134,11 +135,11 @@ public static MozuClient GetViewEntityClient(string entityListFullName, } /// - /// Retrieves a specific `EntityListView`. These views provide schema, rules, and formatting for all associated entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// /// /// {} /// @@ -160,10 +161,10 @@ public static MozuClient GetViewEntityClient(string entityListFullName, } /// - /// Retrieves a collection of `EntityListViews`. These views provide schema, rules, and formatting for all associated entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. + /// + /// /// /// {} /// @@ -185,11 +186,11 @@ public static MozuClient GetViewEntityClient(string entityListFullName, } /// - /// Creates an entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// Properties for the list view that specifies what fields and content display per page load. All associated fields in the list view correspond with object data. + /// + /// + /// /// /// {} /// @@ -211,12 +212,12 @@ public static MozuClient GetViewEntityClient(string entityListFullName, } /// - /// Updates an existing entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// Properties for the list view that specifies what fields and content display per page load. All associated fields in the list view correspond with object data. + /// + /// + /// + /// /// /// {} /// @@ -238,10 +239,10 @@ public static MozuClient GetViewEntityClient(string entityListFullName, } /// - /// Deletes an entity list view. Any associated entities have the association removed. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// /// /// /// diff --git a/Mozu.Api/Clients/Platform/Extensions/CredentialStoreEntryClient.cs b/Mozu.Api/Clients/Platform/Extensions/CredentialStoreEntryClient.cs old mode 100644 new mode 100755 index 7eb47a22..93cf2293 --- a/Mozu.Api/Clients/Platform/Extensions/CredentialStoreEntryClient.cs +++ b/Mozu.Api/Clients/Platform/Extensions/CredentialStoreEntryClient.cs @@ -13,16 +13,17 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform.Extensions { /// - /// The CredentialStore resource allows you to encrypt and store sensitive data on your tenant. You can then decrypt and access that data using an Arc.js application, as described in the Arc.js [Programming Patterns](https://www.mozu.com/docs/developer/arcjs-guides/programming-patterns.htm#securely_store_and_access_sensitive_data) topic. + /// /// public partial class CredentialStoreEntryClient { /// - /// Encrypts and stores data contained in the JSON object. You can decrypt and access the secured data using an Arc.js application, as described in the Arc.js [Programming Patterns](https://www.mozu.com/docs/developer/arcjs-guides/programming-patterns.htm#securely_store_and_access_sensitive_data) topic. + /// /// /// /// diff --git a/Mozu.Api/Clients/Platform/InstalledApplicationsClient.cs b/Mozu.Api/Clients/Platform/InstalledApplicationsClient.cs new file mode 100755 index 00000000..855d8d93 --- /dev/null +++ b/Mozu.Api/Clients/Platform/InstalledApplicationsClient.cs @@ -0,0 +1,81 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Clients.Platform +{ + /// + /// Use the Applications resource to update and retrieve details about the applications installed for your tenant. + /// + public partial class InstalledApplicationsClient { + + /// + /// + /// + /// The application ID that represents the application to retrieve. + /// + /// + /// {} + /// + /// + /// + /// var mozuClient=GetApplication( appId, responseFields); + /// var applicationClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient GetApplicationClient(string appId, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.InstalledApplicationsUrl.GetApplicationUrl(appId, responseFields); + const string verb = "GET"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) +; + return mozuClient; + + } + + /// + /// + /// + /// The application ID that represents the application to update. + /// + /// Properties of the application to update. + /// + /// {} + /// + /// + /// + /// var mozuClient=UpdateApplication( application, appId, responseFields); + /// var applicationClient = mozuClient.WithBaseAddress(url).Execute().Result(); + /// + /// + public static MozuClient UpdateApplicationClient(Mozu.Api.Contracts.InstalledApplications.Application application, string appId, string responseFields = null) + { + var url = Mozu.Api.Urls.Platform.InstalledApplicationsUrl.UpdateApplicationUrl(appId, responseFields); + const string verb = "PUT"; + var mozuClient = new MozuClient() + .WithVerb(verb).WithResourceUrl(url) + .WithBody(application); + return mozuClient; + + } + + + } + +} + + diff --git a/Mozu.Api/Clients/Platform/ReferenceDataClient.cs b/Mozu.Api/Clients/Platform/ReferenceDataClient.cs old mode 100644 new mode 100755 index 4dd50be5..41f5061d --- a/Mozu.Api/Clients/Platform/ReferenceDataClient.cs +++ b/Mozu.Api/Clients/Platform/ReferenceDataClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform { /// - /// The Reference resource retrieves collections of standards the system currently supports. This includes content locales, top-level domains, units of measure, countries, currencies, time zones, and shipping or billing address schemas. + /// The Reference resource retrieves collections of standards the Mozu system currently supports. This includes content locales, top-level domains, units of measure, countries, currencies, time zones, and shipping or billing address schemas. /// public partial class ReferenceDataClient { /// - /// Retrieves a specific address schema based on the country code provided. This operation allows the creation of custom shipping and billing address fields. + /// /// - /// The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// Use this field to include those fields which are not included by default. + /// The 2-letter country code used to retrieve a specified address schema. + /// /// /// {} /// @@ -47,9 +48,9 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the entire list of address schemas that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -71,10 +72,10 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the details of a behavior based on the behavior ID specified in the request. + /// /// /// Unique identifier of the behavior. - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -96,10 +97,10 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the details of the behavior category specified in the request. + /// /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the behavior category. + /// /// /// {} /// @@ -121,9 +122,9 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the list of behavior categories. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -145,9 +146,9 @@ public partial class ReferenceDataClient { } /// - /// Retrieves a list of application behaviors. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// The user type associated with the behaviors to retrieve. /// /// {} @@ -170,9 +171,9 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the list of content locales the system supports. Content locales indicate the language used and the country where the language is used. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -194,9 +195,9 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the entire list of countries that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -218,9 +219,9 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the entire list of countries that the system supports. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// @@ -242,9 +243,9 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the entire list of currencies that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -266,9 +267,9 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the entire list of time zones that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -290,9 +291,9 @@ public partial class ReferenceDataClient { } /// - /// Retrieves the entire list of top-level internet domains that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// {} /// @@ -314,10 +315,10 @@ public partial class ReferenceDataClient { } /// - /// Retrieves an array list of all units of measure the system supports. + /// /// - /// 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" - /// Use this field to include those fields which are not included by default. + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Platform/SecureAppDataClient.cs b/Mozu.Api/Clients/Platform/SecureAppDataClient.cs old mode 100644 new mode 100755 index 01dd55c9..1d80bf1a --- a/Mozu.Api/Clients/Platform/SecureAppDataClient.cs +++ b/Mozu.Api/Clients/Platform/SecureAppDataClient.cs @@ -13,20 +13,21 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform { /// - /// Manage Secure App Settings. Expose via arc.js so that arc apps can securely access secrets. Third-party extensions can also access their data. Secured via AppKey.AppId + /// /// public partial class SecureAppDataClient { /// - /// platform-secureappdata Get GetDBValue description DOCUMENT_HERE + /// /// /// - /// The database entry string to create. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// {JObject} /// @@ -48,11 +49,11 @@ public static MozuClient GetDBValueClient(string appKeyId, string dbEnt } /// - /// platform-secureappdata Post CreateDBValue description DOCUMENT_HERE + /// /// /// - /// The database entry string to create. - /// The value string to create. + /// + /// /// /// /// @@ -74,11 +75,11 @@ public static MozuClient CreateDBValueClient(JObject value, string appKeyId, str } /// - /// platform-secureappdata Put UpdateDBValue description DOCUMENT_HERE + /// /// /// - /// The database entry string to create. - /// The value string to create. + /// + /// /// /// /// @@ -100,10 +101,10 @@ public static MozuClient UpdateDBValueClient(JObject value, string appKeyId, str } /// - /// platform-secureappdata Delete DeleteDBValue description DOCUMENT_HERE + /// /// /// - /// The database entry string to create. + /// /// /// /// diff --git a/Mozu.Api/Clients/Platform/SiteDataClient.cs b/Mozu.Api/Clients/Platform/SiteDataClient.cs old mode 100644 new mode 100755 index 090618e1..5c702c85 --- a/Mozu.Api/Clients/Platform/SiteDataClient.cs +++ b/Mozu.Api/Clients/Platform/SiteDataClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform { /// - /// Use the site data resource to store site-level information required for a third-party application in the database. + /// Use the site data resource to store site-level information required for a third-party application in the Mozu database. /// public partial class SiteDataClient { /// - /// Retrieves the value of a record in the database. + /// /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. + /// The database entry query string used to retrieve the record information. + /// /// /// {string} /// @@ -47,7 +48,7 @@ public static MozuClient GetDBValueClient(string dbEntryQuery, string re } /// - /// Creates a new record in the database based on the information supplied in the request. + /// /// /// The database entry string to create. /// The value string to create. @@ -72,10 +73,10 @@ public static MozuClient CreateDBValueClient(string value, string dbEntryQuery) } /// - /// Updates a record in the database based on the information supplied in the request. + /// /// - /// The database entry string to create. - /// The value string to create. + /// The database entry query string used to update the record information. + /// The database value to update. /// /// /// @@ -97,9 +98,9 @@ public static MozuClient UpdateDBValueClient(string value, string dbEntryQuery) } /// - /// Removes a previously defined record in the database. + /// /// - /// The database entry string to create. + /// The database entry string to delete. /// /// /// diff --git a/Mozu.Api/Clients/Platform/TenantClient.cs b/Mozu.Api/Clients/Platform/TenantClient.cs old mode 100644 new mode 100755 index 625a1545..bd4dd60a --- a/Mozu.Api/Clients/Platform/TenantClient.cs +++ b/Mozu.Api/Clients/Platform/TenantClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform { /// - /// Use the tenants resource to manage information about a tenant. + /// Use the tenants resource to manage information about a Mozu tenant. /// public partial class TenantClient { /// - /// Retrieve details about a specific tenant by providing the tenant ID. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the Mozu tenant. + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Platform/TenantDataClient.cs b/Mozu.Api/Clients/Platform/TenantDataClient.cs old mode 100644 new mode 100755 index f008877c..4aa0123e --- a/Mozu.Api/Clients/Platform/TenantDataClient.cs +++ b/Mozu.Api/Clients/Platform/TenantDataClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform { /// - /// Use the tenant data resource to store tenant-level information required for a third-party application in the database. + /// Use the tenant data resource to store tenant-level information required for a third-party application in the Mozu database. /// public partial class TenantDataClient { /// - /// Retrieves the value of a record in the database. + /// /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. + /// The database entry query string used to retrieve the record information. + /// /// /// {string} /// @@ -47,7 +48,7 @@ public static MozuClient GetDBValueClient(string dbEntryQuery, string re } /// - /// Creates a new record in the database based on the information supplied in the request. + /// /// /// The database entry string to create. /// The value string to create. @@ -72,10 +73,10 @@ public static MozuClient CreateDBValueClient(string value, string dbEntryQuery) } /// - /// Updates a record in the database based on the information supplied in the request. + /// /// - /// The database entry string to create. - /// The value string to create. + /// The database entry query string used to update the record information. + /// The database value to update. /// /// /// @@ -97,9 +98,9 @@ public static MozuClient UpdateDBValueClient(string value, string dbEntryQuery) } /// - /// Removes a previously defined record in the database. + /// /// - /// The database entry string to create. + /// The database entry string to delete. /// /// /// diff --git a/Mozu.Api/Clients/Platform/TenantExtensionsClient.cs b/Mozu.Api/Clients/Platform/TenantExtensionsClient.cs old mode 100644 new mode 100755 index 987b46f2..3650765f --- a/Mozu.Api/Clients/Platform/TenantExtensionsClient.cs +++ b/Mozu.Api/Clients/Platform/TenantExtensionsClient.cs @@ -13,18 +13,19 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform { /// - /// Use the Extensions resource to manage Arc.js configuration settings. These are the same settings you can configure through in the Action Management JSON Editor. + /// /// public partial class TenantExtensionsClient { /// - /// Retrieves the Arc.js configuration settings for a site. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// {} /// @@ -46,10 +47,10 @@ public partial class TenantExtensionsClient { } /// - /// Updates the Arc.js configuration settings for a site. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The updated details of the Arc.js configuration settings. + /// + /// /// /// {} /// diff --git a/Mozu.Api/Clients/Platform/UserDataClient.cs b/Mozu.Api/Clients/Platform/UserDataClient.cs old mode 100644 new mode 100755 index cd5fa07e..d36105a4 --- a/Mozu.Api/Clients/Platform/UserDataClient.cs +++ b/Mozu.Api/Clients/Platform/UserDataClient.cs @@ -13,19 +13,20 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Clients.Platform { /// - /// Use the user data subresource to store user-level data required for a third-party application in the database. + /// Use the user data subresource to store user-level data required for a third-party application in the Mozu database. /// public partial class UserDataClient { /// - /// Retrieves the value of a record in the database. + /// /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. + /// The database entry query string used to retrieve the record information. + /// /// /// {string} /// @@ -47,7 +48,7 @@ public static MozuClient GetDBValueClient(string dbEntryQuery, string re } /// - /// Creates a new record in the database based on the information supplied in the request. + /// /// /// The database entry string to create. /// The value string to create. @@ -72,10 +73,10 @@ public static MozuClient CreateDBValueClient(string value, string dbEntryQuery) } /// - /// Updates a record in the database based on the information supplied in the request. + /// /// - /// The database entry string to create. - /// The value string to create. + /// The database entry query string used to update the record information. + /// The database value to update. /// /// /// @@ -97,9 +98,9 @@ public static MozuClient UpdateDBValueClient(string value, string dbEntryQuery) } /// - /// Removes a previously defined record in the database. + /// /// - /// The database entry string to create. + /// The database entry string to delete. /// /// /// diff --git a/Mozu.Api/Contracts/AdminUser/DeveloperAccount.cs b/Mozu.Api/Contracts/AdminUser/DeveloperAccount.cs old mode 100644 new mode 100755 index 7c07d036..5dcebb3c --- a/Mozu.Api/Contracts/AdminUser/DeveloperAccount.cs +++ b/Mozu.Api/Contracts/AdminUser/DeveloperAccount.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.AdminUser /// public class DeveloperAccount { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/AdminUser/DeveloperAdminUserAuthTicket.cs b/Mozu.Api/Contracts/AdminUser/DeveloperAdminUserAuthTicket.cs old mode 100644 new mode 100755 index 21e19d77..6f571981 --- a/Mozu.Api/Contracts/AdminUser/DeveloperAdminUserAuthTicket.cs +++ b/Mozu.Api/Contracts/AdminUser/DeveloperAdminUserAuthTicket.cs @@ -16,53 +16,26 @@ namespace Mozu.Api.Contracts.AdminUser { /// - /// Properties of the authentication ticket to be used in developer account claims with the API. + /// Properties of the authentication ticket to be used in developer account claims with the Mozu API. /// public class DeveloperAdminUserAuthTicket { - /// - ///Alphanumeric string used to authenticate the user in API request headers. The token stores an encrypted list of the application's configured behaviors and authenticates the application. - /// public string AccessToken { get; set; } - /// - ///The date and time the user access token expires. If the token will expire, a new token will need to be generated and assigned to the account to continue and restore access to the store, data, and account. - /// public DateTime AccessTokenExpiration { get; set; } - /// - ///Properties of the developer account for which the user authentication ticket grants access. - /// public DeveloperAccount Account { get; set; } - /// - ///Collection of developer accounts for which the user authentication ticket grants access. - /// public List AvailableAccounts { get; set; } - /// - ///Date and time when the entity was created, represented in UTC Date/Time. - /// public DateTime CreatedOn { get; set; } - /// - ///Collection of behaviors encrypted in the developer account authentication ticket. Behaviors are granted to users as part of the role assigned for the given developer account. - /// public List GrantedBehaviors { get; set; } - /// - ///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 string RefreshToken { get; set; } - /// - ///The date and time the developer account or application refresh token expires. - /// public DateTime RefreshTokenExpiration { get; set; } - /// - ///Properties of the user. Users include customers and users. - /// public UserProfile User { get; set; } } diff --git a/Mozu.Api/Contracts/AdminUser/TenantAdminUserAuthTicket.cs b/Mozu.Api/Contracts/AdminUser/TenantAdminUserAuthTicket.cs old mode 100644 new mode 100755 index 53a332c9..8bc09997 --- a/Mozu.Api/Contracts/AdminUser/TenantAdminUserAuthTicket.cs +++ b/Mozu.Api/Contracts/AdminUser/TenantAdminUserAuthTicket.cs @@ -17,53 +17,26 @@ namespace Mozu.Api.Contracts.AdminUser { /// - /// Properties of the authentication ticket to be used in user claims with the API. + /// Properties of the authentication ticket to be used in user claims with the Mozu API. /// public class TenantAdminUserAuthTicket { - /// - ///Alphanumeric string used to authenticate the user in API request headers. The token stores an encrypted list of the application's configured behaviors and authenticates the application. - /// public string AccessToken { get; set; } - /// - ///The date and time the user access token expires. If the token will expire, a new token will need to be generated and assigned to the account to continue and restore access to the store, data, and account. - /// public DateTime AccessTokenExpiration { get; set; } - /// - ///Collection of tenants for which the user authentication ticket grants access. - /// public List AvailableTenants { get; set; } - /// - ///Date and time when the entity was created, represented in UTC Date/Time. - /// public DateTime CreatedOn { get; set; } - /// - ///Collection of behaviors encrypted in the developer account authentication ticket. Behaviors are granted to users as part of the role assigned for the given developer account. - /// public List GrantedBehaviors { get; set; } - /// - ///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 string RefreshToken { get; set; } - /// - ///The date and time the developer account or application refresh token expires. - /// public DateTime RefreshTokenExpiration { get; set; } - /// - ///Tenant information associated with the user authentication ticket or domain lookup service result. - /// public Tenant.Tenant Tenant { get; set; } - /// - ///Properties of the user. Users include customers and users. - /// public UserProfile User { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/AppAuthInfo.cs b/Mozu.Api/Contracts/AppDev/AppAuthInfo.cs old mode 100644 new mode 100755 index 8a148843..9068f1fe --- a/Mozu.Api/Contracts/AppDev/AppAuthInfo.cs +++ b/Mozu.Api/Contracts/AppDev/AppAuthInfo.cs @@ -14,18 +14,12 @@ namespace Mozu.Api.Contracts.AppDev { /// - /// The information required to authenticate third party applications against the API. + /// The information required to authenticate third party applications against the Mozu API. /// public class AppAuthInfo { - /// - ///Unique identifier of the application. System-supplied and read-only. - /// public string ApplicationId { get; set; } - /// - ///System-supplied alphanumeric code used to authenticate applications. This string is only available for viewing in Dev Center. - /// public string SharedSecret { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/AppVersion.cs b/Mozu.Api/Contracts/AppDev/AppVersion.cs old mode 100644 new mode 100755 index b676f46c..5c552cec --- a/Mozu.Api/Contracts/AppDev/AppVersion.cs +++ b/Mozu.Api/Contracts/AppDev/AppVersion.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Mozu.AppDev.Contracts.AppVersion ApiType DOCUMENT_HERE - /// public class AppVersion { - /// - ///Mozu.AppDev.Contracts.AppVersion majorVersion ApiTypeMember DOCUMENT_HERE - /// public int MajorVersion { get; set; } - /// - ///Mozu.AppDev.Contracts.AppVersion minorVersion ApiTypeMember DOCUMENT_HERE - /// public int MinorVersion { get; set; } - /// - ///Mozu.AppDev.Contracts.AppVersion revision ApiTypeMember DOCUMENT_HERE - /// public int Revision { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationAttribute.cs b/Mozu.Api/Contracts/AppDev/ApplicationAttribute.cs old mode 100644 new mode 100755 index 406a6788..061c7010 --- a/Mozu.Api/Contracts/AppDev/ApplicationAttribute.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationAttribute.cs @@ -14,54 +14,24 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationAttribute { - /// - ///Comma delimited list of attribute codes. - /// public string AttributeCodes { get; set; } - /// - ///json representation of attribute definitions - /// public string AttributeJson { get; set; } - /// - ///Collection of attributes that may be paged list or a list, depending on the usage per object and API type. - /// public List Attributes { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationAttribute isAppliedToBase ApiTypeMember DOCUMENT_HERE - /// public bool IsAppliedToBase { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationAttribute packageId ApiTypeMember DOCUMENT_HERE - /// public int PackageId { get; set; } - /// - ///Will contain ProductTypeCollection if Product, else AttributeSet - /// public string ProductTypeJson { get; set; } - /// - ///Source Tenant Id - /// public int SourceTenantId { get; set; } - /// - ///Source Tenant Name - /// public string SourceTenantName { get; set; } - /// - ///Customer, Order, or Product - /// public string Subsystem { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationBehavior.cs b/Mozu.Api/Contracts/AppDev/ApplicationBehavior.cs old mode 100644 new mode 100755 index f7524c92..0235c75a --- a/Mozu.Api/Contracts/AppDev/ApplicationBehavior.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationBehavior.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationBehavior { - /// - ///Mozu.AppDev.Contracts.ApplicationBehavior behaviorId ApiTypeMember DOCUMENT_HERE - /// public int BehaviorId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationBehavior packageId ApiTypeMember DOCUMENT_HERE - /// public int PackageId { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationCapability.cs b/Mozu.Api/Contracts/AppDev/ApplicationCapability.cs old mode 100644 new mode 100755 index 68f304d6..63ee84d5 --- a/Mozu.Api/Contracts/AppDev/ApplicationCapability.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationCapability.cs @@ -13,34 +13,16 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationCapability { - /// - ///Mozu.AppDev.Contracts.ApplicationCapability applicationCapabilityId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationCapabilityId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapability applicationCapabilityTypeId ApiTypeMember DOCUMENT_HERE - /// public int? ApplicationCapabilityTypeId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapability applicationEndPoint ApiTypeMember DOCUMENT_HERE - /// public string ApplicationEndPoint { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapability capabilityTypeContractId ApiTypeMember DOCUMENT_HERE - /// public int CapabilityTypeContractId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapability packageId ApiTypeMember DOCUMENT_HERE - /// public int PackageId { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationCapabilityDomain.cs b/Mozu.Api/Contracts/AppDev/ApplicationCapabilityDomain.cs old mode 100644 new mode 100755 index 1f0c8e39..5f6108d7 --- a/Mozu.Api/Contracts/AppDev/ApplicationCapabilityDomain.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationCapabilityDomain.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationCapabilityDomain { - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityDomain applicationCapabilityDomainId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationCapabilityDomainId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityDomain applicationCapabilityDomainValues1 ApiTypeMember DOCUMENT_HERE - /// public List ApplicationCapabilityDomainValues1 { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityDomain applicationCapabilityDomainValues2 ApiTypeMember DOCUMENT_HERE - /// public List ApplicationCapabilityDomainValues2 { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityDomain applicationCapabilityTypeId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationCapabilityTypeId { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationCapabilityDomainValue.cs b/Mozu.Api/Contracts/AppDev/ApplicationCapabilityDomainValue.cs old mode 100644 new mode 100755 index b2a455a3..6f19e85e --- a/Mozu.Api/Contracts/AppDev/ApplicationCapabilityDomainValue.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationCapabilityDomainValue.cs @@ -13,34 +13,16 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationCapabilityDomainValue { - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityDomainValue applicationCapabilityDomainId1 ApiTypeMember DOCUMENT_HERE - /// public int? ApplicationCapabilityDomainId1 { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityDomainValue applicationCapabilityDomainId2 ApiTypeMember DOCUMENT_HERE - /// public int? ApplicationCapabilityDomainId2 { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityDomainValue applicationCapabilityDomainValueId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationCapabilityDomainValueId { get; set; } - /// - ///The name that displays for the payment gateway or third-party credentials field. - /// public string DisplayName { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityDomainValue valueName ApiTypeMember DOCUMENT_HERE - /// public string ValueName { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationCapabilityType.cs b/Mozu.Api/Contracts/AppDev/ApplicationCapabilityType.cs old mode 100644 new mode 100755 index 3d0f1d87..a7b6a308 --- a/Mozu.Api/Contracts/AppDev/ApplicationCapabilityType.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationCapabilityType.cs @@ -14,54 +14,24 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationCapabilityType { - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityType applicationCapabilities ApiTypeMember DOCUMENT_HERE - /// public List ApplicationCapabilities { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityType applicationCapabilityDomains ApiTypeMember DOCUMENT_HERE - /// public List ApplicationCapabilityDomains { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityType applicationCapabilityTypeId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationCapabilityTypeId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityType applicationId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityType capabilityTypeId ApiTypeMember DOCUMENT_HERE - /// public int CapabilityTypeId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityType capabilityTypeName ApiTypeMember DOCUMENT_HERE - /// public string CapabilityTypeName { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityType isImplemented ApiTypeMember DOCUMENT_HERE - /// public bool IsImplemented { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityType isInitializedByDefault ApiTypeMember DOCUMENT_HERE - /// public bool IsInitializedByDefault { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationCapabilityType packageId ApiTypeMember DOCUMENT_HERE - /// public int PackageId { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationEntitlement.cs b/Mozu.Api/Contracts/AppDev/ApplicationEntitlement.cs old mode 100644 new mode 100755 index d8f82ff5..8731797d --- a/Mozu.Api/Contracts/AppDev/ApplicationEntitlement.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationEntitlement.cs @@ -14,119 +14,50 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationEntitlement { - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement appKey ApiTypeMember DOCUMENT_HERE - /// public string AppKey { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement applicationEntitlementId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationEntitlementId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement applicationId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement applicationLicenseType ApiTypeMember DOCUMENT_HERE - /// public string ApplicationLicenseType { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement applicationName ApiTypeMember DOCUMENT_HERE - /// public string ApplicationName { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement applicationStatusId ApiTypeMember DOCUMENT_HERE - /// public string ApplicationStatusId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement applicationTransactions ApiTypeMember DOCUMENT_HERE - /// public List ApplicationTransactions { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement applicationVersion ApiTypeMember DOCUMENT_HERE - /// public string ApplicationVersion { get; set; } - /// - ///Denotes the application owner dev account id - /// public int AppOwnerDevAccountId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement devAccountId ApiTypeMember DOCUMENT_HERE - /// public int DevAccountId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement effectiveEndDate ApiTypeMember DOCUMENT_HERE - /// public DateTime? EffectiveEndDate { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement effectiveStartDate ApiTypeMember DOCUMENT_HERE - /// public DateTime? EffectiveStartDate { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement entitlementStatus ApiTypeMember DOCUMENT_HERE - /// public string EntitlementStatus { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement installedAppsApplicationId ApiTypeMember DOCUMENT_HERE - /// public string InstalledAppsApplicationId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement installedByFirstName ApiTypeMember DOCUMENT_HERE - /// public string InstalledByFirstName { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement installedByLastName ApiTypeMember DOCUMENT_HERE - /// public string InstalledByLastName { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement installedDate ApiTypeMember DOCUMENT_HERE - /// public DateTime InstalledDate { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement packageId ApiTypeMember DOCUMENT_HERE - /// public int PackageId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement packageName ApiTypeMember DOCUMENT_HERE - /// public string PackageName { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int? SiteId { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int TenantId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationEntitlement tenantName ApiTypeMember DOCUMENT_HERE - /// public string TenantName { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationSubscription.cs b/Mozu.Api/Contracts/AppDev/ApplicationSubscription.cs old mode 100644 new mode 100755 index ca62ac03..025e5d4e --- a/Mozu.Api/Contracts/AppDev/ApplicationSubscription.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationSubscription.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationSubscription { - /// - ///The End Point where the event information will be sent to when the event is fired. - /// public string ApplicationEndPoint { get; set; } - /// - ///The unique identifier of an ApplicationVersionEvent record. - /// public int ApplicationSubscriptionId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSubscription events ApiTypeMember DOCUMENT_HERE - /// public List Events { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSubscription noCallback ApiTypeMember DOCUMENT_HERE - /// public bool NoCallback { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSubscription packageId ApiTypeMember DOCUMENT_HERE - /// public int PackageId { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationSummary.cs b/Mozu.Api/Contracts/AppDev/ApplicationSummary.cs old mode 100644 new mode 100755 index 5b1d4ccf..322ee07e --- a/Mozu.Api/Contracts/AppDev/ApplicationSummary.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationSummary.cs @@ -13,94 +13,40 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationSummary { - /// - ///Unique identifier of an app available in your tenant or within Dev Center. This ID is unique across all apps installed, initialized, and enabled in the and those in development through the Dev Center Console. - /// public string AppId { get; set; } - /// - ///The AppKey is a runtime type. - /// public string AppKey { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary applicationId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary applicationNamespace ApiTypeMember DOCUMENT_HERE - /// public string ApplicationNamespace { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary applicationStatusId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationStatusId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary applicationStatusName ApiTypeMember DOCUMENT_HERE - /// public string ApplicationStatusName { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary applicationTypeId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationTypeId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary applicationVersion ApiTypeMember DOCUMENT_HERE - /// public AppVersion ApplicationVersion { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary appSchemeVersion ApiTypeMember DOCUMENT_HERE - /// public byte AppSchemeVersion { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary hasVersions ApiTypeMember DOCUMENT_HERE - /// public bool HasVersions { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The AppKey is a runtime type. This only applies for themes that inherit from another theme. - /// public string ParentAppKey { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary parentName ApiTypeMember DOCUMENT_HERE - /// public string ParentName { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary releasePackageId ApiTypeMember DOCUMENT_HERE - /// public int ReleasePackageId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary releasePackageName ApiTypeMember DOCUMENT_HERE - /// public string ReleasePackageName { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationSummary updateAvailable ApiTypeMember DOCUMENT_HERE - /// public bool UpdateAvailable { get; set; } - /// - ///The AppKey is a runtime type. This only applies for themes that inherit from another theme. It shows the most current update available. - /// public string UpdateParentAppKey { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationSummaryCollection.cs b/Mozu.Api/Contracts/AppDev/ApplicationSummaryCollection.cs old mode 100644 new mode 100755 index a1f93eb1..a09319b5 --- a/Mozu.Api/Contracts/AppDev/ApplicationSummaryCollection.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationSummaryCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// This property is not exposed in documentation. - /// public class ApplicationSummaryCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationTransaction.cs b/Mozu.Api/Contracts/AppDev/ApplicationTransaction.cs old mode 100644 new mode 100755 index b4fa5965..d20fd441 --- a/Mozu.Api/Contracts/AppDev/ApplicationTransaction.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationTransaction.cs @@ -13,69 +13,30 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Mozu.AppDev.Contracts.ApplicationTransaction ApiType DOCUMENT_HERE - /// public class ApplicationTransaction { - /// - ///Mozu.AppDev.Contracts.ApplicationTransaction applicationEntitlementId ApiTypeMember DOCUMENT_HERE - /// public int? ApplicationEntitlementId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationTransaction applicationId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationTransaction applicationTransactionId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationTransactionId { get; set; } - /// - ///The three character ISO currency code for the monetary amount. For example, USD is used for US Dollars. - /// public string IsoCurrencyCode { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public int LocaleCode { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationTransaction orderNumber ApiTypeMember DOCUMENT_HERE - /// public string OrderNumber { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int? SiteId { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int TenantId { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationTransaction transactionDate ApiTypeMember DOCUMENT_HERE - /// public DateTime TransactionDate { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationTransaction transactionPrice ApiTypeMember DOCUMENT_HERE - /// public decimal TransactionPrice { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationTransaction transactionTax ApiTypeMember DOCUMENT_HERE - /// public decimal TransactionTax { get; set; } - /// - ///Mozu.AppDev.Contracts.ApplicationTransaction transactionTotal ApiTypeMember DOCUMENT_HERE - /// public decimal TransactionTotal { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/ApplicationVersionsCollection.cs b/Mozu.Api/Contracts/AppDev/ApplicationVersionsCollection.cs old mode 100644 new mode 100755 index 6ffeba98..4fab3b86 --- a/Mozu.Api/Contracts/AppDev/ApplicationVersionsCollection.cs +++ b/Mozu.Api/Contracts/AppDev/ApplicationVersionsCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Mozu.AppDev.Contracts.Public.ApplicationVersionsCollection ApiType DOCUMENT_HERE - /// public class ApplicationVersionsCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/Attribute.cs b/Mozu.Api/Contracts/AppDev/Attribute.cs old mode 100644 new mode 100755 index a8b63c23..de2eeaaf --- a/Mozu.Api/Contracts/AppDev/Attribute.cs +++ b/Mozu.Api/Contracts/AppDev/Attribute.cs @@ -13,64 +13,28 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Properties of an attribute used to describe customers or orders. - /// public class Attribute { - /// - ///The administrator name associated with the object/data. - /// public string AdminName { get; set; } - /// - ///Mozu.AppDev.Contracts.Attribute applicationAttributeId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationAttributeId { get; set; } - /// - ///Mozu.AppDev.Contracts.Attribute attributeId ApiTypeMember DOCUMENT_HERE - /// public int AttributeId { get; set; } - /// - ///Mozu.AppDev.Contracts.Attribute code ApiTypeMember DOCUMENT_HERE - /// public string Code { get; set; } - /// - ///Mozu.AppDev.Contracts.Attribute fqn ApiTypeMember DOCUMENT_HERE - /// public string Fqn { get; set; } - /// - ///The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea. - /// public string InputType { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int Sequence { get; set; } - /// - ///Mozu.AppDev.Contracts.Attribute type ApiTypeMember DOCUMENT_HERE - /// public string Type { get; set; } - /// - ///Mozu.AppDev.Contracts.Attribute vocabularyJson ApiTypeMember DOCUMENT_HERE - /// public string VocabularyJson { get; set; } - /// - ///List of valid vocabulary values defined for an attribute. - /// public string VocabularyValues { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/AuthTicket.cs b/Mozu.Api/Contracts/AppDev/AuthTicket.cs old mode 100644 new mode 100755 index 93e183b1..a4d8145d --- a/Mozu.Api/Contracts/AppDev/AuthTicket.cs +++ b/Mozu.Api/Contracts/AppDev/AuthTicket.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.AppDev /// public class AuthTicket { - /// - ///Alphanumeric string used to authenticate the user in API request headers. The token stores an encrypted list of the application's configured behaviors and authenticates the application. - /// public string AccessToken { get; set; } - /// - ///The date and time the user access token expires. If the token will expire, a new token will need to be generated and assigned to the account to continue and restore access to the store, data, and account. - /// public DateTime AccessTokenExpiration { get; set; } - /// - ///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 string RefreshToken { get; set; } - /// - ///The date and time the developer account or application refresh token expires. - /// public DateTime RefreshTokenExpiration { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/AuthTicketRequest.cs b/Mozu.Api/Contracts/AppDev/AuthTicketRequest.cs old mode 100644 new mode 100755 index 1abbcf84..ff9964e0 --- a/Mozu.Api/Contracts/AppDev/AuthTicketRequest.cs +++ b/Mozu.Api/Contracts/AppDev/AuthTicketRequest.cs @@ -18,9 +18,6 @@ namespace Mozu.Api.Contracts.AppDev /// public class AuthTicketRequest { - /// - ///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 string RefreshToken { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/Event.cs b/Mozu.Api/Contracts/AppDev/Event.cs old mode 100644 new mode 100755 index 069c27ec..ebf9bb6e --- a/Mozu.Api/Contracts/AppDev/Event.cs +++ b/Mozu.Api/Contracts/AppDev/Event.cs @@ -13,29 +13,14 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Mozu.AppDev.Contracts.Event ApiType DOCUMENT_HERE - /// public class Event { - /// - ///The Api Version Number which defines what events are available for a given API version. - /// public string ApiVersionNumber { get; set; } - /// - ///The category the event belongs to. - /// public string EventCategory { get; set; } - /// - ///Unique identifier for the event. - /// public int EventId { get; set; } - /// - ///The name of the event. - /// public string EventName { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/FileMetadata.cs b/Mozu.Api/Contracts/AppDev/FileMetadata.cs old mode 100644 new mode 100755 index cee52277..4eeaaee0 --- a/Mozu.Api/Contracts/AppDev/FileMetadata.cs +++ b/Mozu.Api/Contracts/AppDev/FileMetadata.cs @@ -19,34 +19,16 @@ namespace Mozu.Api.Contracts.AppDev /// public class FileMetadata { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Checksum function used to validate the local version of the file against the version on the server. - /// public string CheckSum { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The path and file name that represents the file location. - /// public string Path { get; set; } - /// - ///The total size of the package file, in bytes. - /// public long SizeInBytes { get; set; } - /// - ///The type of file in the package. - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/FolderMetadata.cs b/Mozu.Api/Contracts/AppDev/FolderMetadata.cs old mode 100644 new mode 100755 index 3b0bc9a3..3757c781 --- a/Mozu.Api/Contracts/AppDev/FolderMetadata.cs +++ b/Mozu.Api/Contracts/AppDev/FolderMetadata.cs @@ -19,24 +19,12 @@ namespace Mozu.Api.Contracts.AppDev /// public class FolderMetadata { - /// - ///Array list of files in the folder. - /// public List Files { get; set; } - /// - ///The directory of the file location of the folder in the package. - /// public string FullPath { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Array list of subfolders stored in this folder. - /// public List SubFolders { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/Package.cs b/Mozu.Api/Contracts/AppDev/Package.cs old mode 100644 new mode 100755 index 0e8720bd..0ca2c078 --- a/Mozu.Api/Contracts/AppDev/Package.cs +++ b/Mozu.Api/Contracts/AppDev/Package.cs @@ -15,273 +15,114 @@ namespace Mozu.Api.Contracts.AppDev { /// - /// Properties for a package for fulfillment and shipment. A package may include one to many products, or a bundle of products. + /// Properties of a development or release package of theme asset or application configuration files. /// public class Package { - /// - ///Mozu.AppDev.Contracts.Package apiVersion ApiTypeMember DOCUMENT_HERE - /// public string ApiVersion { get; set; } - /// - ///This will be used by the 3rd party developers to set a URL the intalled applications can call from the Tenant installation/ - /// public string AppConfigUrl { get; set; } - /// - ///Unique identifier of an app available in your tenant or within Dev Center. This ID is unique across all apps installed, initialized, and enabled in the and those in development through the Dev Center Console. - /// public string AppId { get; set; } - /// - ///App Key for the package in question. - /// public string AppKey { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationAttributes ApiTypeMember DOCUMENT_HERE - /// public List ApplicationAttributes { get; set; } - /// - ///List of Application Behaviors that apply to this version of the application. - /// public List ApplicationBehaviors { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationCapabilities ApiTypeMember DOCUMENT_HERE - /// public List ApplicationCapabilities { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationCapabilityTypes ApiTypeMember DOCUMENT_HERE - /// public List ApplicationCapabilityTypes { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationDescription ApiTypeMember DOCUMENT_HERE - /// public string ApplicationDescription { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationDetailId ApiTypeMember DOCUMENT_HERE - /// public int? ApplicationDetailId { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationEntitlements ApiTypeMember DOCUMENT_HERE - /// public List ApplicationEntitlements { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationId { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationName ApiTypeMember DOCUMENT_HERE - /// public string ApplicationName { get; set; } - /// - ///This is the DevAccountId that owns the application - /// public int ApplicationOwnerDevAccountId { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationStatus ApiTypeMember DOCUMENT_HERE - /// public string ApplicationStatus { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationStatusId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationStatusId { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationStatusName ApiTypeMember DOCUMENT_HERE - /// public string ApplicationStatusName { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationSubscriptions ApiTypeMember DOCUMENT_HERE - /// public List ApplicationSubscriptions { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationTypeId ApiTypeMember DOCUMENT_HERE - /// public int ApplicationTypeId { get; set; } - /// - ///Mozu.AppDev.Contracts.Package applicationTypeName ApiTypeMember DOCUMENT_HERE - /// public string ApplicationTypeName { get; set; } - /// - ///The date and time in UTC format when the application was updated most recently. - /// public DateTime? ApplicationUpdateDate { get; set; } - /// - ///Mozu.AppDev.Contracts.Package appSchemeVersion ApiTypeMember DOCUMENT_HERE - /// public byte AppSchemeVersion { get; set; } - /// - ///Mozu.AppDev.Contracts.Package assetFileCount ApiTypeMember DOCUMENT_HERE - /// public int AssetFileCount { get; set; } - /// - ///Mozu.AppDev.Contracts.Package attributeNamespace ApiTypeMember DOCUMENT_HERE - /// public string AttributeNamespace { get; set; } - /// - ///Mozu.AppDev.Contracts.Package dataNamespace ApiTypeMember DOCUMENT_HERE - /// public string DataNamespace { get; set; } - /// - ///Mozu.AppDev.Contracts.Package hasApplicationVersions ApiTypeMember DOCUMENT_HERE - /// public bool HasApplicationVersions { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///Indicates if the object is deleted. If true, the object has been deleted. This may affect associated child members and objects. For example, a deleted master catalog affects all associated catalogs. - /// public bool IsDeleted { get; set; } - /// - ///Indicates if a customer account and associated data is locked. If true, the user account is locked due to multiple failed authentication attempts. The user cannot login until the account is unlocked. - /// public bool IsLocked { get; set; } - /// - ///Mozu.AppDev.Contracts.Package isReleasePackage ApiTypeMember DOCUMENT_HERE - /// public bool IsReleasePackage { get; set; } - /// - ///Mozu.AppDev.Contracts.Package legacyNamespace ApiTypeMember DOCUMENT_HERE - /// public string LegacyNamespace { get; set; } - /// - ///Mozu.AppDev.Contracts.Package majorVersion ApiTypeMember DOCUMENT_HERE - /// public int MajorVersion { get; set; } - /// - ///Mozu.AppDev.Contracts.Package minorVersion ApiTypeMember DOCUMENT_HERE - /// public int MinorVersion { get; set; } - /// - ///The namespace for the accessible APIs and source capabilities in the core of APIs. - /// public string Namespace { get; set; } - /// - ///Mozu.AppDev.Contracts.Package namespaceRegistryId ApiTypeMember DOCUMENT_HERE - /// public string NamespaceRegistryId { get; set; } - /// - ///Mozu.AppDev.Contracts.Package packageDescription ApiTypeMember DOCUMENT_HERE - /// public string PackageDescription { get; set; } - /// - ///Mozu.AppDev.Contracts.Package packageGuid ApiTypeMember DOCUMENT_HERE - /// public string PackageGuid { get; set; } - /// - ///Mozu.AppDev.Contracts.Package packageName ApiTypeMember DOCUMENT_HERE - /// public string PackageName { get; set; } - /// - ///The parent theme AppKey if this is a theme and the theme extends a valid, published theme. - /// public string ParentThemeAppKey { get; set; } - /// - ///Mozu.AppDev.Contracts.Package parentThemeName ApiTypeMember DOCUMENT_HERE - /// public string ParentThemeName { get; set; } - /// - ///Mozu.AppDev.Contracts.Package publishedParentSemanticVersion ApiTypeMember DOCUMENT_HERE - /// public string PublishedParentSemanticVersion { get; set; } - /// - ///Mozu.AppDev.Contracts.Package publishedParentThemeId ApiTypeMember DOCUMENT_HERE - /// public int? PublishedParentThemeId { get; set; } - /// - ///Mozu.AppDev.Contracts.Package revision ApiTypeMember DOCUMENT_HERE - /// public int Revision { get; set; } - /// - ///Mozu.AppDev.Contracts.Package semanticVersionRange ApiTypeMember DOCUMENT_HERE - /// public string SemanticVersionRange { get; set; } - /// - ///Mozu.AppDev.Contracts.Package sharedSecret ApiTypeMember DOCUMENT_HERE - /// public string SharedSecret { get; set; } - /// - ///Mozu.AppDev.Contracts.Package themeEngineVersion ApiTypeMember DOCUMENT_HERE - /// public string ThemeEngineVersion { get; set; } - /// - ///Whether or not there's a theme update. - /// public bool UpdateAvailable { get; set; } - /// - ///The date and time in UTC format the object was updated most recently. - /// public DateTime UpdateDate { get; set; } - /// - ///The AppKey is a runtime type. This only applies for themes that inherit from another theme. It shows the most current update available. - /// public string UpdateParentAppKey { get; set; } - /// - ///updateParentThemeName ApiType DOCUMENT_HERE - /// public string UpdateParentThemeName { get; set; } - /// - ///updateParentThemeVersion ApiType DOCUMENT_HERE - /// public string UpdateParentThemeVersion { get; set; } - /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. - /// public string UserId { get; set; } - /// - ///List of Statuses that the application can move to during the application lifecycle. This is based on what the current value of the ApplicatinStatusId is. - /// public List ValidApplicationStatusIdList { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/PackageCollection.cs b/Mozu.Api/Contracts/AppDev/PackageCollection.cs old mode 100644 new mode 100755 index 921af044..b5980c20 --- a/Mozu.Api/Contracts/AppDev/PackageCollection.cs +++ b/Mozu.Api/Contracts/AppDev/PackageCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Mozu.AppDev.Contracts.PackageCollection ApiType DOCUMENT_HERE - /// public class PackageCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/PackageNamesCollection.cs b/Mozu.Api/Contracts/AppDev/PackageNamesCollection.cs old mode 100644 new mode 100755 index cec88bc2..610a0441 --- a/Mozu.Api/Contracts/AppDev/PackageNamesCollection.cs +++ b/Mozu.Api/Contracts/AppDev/PackageNamesCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Mozu.AppDev.Contracts.Public.PackageNamesCollection ApiType DOCUMENT_HERE - /// public class PackageNamesCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/PackageRequest.cs b/Mozu.Api/Contracts/AppDev/PackageRequest.cs old mode 100644 new mode 100755 index 6847535c..528c6f16 --- a/Mozu.Api/Contracts/AppDev/PackageRequest.cs +++ b/Mozu.Api/Contracts/AppDev/PackageRequest.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Mozu.AppDev.Contracts.PackageRequest ApiType DOCUMENT_HERE - /// public class PackageRequest { - /// - ///Mozu.AppDev.Contracts.PackageRequest appKey ApiTypeMember DOCUMENT_HERE - /// public string AppKey { get; set; } - /// - ///Mozu.AppDev.Contracts.PackageRequest parentThemeAppKey ApiTypeMember DOCUMENT_HERE - /// public string ParentThemeAppKey { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/PackageSummary.cs b/Mozu.Api/Contracts/AppDev/PackageSummary.cs old mode 100644 new mode 100755 index abc4261e..a8746ab0 --- a/Mozu.Api/Contracts/AppDev/PackageSummary.cs +++ b/Mozu.Api/Contracts/AppDev/PackageSummary.cs @@ -13,54 +13,24 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Mozu.AppDev.Contracts.PackageSummary ApiType DOCUMENT_HERE - /// public class PackageSummary { - /// - ///The unique identifier of the application. - /// public int ApplicationId { get; set; } - /// - ///Application Name - /// public string ApplicationName { get; set; } - /// - ///Application Type Id - /// public int ApplicationTypeId { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///Indicates if a customer account and associated data is locked. If true, the user account is locked due to multiple failed authentication attempts. The user cannot login until the account is unlocked. - /// public bool IsLocked { get; set; } - /// - ///Application Major Version - /// public int MajorVersion { get; set; } - /// - ///Application Minor Version - /// public int MinorVersion { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Application Revision - /// public int Revision { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/PackageSummaryCollection.cs b/Mozu.Api/Contracts/AppDev/PackageSummaryCollection.cs old mode 100644 new mode 100755 index 786783b9..35b9a2e1 --- a/Mozu.Api/Contracts/AppDev/PackageSummaryCollection.cs +++ b/Mozu.Api/Contracts/AppDev/PackageSummaryCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.AppDev { - /// - /// Mozu.AppDev.Contracts.PackageSummaryCollection ApiType DOCUMENT_HERE - /// public class PackageSummaryCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/AppDev/RenameInfo.cs b/Mozu.Api/Contracts/AppDev/RenameInfo.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/CommerceRuntime/Carts/Cart.cs b/Mozu.Api/Contracts/CommerceRuntime/Carts/Cart.cs old mode 100644 new mode 100755 index 8c36ced3..40d4a4eb --- a/Mozu.Api/Contracts/CommerceRuntime/Carts/Cart.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Carts/Cart.cs @@ -24,209 +24,94 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Carts /// public class Cart { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///An array of message details associated with the cart. - /// public CartMessage CartMessage { get; set; } - /// - ///A list of cart messages associated with the cart. - /// public List CartMessages { get; set; } - /// - ///Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only. - /// public List ChangeMessages { get; set; } - /// - ///Code that identifies the channel associated with the site for the shopper's created shopping cart, order, and return. - /// public string ChannelCode { get; set; } /// - ///Array list of coupon codes associated with a shopping cart and the associated order. These codes are entered by a shopper when proceeding to checkout. + ///The coupon codes applied to the cart. When the customer proceeds to checkout, the coupons applied to the cart apply to the order. /// public List CouponCodes { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///The type of customer interaction used to create this shopping cart. Possible values are Website, Call, Store, or Unknown. - /// public string CustomerInteractionType { get; set; } - /// - ///Custom data for a given vendor set within the commerce process. - /// public JObject Data { get; set; } - /// - ///The aggregate total for all items in the cart, including costs associated with shopper-defined options or extras and any applied discounts. - /// public decimal? DiscountedSubtotal { get; set; } - /// - ///The subtotal of the cart, order, and wishlist items, including any applied discount calculations. Wishlist subtotals may change depending on the length of time, available discounts, and stock amounts of products at the time of review by shoppers. - /// public decimal? DiscountedTotal { get; set; } - /// - ///Estimated amount of discounts applied to all items in the carts and orders. System-supplied and read-only. This value will be available at the wish list, cart item, order item, and wish list item level at a later time. - /// public decimal? DiscountTotal { get; set; } - /// - ///Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only. - /// public DateTime? ExpirationDate { get; set; } - /// - ///Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values. - /// public List ExtendedProperties { get; set; } - /// - ///The monetary sum of all fees incurred in the cart, order, line item in a cart, or line item in an order. This value is not calculated for wish lists at this time. - /// public decimal? FeeTotal { get; set; } - /// - ///Properties of the information required to fulfill the cart, order, or wish list. Shoppers can fulfill ordered items by using in-store pickup or direct shipping. - /// public FulfillmentInfo FulfillmentInfo { get; set; } - /// - ///The combined price for all handling costs calculated together for shipped orders, not for digital or in-store pickup. This includes all handling costs per the product line items and options, excluding taxes and discounts. - /// public decimal? HandlingAmount { get; set; } - /// - ///The handling fee subtotal included in the cart calculation. - /// public decimal? HandlingSubTotal { get; set; } - /// - ///Calculated total tax amount for handling costs if the cart/order is subject to sales tax. - /// public decimal? HandlingTaxTotal { get; set; } - /// - ///The handling fee total included in the cart calculation. - /// public decimal? HandlingTotal { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } /// - ///The list of invalid coupons the shopper attempted to enter for the cart or order. These coupons may no longer be valid or incorrectly entered. + ///The list of invalid coupons the shopper attempted to enter for the cart. /// public List InvalidCoupons { get; set; } - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The total amount of calculated tax for items, used by carts, orders, and wish lists. - /// public decimal? ItemTaxTotal { get; set; } - /// - ///The date in UTC Date/Time when the items in the cart were last validated against the site's product catalog. System-supplied and read-only. - /// public DateTime? LastValidationDate { get; set; } - /// - ///The total charge for the line item with all weighted order level manual adjustments. - /// public decimal? LineItemSubtotalWithOrderAdjustments { get; set; } - /// - ///List of order-level discounts projected to apply to the cart at checkout or order. - /// public List OrderDiscounts { get; set; } - /// - ///Pricelist code - /// public string PriceListCode { get; set; } - /// - ///The total shipping amount for the cart before discounts and adjustments. - /// public decimal? ShippingAmountBeforeDiscountsAndAdjustments { get; set; } - /// - ///The shipping subtotal amount calculated without any applied discounts for line item and entire amounts of carts and orders. This property is not calculated for wish lists at this time. - /// public decimal? ShippingSubTotal { get; set; } - /// - ///The total amount of tax incurred on the shipping charges in the cart and order. This property is not calculated at this time for wish lists. - /// public decimal? ShippingTaxTotal { get; set; } - /// - ///The calculated total shipping amount estimated for carts or orders, including tax. This amount is not calculated for wish lists at this time. - /// public decimal? ShippingTotal { get; set; } - /// - ///Unique identifier of the site. - /// public int? SiteId { get; set; } - /// - ///Estimated amount of the cart or order without sales tax, shipping costs, and other fees. This amount is not calculated for wish lists at this time. - /// public decimal? Subtotal { get; set; } - /// - ///Leverage this property within a [tax Arc.js action](https://www.mozu.com/docs/arcjs/commerce-catalog-storefront-tax/commerce-catalog-storefront-tax.htm) to supplement the tax information for this item or object with custom JSON data. - /// + public List SuggestedDiscounts { get; set; } + public JObject TaxData { get; set; } - /// - ///The total monetary sum of sales tax estimated for a cart or order. - /// public decimal? TaxTotal { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int? TenantId { get; set; } - /// - ///Total is used to indicate the monetary, estimated total amount of the cart or order, including items, sales tax, shipping costs, and other fees. Totals are not estimated for wish lists at this time. - /// public decimal? Total { get; set; } - /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. - /// public string UserId { get; set; } - /// - ///Unique identifier of the customer visit in which the cart was created or last modified. - /// public string VisitId { get; set; } - /// - ///Unique identifier of the web session in which the cart, order, return, or wish list was created or last modified. - /// public string WebSessionId { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartChangeMessageCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartChangeMessageCollection.cs old mode 100644 new mode 100755 index d67e51dd..63c24695 --- a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartChangeMessageCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartChangeMessageCollection.cs @@ -20,14 +20,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Carts /// public class CartChangeMessageCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartItem.cs b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartItem.cs old mode 100644 new mode 100755 index 87008647..3f1bda09 --- a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartItem.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartItem.cs @@ -24,219 +24,97 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Carts /// public class CartItem { - /// - ///The adjusted subtotal of the line item, including all manual adjustments, discounts, shipping charges and discounts, and duty or any other additional line item fees. - /// public decimal? AdjustedLineItemSubtotal { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Custom data for a given vendor set within the commerce process. - /// + public int? AutoAddDiscountId { get; set; } + public JObject Data { get; set; } - /// - ///The subtotal of the cart, order, and wishlist items, including any applied discount calculations. Wishlist subtotals may change depending on the length of time, available discounts, and stock amounts of products at the time of review by shoppers. - /// public decimal? DiscountedTotal { get; set; } - /// - ///Estimated amount of discounts applied to all items in the carts and orders. System-supplied and read-only. This value will be available at the wish list, cart item, order item, and wish list item level at a later time. - /// public decimal? DiscountTotal { get; set; } - /// - ///Represents the total price of the cart item extended to the shopper. This begins with the Unit Price, then uses any of the following prices if they are defined, in the following order: Override Amount, Sale Amount, List Amount. This value is not calculated for wish lists at this time. - /// public decimal? ExtendedTotal { get; set; } - /// - ///The monetary sum of all fees incurred in the cart, order, line item in a cart, or line item in an order. This value is not calculated for wish lists at this time. - /// public decimal? FeeTotal { get; set; } - /// - ///The code that identifies the location used to fulfill the cart/cart item or order/order item. This code can include physical store locations for in-store pickup, warehouse locations providing the products for shipment, or the location for the digital file(s). - /// public string FulfillmentLocationCode { get; set; } - /// - ///The method used to fulfill this cart or order item. The method includes direct ship or in-store pickup. The available methods depend on the supported fulfillment types for the product. - /// public string FulfillmentMethod { get; set; } - /// - ///The combined price for all handling costs calculated together for shipped orders, not for digital or in-store pickup. This includes all handling costs per the product line items and options, excluding taxes and discounts. - /// public decimal? HandlingAmount { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. - /// public bool? IsRecurring { get; set; } - /// - ///Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules. - /// public bool? IsTaxable { get; set; } - /// - ///The total amount of calculated tax for items, used by carts, orders, and wish lists. - /// public decimal? ItemTaxTotal { get; set; } - /// - ///The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or in CommerceRuntime when a cart is converted to an order. - /// public int? LineId { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The properties of a product, referenced and used by carts, orders, wish lists, and returns. - /// public Product Product { get; set; } /// - ///The applicable product discount for an associated cart, order, or wish list. + ///Product discounts displays a list of all applicable discount. /// public AppliedLineItemProductDiscount ProductDiscount { get; set; } - /// - ///List of product-level discounts projected to apply to a cart, order, or wish list. - /// public List ProductDiscounts { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// + public string PurchaseLocation { get; set; } + public int Quantity { get; set; } - /// - ///The total shipping amount for the line item before discounts and adjustments. - /// public decimal? ShippingAmountBeforeDiscountsAndAdjustments { get; set; } - /// - ///List of shipping discounts projected to apply to carts, orders, and wish lists and items at checkout. - /// public List ShippingDiscounts { get; set; } - /// - ///The total amount of tax incurred on the shipping charges in the cart and order. This property is not calculated at this time for wish lists. - /// public decimal? ShippingTaxTotal { get; set; } - /// - ///The calculated total shipping amount estimated for carts or orders, including tax. This amount is not calculated for wish lists at this time. - /// public decimal? ShippingTotal { get; set; } - /// - ///Estimated amount of the cart or order without sales tax, shipping costs, and other fees. This amount is not calculated for wish lists at this time. - /// public decimal? Subtotal { get; set; } - /// - ///The monetary amount of an item in the cart that is subject to tax. This amount typically represents the line item subtotal before applied discounts for an order. - /// public decimal? TaxableTotal { get; set; } - /// - ///Leverage this property within a [tax Arc.js action](https://www.mozu.com/docs/arcjs/commerce-catalog-storefront-tax/commerce-catalog-storefront-tax.htm) to supplement the tax information for this item or object with custom JSON data. - /// public JObject TaxData { get; set; } - /// - ///Total is used to indicate the monetary, estimated total amount of the cart or order, including items, sales tax, shipping costs, and other fees. Totals are not estimated for wish lists at this time. - /// public decimal? Total { get; set; } - /// - ///The total charge for the line item without any weighted order level shipping and handling charges. - /// public decimal? TotalWithoutWeightedShippingAndHandling { get; set; } - /// - ///The total charge for the line item with all weighted order level shipping and handling charges. - /// public decimal? TotalWithWeightedShippingAndHandling { get; set; } - /// - ///Properties of the price per unit of a product, associated with cart and order items. This price is not used for wish lists at this time. - /// public CommerceUnitPrice UnitPrice { get; set; } - /// - ///The total weighted order level manual adjustment amount. - /// public decimal? WeightedOrderAdjustment { get; set; } - /// - ///The total weighted order level discount amount. - /// public decimal? WeightedOrderDiscount { get; set; } - /// - ///The total weighted order level duty charges. - /// public decimal? WeightedOrderDuty { get; set; } - /// - ///The amount to adjust the order handling fee. - /// public decimal? WeightedOrderHandlingAdjustment { get; set; } - /// - ///The total weighted order level handling fee amount. - /// public decimal? WeightedOrderHandlingFee { get; set; } - /// - ///The total weighted order handling fee discount amount. - /// public decimal? WeightedOrderHandlingFeeDiscount { get; set; } - /// - ///The total weighted order level handling fee tax amount. - /// public decimal? WeightedOrderHandlingFeeTax { get; set; } - /// - ///The total weighted order level shipping charge. - /// public decimal? WeightedOrderShipping { get; set; } - /// - ///The total weighted order level shipping discount amount. - /// public decimal? WeightedOrderShippingDiscount { get; set; } - /// - ///The total weighted order level shipping manual adjustment amount. - /// public decimal? WeightedOrderShippingManualAdjustment { get; set; } - /// - ///The total weighted order level shipping tax amount. - /// public decimal? WeightedOrderShippingTax { get; set; } - /// - ///The total weighted order level tax amount. - /// public decimal? WeightedOrderTax { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartItemCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartItemCollection.cs old mode 100644 new mode 100755 index 0cdb3f84..b7cbc04c --- a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartItemCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartItemCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Carts /// public class CartItemCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartMessage.cs b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartMessage.cs old mode 100644 new mode 100755 index d1317a10..7fd099da --- a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartMessage.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartMessage.cs @@ -15,24 +15,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Carts { - /// - /// Mozu.CommerceRuntime.Contracts.Carts.CartMessage ApiType DOCUMENT_HERE - /// public class CartMessage { - /// - ///The text of the change message, such as "This product is no longer available." System-supplied and read-only. - /// public string Message { get; set; } - /// - ///Specifies the cart message type. - /// public string MessageType { get; set; } - /// - ///An array of product details for any products that have been removed from the cart. - /// public List ProductsRemoved { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartSummary.cs b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartSummary.cs old mode 100644 new mode 100755 index d3990d14..3ac7f073 --- a/Mozu.Api/Contracts/CommerceRuntime/Carts/CartSummary.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Carts/CartSummary.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Carts /// public class CartSummary { - /// - ///If true, this shopping cart is active. - /// public bool? HasActiveCart { get; set; } - /// - ///suaIf true, the cart's period of inactivity is past its calculated expiration date and the cart is considered abandoned. - /// public bool? IsExpired { get; set; } - /// - ///The total number of line items in the cart. Each line item can have multiple quantities. - /// public int? ItemCount { get; set; } - /// - ///Total is used to indicate the monetary, estimated total amount of the cart or order, including items, sales tax, shipping costs, and other fees. Totals are not estimated for wish lists at this time. - /// public decimal? Total { get; set; } /// diff --git a/Mozu.Api/Contracts/CommerceRuntime/Channels/Channel.cs b/Mozu.Api/Contracts/CommerceRuntime/Channels/Channel.cs old mode 100644 new mode 100755 index dea580e7..b2c47b49 --- a/Mozu.Api/Contracts/CommerceRuntime/Channels/Channel.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Channels/Channel.cs @@ -20,41 +20,20 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Channels /// public class Channel { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///User-defined code that uniquely identifies the channel. - /// public string Code { get; set; } public string CountryCode { get; set; } - /// - ///User-defined code that identifies the channel group. - /// public string GroupCode { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The geographical region associated with this channel. This region could represent any geographical entity from a state to a continent. - /// public string Region { get; set; } - /// - ///Array list of site identifiers associated with this channel. Each tenant site must have a channel association. - /// public List SiteIds { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int TenantId { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelCollection.cs old mode 100644 new mode 100755 index 1b6e655e..0e1ee0cb --- a/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Channels /// public class ChannelCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelGroup.cs b/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelGroup.cs old mode 100644 new mode 100755 index 0e353c37..c0b21cea --- a/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelGroup.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelGroup.cs @@ -19,24 +19,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Channels /// public class ChannelGroup { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///User-defined code that identifies the channel group. - /// public string Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int TenantId { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelGroupCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelGroupCollection.cs old mode 100644 new mode 100755 index 67c84d6c..b97876e5 --- a/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelGroupCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Channels/ChannelGroupCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Channels /// public class ChannelGroupCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Checkouts/Checkout.cs b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/Checkout.cs new file mode 100755 index 00000000..dbfdd1e2 --- /dev/null +++ b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/Checkout.cs @@ -0,0 +1,135 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; + +using Mozu.Api.Contracts.CommerceRuntime.Discounts; +using Mozu.Api.Contracts.CommerceRuntime.Fulfillment; +using Mozu.Api.Contracts.CommerceRuntime.Orders; +using Mozu.Api.Contracts.CommerceRuntime.Payments; +using Mozu.Api.Contracts.Core; + +namespace Mozu.Api.Contracts.CommerceRuntime.Checkouts +{ + public class Checkout + { + public bool? AcceptsMarketing { get; set; } + + public decimal AmountRemainingForPayment { get; set; } + + public List Attributes { get; set; } + + public AuditInfo AuditInfo { get; set; } + + public List AvailableActions { get; set; } + + public string ChannelCode { get; set; } + + public List CouponCodes { get; set; } + + public string CurrencyCode { get; set; } + + public int? CustomerAccountId { get; set; } + + public string CustomerInteractionType { get; set; } + + public string CustomerTaxId { get; set; } + + public JObject Data { get; set; } + + public List Destinations { get; set; } + + public decimal? DutyTotal { get; set; } + + public string Email { get; set; } + + public decimal FeeTotal { get; set; } + + public List Groupings { get; set; } + + public decimal HandlingSubTotal { get; set; } + + public decimal HandlingTaxTotal { get; set; } + + public decimal HandlingTotal { get; set; } + + public string Id { get; set; } + + public List InvalidCoupons { get; set; } + + public string IpAddress { get; set; } + + public bool? IsTaxExempt { get; set; } + + public decimal ItemLevelHandlingDiscountTotal { get; set; } + + public decimal ItemLevelProductDiscountTotal { get; set; } + + public decimal ItemLevelShippingDiscountTotal { get; set; } + + public List Items { get; set; } + + public decimal ItemTaxTotal { get; set; } + + public decimal ItemTotal { get; set; } + + public string LocationCode { get; set; } + + public int? Number { get; set; } + + public List OrderDiscounts { get; set; } + + public decimal OrderLevelHandlingDiscountTotal { get; set; } + + public decimal OrderLevelProductDiscountTotal { get; set; } + + public decimal OrderLevelShippingDiscountTotal { get; set; } + + public string OriginalCartId { get; set; } + + public List Payments { get; set; } + + public string PriceListCode { get; set; } + + public decimal ShippingSubTotal { get; set; } + + public decimal ShippingTaxTotal { get; set; } + + public decimal ShippingTotal { get; set; } + + public ShopperNotes ShopperNotes { get; set; } + + public int SiteId { get; set; } + + public string SourceDevice { get; set; } + + public DateTime? SubmittedDate { get; set; } + + public decimal SubTotal { get; set; } + + public List SuggestedDiscounts { get; set; } + + public JObject TaxData { get; set; } + + public int TenantId { get; set; } + + public decimal Total { get; set; } + + public string Type { get; set; } + + public string VisitId { get; set; } + + public string WebSessionId { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutAction.cs b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutAction.cs new file mode 100755 index 00000000..a1a8b6ab --- /dev/null +++ b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutAction.cs @@ -0,0 +1,22 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.CommerceRuntime.Checkouts +{ + public class CheckoutAction + { + public string ActionName { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutCollection.cs new file mode 100755 index 00000000..5ba3d498 --- /dev/null +++ b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutCollection.cs @@ -0,0 +1,31 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.CommerceRuntime.Checkouts +{ + public class CheckoutCollection + { + public List Items { get; set; } + + public int PageCount { get; set; } + + public int PageSize { get; set; } + + public int StartIndex { get; set; } + + public int TotalCount { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutGroupRates.cs b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutGroupRates.cs new file mode 100755 index 00000000..49449a2c --- /dev/null +++ b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutGroupRates.cs @@ -0,0 +1,26 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +using Mozu.Api.Contracts.CommerceRuntime.Fulfillment; + +namespace Mozu.Api.Contracts.CommerceRuntime.Checkouts +{ + public class CheckoutGroupRates + { + public string GroupingId { get; set; } + + public List ShippingRates { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutGroupShippingMethod.cs b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutGroupShippingMethod.cs new file mode 100755 index 00000000..992d1b2a --- /dev/null +++ b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutGroupShippingMethod.cs @@ -0,0 +1,25 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + +using Mozu.Api.Contracts.CommerceRuntime.Fulfillment; + +namespace Mozu.Api.Contracts.CommerceRuntime.Checkouts +{ + public class CheckoutGroupShippingMethod + { + public string GroupingId { get; set; } + + public ShippingRate ShippingRate { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutGrouping.cs b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutGrouping.cs new file mode 100755 index 00000000..3c56483a --- /dev/null +++ b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/CheckoutGrouping.cs @@ -0,0 +1,76 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; + +using Mozu.Api.Contracts.CommerceRuntime.Discounts; +using Mozu.Api.Contracts.Core; + +namespace Mozu.Api.Contracts.CommerceRuntime.Checkouts +{ + public class CheckoutGrouping + { + public string DestinationId { get; set; } + + public decimal? DutyAmount { get; set; } + + public decimal DutyTotal { get; set; } + + public string FulfillmentMethod { get; set; } + + public decimal? HandlingAmount { get; set; } + + public List HandlingDiscounts { get; set; } + + public decimal HandlingSubTotal { get; set; } + + public decimal? HandlingTax { get; set; } + + public decimal HandlingTaxTotal { get; set; } + + public decimal HandlingTotal { get; set; } + + public string Id { get; set; } + + public decimal ItemLevelHandlingDiscountTotal { get; set; } + + public decimal ItemLevelShippingDiscountTotal { get; set; } + + public List OrderItemIds { get; set; } + + public decimal OrderLevelHandlingDiscountTotal { get; set; } + + public decimal OrderLevelShippingDiscountTotal { get; set; } + + public decimal? ShippingAmount { get; set; } + + public List ShippingDiscounts { get; set; } + + public string ShippingMethodCode { get; set; } + + public string ShippingMethodName { get; set; } + + public decimal ShippingSubTotal { get; set; } + + public decimal? ShippingTax { get; set; } + + public decimal ShippingTaxTotal { get; set; } + + public decimal ShippingTotal { get; set; } + + public bool StandaloneGroup { get; set; } + + public JObject TaxData { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Checkouts/ItemsForDestination.cs b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/ItemsForDestination.cs new file mode 100755 index 00000000..7ec78027 --- /dev/null +++ b/Mozu.Api/Contracts/CommerceRuntime/Checkouts/ItemsForDestination.cs @@ -0,0 +1,25 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.CommerceRuntime.Checkouts +{ + public class ItemsForDestination + { + public string DestinationId { get; set; } + + public List ItemIds { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Commerce/Adjustment.cs b/Mozu.Api/Contracts/CommerceRuntime/Commerce/Adjustment.cs old mode 100644 new mode 100755 index cc30e850..3940a2e8 --- a/Mozu.Api/Contracts/CommerceRuntime/Commerce/Adjustment.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Commerce/Adjustment.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Commerce /// public class Adjustment { - /// - ///The amount of the order-level adjustment, which can be a positive or negative amount. - /// public decimal? Amount { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Administrator notes associated with the order adjustment. These comments are not shopper facing. - /// public string InternalComment { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Commerce/ChangeMessage.cs b/Mozu.Api/Contracts/CommerceRuntime/Commerce/ChangeMessage.cs old mode 100644 new mode 100755 index 5aa50612..7c726dcd --- a/Mozu.Api/Contracts/CommerceRuntime/Commerce/ChangeMessage.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Commerce/ChangeMessage.cs @@ -23,69 +23,30 @@ public class ChangeMessage /// public decimal? Amount { get; set; } - /// - ///Unique identifier of an app available in your tenant or within Dev Center. This ID is unique across all apps installed, initialized, and enabled in the and those in development through the Dev Center Console. - /// public string AppId { get; set; } - /// - ///The application's key. - /// public string AppKey { get; set; } - /// - ///The application's name. - /// public string AppName { get; set; } - /// - ///The unique identifier of the API request associated with the event action, which might contain multiple actions. - /// public string CorrelationId { get; set; } - /// - ///Date and time when the entity was created, represented in UTC Date/Time. - /// public DateTime? CreateDate { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Identifier for the object associated with the change message, which can represent a cart, cart item, or an order. - /// public string Identifier { get; set; } - /// - ///The text of the change message, such as "This product is no longer available." System-supplied and read-only. - /// public string Message { get; set; } - /// - ///Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. - /// public object Metadata { get; set; } - /// - ///The new value of the object affected by the change, such as the new price of the product. System-supplied and read-only. - /// public string NewValue { get; set; } - /// - ///The prior value of the object affected by the change, such as the price of the product when it was added to the cart. System-supplied and read-only. - /// public string OldValue { get; set; } - /// - ///The text that appears on the subject line of the message, such as "The product price has changed." - /// public string Subject { get; set; } - /// - ///Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only. - /// public string SubjectType { get; set; } /// @@ -93,29 +54,17 @@ public class ChangeMessage /// public bool? Success { get; set; } - /// - ///The user's first name. - /// public string UserFirstName { get; set; } /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. + ///The unique identifier of the user who initiated the change. /// public string UserId { get; set; } - /// - ///The user's last name. - /// public string UserLastName { get; set; } - /// - ///The user type (e.g. Shopper, Admin, etc.). - /// public string UserScopeType { get; set; } - /// - ///The action associated with this message. For example, if the price of a product changes, the verb could be "Increased" or "Decreased". If the product is no longer available, the verb could be "Invalidated". System-supplied and read-only. - /// public string Verb { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Commerce/CommerceUnitPrice.cs b/Mozu.Api/Contracts/CommerceRuntime/Commerce/CommerceUnitPrice.cs old mode 100644 new mode 100755 index ea200bb5..090452aa --- a/Mozu.Api/Contracts/CommerceRuntime/Commerce/CommerceUnitPrice.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Commerce/CommerceUnitPrice.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Commerce /// public class CommerceUnitPrice { - /// - ///Represents the total price of the line item extended to the shopper. This begins with the Unit Price, then uses any of the following prices if they are defined, in the following order: Override Amount, Sale Amount, List Amount. - /// public decimal? ExtendedAmount { get; set; } - /// - ///The price the item is listed for in the storefront. - /// public decimal? ListAmount { get; set; } - /// - ///The override price of the item set by the merchant for a given order. - /// public decimal? OverrideAmount { get; set; } - /// - ///The sale price set for the item. - /// public decimal? SaleAmount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Commerce/ExtendedProperty.cs b/Mozu.Api/Contracts/CommerceRuntime/Commerce/ExtendedProperty.cs old mode 100644 new mode 100755 index f26f9556..56935787 --- a/Mozu.Api/Contracts/CommerceRuntime/Commerce/ExtendedProperty.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Commerce/ExtendedProperty.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Commerce { - /// - /// Mozu.CommerceRuntime.Contracts.Commerce.ExtendedProperty ApiType DOCUMENT_HERE - /// public class ExtendedProperty { - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Commerce/PackageMeasurements.cs b/Mozu.Api/Contracts/CommerceRuntime/Commerce/PackageMeasurements.cs old mode 100644 new mode 100755 index 54dc52a4..d54e4df4 --- a/Mozu.Api/Contracts/CommerceRuntime/Commerce/PackageMeasurements.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Commerce/PackageMeasurements.cs @@ -19,24 +19,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Commerce /// public class PackageMeasurements { - /// - ///Height of the package in imperial units of feet and inches. - /// public Measurement Height { get; set; } - /// - ///Length of the package in imperial units of feet and inches. - /// public Measurement Length { get; set; } - /// - ///Weight of the package in imperial units of pounds and ounces. - /// public Measurement Weight { get; set; } - /// - ///Width of the package in imperial units of feet and inches. - /// public Measurement Width { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedDiscount.cs b/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedDiscount.cs old mode 100644 new mode 100755 index 5c7779e5..73c6eefd --- a/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedDiscount.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedDiscount.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Discounts /// public class AppliedDiscount { - /// - ///Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// public string CouponCode { get; set; } - /// - ///Name of the discount added and applied to a shopping cart and order for a shopper's purchase. - /// public Discount Discount { get; set; } - /// - ///Indicates if a discount is not used for the product or product line item in an order. If true, the system ignores this discount when pricing the order. - /// public bool? Excluded { get; set; } - /// - ///The value of the discount applied to the cart or order, represented as a negative currency amount to apply to the original price. - /// public decimal? Impact { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedLineItemProductDiscount.cs b/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedLineItemProductDiscount.cs old mode 100644 new mode 100755 index 28a5c494..a27e0e2c --- a/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedLineItemProductDiscount.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedLineItemProductDiscount.cs @@ -29,7 +29,7 @@ public class AppliedLineItemProductDiscount public string CouponCode { get; set; } /// - ///Name of the discount added and applied to a shopping cart and order for a shopper's purchase. + ///This describes discounts that apply to the order, if any. For example, when the subtotal of the order exceeds a certain amount, or a discount for free shipping. /// public Discount Discount { get; set; } @@ -38,24 +38,18 @@ public class AppliedLineItemProductDiscount /// public int DiscountQuantity { get; set; } - /// - ///Indicates if a discount is not used for the product or product line item in an order. If true, the system ignores this discount when pricing the order. - /// public bool? Excluded { get; set; } /// - ///The value of the discount applied to the cart or order, represented as a negative currency amount to apply to the original price. + ///The value of the applied discount. This is a negative number, which is subtracted from the original price to get the final price. /// public decimal? Impact { get; set; } /// - ///The impact of a discount for each discount quantity. + ///The impact of this discount for each discount quantity. /// public decimal? ImpactPerUnit { get; set; } - /// - ///Quantity of products priced. This is always one unless calculating pricing on the order or cart. - /// public int? ProductQuantity { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedLineItemShippingDiscount.cs b/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedLineItemShippingDiscount.cs old mode 100644 new mode 100755 index 418a5da4..32583b23 --- a/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedLineItemShippingDiscount.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Discounts/AppliedLineItemShippingDiscount.cs @@ -19,23 +19,20 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Discounts public class AppliedLineItemShippingDiscount { /// - ///Name of the discount added and applied to a shopping cart and order for a shopper's purchase. + ///This describes shipping discounts that apply to a line item in the order, if any. /// public AppliedDiscount Discount { get; set; } /// - ///The number of the line items that are used for this particular discount. + ///The number of the line item that is used for this particular discount. /// public int DiscountQuantity { get; set; } /// - ///The impact of a discount for each discount quantity. + ///The impact of this discount for each discount quantity. /// public decimal ImpactPerUnit { get; set; } - /// - ///Carrier-supplied, unique code that represents the shipping method service type associated with the shipping discount. - /// public string MethodCode { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Discounts/Discount.cs b/Mozu.Api/Contracts/CommerceRuntime/Discounts/Discount.cs old mode 100644 new mode 100755 index 7e1308d7..47b2bfd2 --- a/Mozu.Api/Contracts/CommerceRuntime/Discounts/Discount.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Discounts/Discount.cs @@ -19,24 +19,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Discounts /// public class Discount { - /// - ///Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only. - /// public DateTime? ExpirationDate { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///List of cart or order items to which the discount applies, if applicable. - /// public List ItemIds { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Discounts/InvalidCoupon.cs b/Mozu.Api/Contracts/CommerceRuntime/Discounts/InvalidCoupon.cs old mode 100644 new mode 100755 index fb5fb8c6..1d9f789a --- a/Mozu.Api/Contracts/CommerceRuntime/Discounts/InvalidCoupon.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Discounts/InvalidCoupon.cs @@ -25,18 +25,15 @@ public class InvalidCoupon /// public DateTime CreateDate { get; set; } - /// - ///The unique identifier of the discount. - /// public int DiscountId { get; set; } /// - ///The reason description for an action, including item return, coupon not valid, and item is taxed. + ///The reason the coupon was determined to be invalid. /// public string Reason { get; set; } /// - ///A code indicating the reason why a facet is invalid. + ///The code that identifies the reason the coupon code is invalid. /// public int ReasonCode { get; set; } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Discounts/ShippingDiscount.cs b/Mozu.Api/Contracts/CommerceRuntime/Discounts/ShippingDiscount.cs old mode 100644 new mode 100755 index 06150a15..65c33bba --- a/Mozu.Api/Contracts/CommerceRuntime/Discounts/ShippingDiscount.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Discounts/ShippingDiscount.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Discounts /// public class ShippingDiscount { - /// - ///Name of the discount added and applied to a shopping cart and order for a shopper's purchase. - /// public AppliedDiscount Discount { get; set; } - /// - ///Carrier-supplied, unique code that represents the shipping method service type associated with the shipping discount. - /// public string MethodCode { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Discounts/SuggestedDiscount.cs b/Mozu.Api/Contracts/CommerceRuntime/Discounts/SuggestedDiscount.cs new file mode 100755 index 00000000..d79c4921 --- /dev/null +++ b/Mozu.Api/Contracts/CommerceRuntime/Discounts/SuggestedDiscount.cs @@ -0,0 +1,26 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.CommerceRuntime.Discounts +{ + public class SuggestedDiscount + { + public bool AutoAdd { get; set; } + + public int DiscountId { get; set; } + + public string ProductCode { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Destination.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Destination.cs new file mode 100755 index 00000000..850f1c77 --- /dev/null +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Destination.cs @@ -0,0 +1,27 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + +using Mozu.Api.Contracts.Core; + +namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment +{ + public class Destination + { + public Contact DestinationContact { get; set; } + + public string Id { get; set; } + + public bool? IsDestinationCommercial { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/DigitalPackage.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/DigitalPackage.cs old mode 100644 new mode 100755 index cc33aeb2..9a02f04f --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/DigitalPackage.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/DigitalPackage.cs @@ -22,17 +22,17 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment public class DigitalPackage { /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. + ///Audit info contains the basic audit information about the digital item. /// public AuditInfo AuditInfo { get; set; } /// - ///Available actions you can complete for an order. These actions may differ depending on the status of the order, such as actions required to enter a payment, return of a package, and fulfillment of a shipment. + ///Available actions are actions that you can take on this fulfillment unit. /// public List AvailableActions { get; set; } /// - ///Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only. + ///Change messages handle message related to changes with the fulfillment unit. /// public List ChangeMessages { get; set; } @@ -42,27 +42,27 @@ public class DigitalPackage public string Code { get; set; } /// - ///Date and time when a shipment completes fulfillment by delivery to a customer's physical address, picked up by a customer at a store, or delivered digitally for downloadable products. + ///The digital fulfillment date is the date of the pickup. /// public DateTime? FulfillmentDate { get; set; } /// - ///The code that identifies the location used to fulfill the cart/cart item or order/order item. This code can include physical store locations for in-store pickup, warehouse locations providing the products for shipment, or the location for the digital file(s). + ///The digital package location code is for the location from which to obtain this item. /// public string FulfillmentLocationCode { get; set; } /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: + ///The digital package ID is the ID of the fulfillment unit. /// public string Id { get; set; } /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. + ///The digital package list is a list of items in the fulfillment unit. /// public List Items { get; set; } /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". + ///This is the status of the fulfillment unit. /// public string Status { get; set; } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/DigitalPackageItem.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/DigitalPackageItem.cs old mode 100644 new mode 100755 index 27cd8547..9f8611f5 --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/DigitalPackageItem.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/DigitalPackageItem.cs @@ -25,23 +25,17 @@ public class DigitalPackageItem /// public string GiftCardCode { get; set; } - /// - ///The line id associated with the fulfillment. - /// public int? LineId { get; set; } - /// - ///Fully qualified name of the selected option's attribute. Bundledproducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When `optionAttributeFQN `is null, the bundled item was statically defined. When not null, the item came from an extra selection. - /// public string OptionAttributeFQN { get; set; } /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. + ///The product code is the code of the digital product to be fulfilled. /// public string ProductCode { get; set; } /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. + ///This specifies the quantity of the digital order item. /// public int Quantity { get; set; } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/FulfillmentAction.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/FulfillmentAction.cs old mode 100644 new mode 100755 index 13a8266e..09a88bc5 --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/FulfillmentAction.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/FulfillmentAction.cs @@ -19,9 +19,6 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment /// public class FulfillmentAction { - /// - ///The name of the action to perform for the payment, fulfillment, order, or return. - /// public string ActionName { get; set; } /// @@ -29,14 +26,8 @@ public class FulfillmentAction /// public List DigitalPackageIds { get; set; } - /// - ///Array list of unique IDs of packages in a shipment planned for or finished a shipping fulfillment action. - /// public List PackageIds { get; set; } - /// - ///Array list of in-store pickups for which to perform the fulfillment action. - /// public List PickupIds { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/FulfillmentInfo.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/FulfillmentInfo.cs old mode 100644 new mode 100755 index c8ad667a..0540b7a2 --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/FulfillmentInfo.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/FulfillmentInfo.cs @@ -20,34 +20,16 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment /// public class FulfillmentInfo { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Custom data originated by the shipping service. - /// public JObject Data { get; set; } - /// - ///The contact information of the person receiving the shipment or performing the pickup. - /// public Contact FulfillmentContact { get; set; } - /// - ///If true, the shipping destination for a shipment is a commercial address. - /// public bool? IsDestinationCommercial { get; set; } - /// - ///The code associated with a carrier's shipping method service type, used during fulfillment of packages and shipments. Service type codes include a prefix that indicates the carrier. For example: FEDEX_INTERNATIONAL_STANDARD and UPS_GROUND.If using a custom rate, this property corresponds to the field in when you navigate to > > , and then click on an existing rate or on . - /// public string ShippingMethodCode { get; set; } - /// - ///The carrier-supplied name for the shipping service type, such as "UPS Ground" or "2nd Day Air".If using a custom rate, this property corresponds to the field in when you navigate to > > , and then click on an existing rate or on . - /// public string ShippingMethodName { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Package.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Package.cs old mode 100644 new mode 100755 index f4d902b9..e3e88ef3 --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Package.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Package.cs @@ -21,18 +21,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment /// public class Package { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Available actions you can complete for an order. These actions may differ depending on the status of the order, such as actions required to enter a payment, return of a package, and fulfillment of a shipment. - /// public List AvailableActions { get; set; } /// - ///Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only. + ///List of change messages associated with the package. /// public List ChangeMessages { get; set; } @@ -41,64 +35,31 @@ public class Package /// public string Code { get; set; } - /// - ///Date and time when a shipment completes fulfillment by delivery to a customer's physical address, picked up by a customer at a store, or delivered digitally for downloadable products. - /// public DateTime? FulfillmentDate { get; set; } /// - ///The code that identifies the location used to fulfill the cart/cart item or order/order item. This code can include physical store locations for in-store pickup, warehouse locations providing the products for shipment, or the location for the digital file(s). + ///The location code that represents the location from which this package will ship. /// public string FulfillmentLocationCode { get; set; } - /// - ///If there is a shipping label present for this Package, this will be set to true - /// public bool HasLabel { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///Dimensional properties (height, length, and width) of packages, products and bundles. - /// public PackageMeasurements Measurements { get; set; } - /// - ///The package type associated with this physical package. Possible values include , , , , , , or . - /// public string PackagingType { get; set; } - /// - ///The read-only, system-generated ID of the shipment associated with the shipment. When a package is first created, it is not associated with a shipment. However, once the [CreatePackageShipments](https://www.mozu.com/docs/api/commerce/orders/operations/createpackageshipments.htm) operation runs, it creates a shipment for the package (and any other packages that are part of the shipment) and generates shipping labels. - /// public string ShipmentId { get; set; } - /// - ///The code associated with a carrier's shipping method service type, used during fulfillment of packages and shipments. Service type codes include a prefix that indicates the carrier. For example: FEDEX_INTERNATIONAL_STANDARD and UPS_GROUND.If using a custom rate, this property corresponds to the field in when you navigate to > > , and then click on an existing rate or on . - /// public string ShippingMethodCode { get; set; } - /// - ///The carrier-supplied name for the shipping service type, such as "UPS Ground" or "2nd Day Air".If using a custom rate, this property corresponds to the field in when you navigate to > > , and then click on an existing rate or on . - /// public string ShippingMethodName { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// public string Status { get; set; } - /// - ///Tracking number for the package or shipment, supplied by the shipping carrier to track the shipment until fulfillment completes. The tracking number format may differ between carriers. - /// public string TrackingNumber { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/PackageItem.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/PackageItem.cs old mode 100644 new mode 100755 index 52d27ebd..f306e685 --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/PackageItem.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/PackageItem.cs @@ -19,18 +19,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment public class PackageItem { /// - ///This specifies the fulfillment type of digital package item. + ///This specifies the type of fulfillment item. /// public string FulfillmentItemType { get; set; } - /// - ///The line id associated with the fulfillment. - /// public int? LineId { get; set; } - /// - ///Fully qualified name of the selected option's attribute. Bundledproducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When `optionAttributeFQN `is null, the bundled item was statically defined. When not null, the item came from an extra selection. - /// public string OptionAttributeFQN { get; set; } /// @@ -38,9 +32,6 @@ public class PackageItem /// public string ProductCode { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int Quantity { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Pickup.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Pickup.cs old mode 100644 new mode 100755 index b30299a2..da0b8ccf --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Pickup.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Pickup.cs @@ -21,18 +21,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment /// public class Pickup { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Available actions you can complete for an order. These actions may differ depending on the status of the order, such as actions required to enter a payment, return of a package, and fulfillment of a shipment. - /// public List AvailableActions { get; set; } /// - ///Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only. + ///List of change messages associated with the pickup. /// public List ChangeMessages { get; set; } @@ -41,29 +35,17 @@ public class Pickup /// public string Code { get; set; } - /// - ///Date and time when a shipment completes fulfillment by delivery to a customer's physical address, picked up by a customer at a store, or delivered digitally for downloadable products. - /// public DateTime? FulfillmentDate { get; set; } /// - ///The code that identifies the location used to fulfill the cart/cart item or order/order item. This code can include physical store locations for in-store pickup, warehouse locations providing the products for shipment, or the location for the digital file(s). + ///The location code that represents the location where the shopper will fulfill this pickup. /// public string FulfillmentLocationCode { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// public string Status { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/PickupItem.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/PickupItem.cs old mode 100644 new mode 100755 index 0eebcde7..72452774 --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/PickupItem.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/PickupItem.cs @@ -19,18 +19,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment public class PickupItem { /// - ///This specifies the fulfillment type of digital package item. + ///This specifies the type of fulfillment item. /// public string FulfillmentItemType { get; set; } - /// - ///The line id associated with the fulfillment. - /// public int? LineId { get; set; } - /// - ///Fully qualified name of the selected option's attribute. Bundledproducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When `optionAttributeFQN `is null, the bundled item was statically defined. When not null, the item came from an extra selection. - /// public string OptionAttributeFQN { get; set; } /// @@ -38,9 +32,6 @@ public class PickupItem /// public string ProductCode { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int Quantity { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Shipment.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Shipment.cs old mode 100644 new mode 100755 index d634decc..7c4897cb --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Shipment.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/Shipment.cs @@ -20,54 +20,24 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment /// public class Shipment { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Total cost of shipping the shipment to the shopper. - /// public decimal? Cost { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///The physical address orders are sent to as a shipping destination. This address may contain multiple lines, city, state/province, country, and zip/postal code. The destination is used to calculate shipping costs. - /// public Contact DestinationAddress { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The physical address from which the order or shipment will ship. - /// public Contact OriginAddress { get; set; } - /// - ///Array list of unique IDs of packages in a shipment planned for or finished a shipping fulfillment action. - /// public List PackageIds { get; set; } - /// - ///The code associated with a carrier's shipping method service type, used during fulfillment of packages and shipments. Service type codes include a prefix that indicates the carrier. For example: FEDEX_INTERNATIONAL_STANDARD and UPS_GROUND.If using a custom rate, this property corresponds to the field in when you navigate to > > , and then click on an existing rate or on . - /// public string ShippingMethodCode { get; set; } - /// - ///If true, a shopper signature is required to deliver this shipment. - /// public bool? SignatureRequired { get; set; } - /// - ///Tracking number for the package or shipment, supplied by the shipping carrier to track the shipment until fulfillment completes. The tracking number format may differ between carriers. - /// public string TrackingNumber { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/ShippingRate.cs b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/ShippingRate.cs old mode 100644 new mode 100755 index 1167d4eb..353bf962 --- a/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/ShippingRate.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Fulfillment/ShippingRate.cs @@ -21,44 +21,20 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Fulfillment /// public class ShippingRate { - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///Custom data returned by the shipping service. - /// public JObject Data { get; set; } - /// - ///Indicates if the facet is currently valid. - /// public bool? IsValid { get; set; } - /// - ///Array list of validation and status messages associated with shipping rates, orders, and product purchasable state. - /// public List Messages { get; set; } - /// - ///The amount the company and the shopper pay for shipping based on the current rate. Depending on any company discounts or fees, the price the company pays for shipping may differ from what the shopper pays. - /// public decimal? Price { get; set; } - /// - ///The code associated with a carrier's shipping method service type, used during fulfillment of packages and shipments. Service type codes include a prefix that indicates the carrier. For example: FEDEX_INTERNATIONAL_STANDARD and UPS_GROUND.If using a custom rate, this property corresponds to the field in when you navigate to > > , and then click on an existing rate or on . - /// public string ShippingMethodCode { get; set; } - /// - ///The carrier-supplied name for the shipping service type, such as "UPS Ground" or "2nd Day Air".If using a custom rate, this property corresponds to the field in when you navigate to > > , and then click on an existing rate or on . - /// public string ShippingMethodName { get; set; } - /// - ///The shipping zone to which this rate applies. - /// public string ShippingZoneCode { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/DigitalWallet.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/DigitalWallet.cs old mode 100644 new mode 100755 index 997945f3..70eca6f8 --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/DigitalWallet.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/DigitalWallet.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders { - /// - /// Mozu.CommerceRuntime.Contracts.Orders.DigitalWallet ApiType DOCUMENT_HERE - /// public class DigitalWallet { - /// - ///ID of the cart being used to create the order. - /// public string CartId { get; set; } - /// - ///Digital wallet data. - /// public string DigitalWalletData { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/Order.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/Order.cs old mode 100644 new mode 100755 index 0927505b..b5559e5e --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/Order.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/Order.cs @@ -32,13 +32,10 @@ public class Order public DateTime? AcceptedDate { get; set; } /// - ///Indicates if the customer account is opted to receive marketing materials. If true, the customer account is opted in for receiving the content. + ///If true, the customer account associated with the order is opted in to receive marketing materials. /// public bool? AcceptsMarketing { get; set; } - /// - ///Properties of an ad-hoc price adjustment for an order. - /// public Adjustment Adjustment { get; set; } /// @@ -46,9 +43,6 @@ public class Order /// public decimal AmountAvailableForRefund { get; set; } - /// - ///A counter for how much money has been issued in refunds. This calculated field does NOT include refunds issued in returns. - /// public decimal AmountRefunded { get; set; } /// @@ -56,74 +50,32 @@ public class Order /// public decimal AmountRemainingForPayment { get; set; } - /// - ///Collection of attributes that may be paged list or a list, depending on the usage per object and API type. - /// public List Attributes { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Available actions you can complete for an order. These actions may differ depending on the status of the order, such as actions required to enter a payment, return of a package, and fulfillment of a shipment. - /// public List AvailableActions { get; set; } - /// - ///Properties for the customer's billing information associated with an order or specific payment. - /// public BillingInfo BillingInfo { get; set; } - /// - ///Date when the order was cancelled. System-supplied and read-only. - /// public DateTime? CancelledDate { get; set; } - /// - ///Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only. - /// public List ChangeMessages { get; set; } - /// - ///Code that identifies the channel associated with the site for the shopper's created shopping cart, order, and return. - /// public string ChannelCode { get; set; } - /// - ///Date when the order was closed. Closed order is an order that has been processed and the items shipped. System-supplied and read-only. - /// public DateTime? ClosedDate { get; set; } - /// - ///Array list of coupon codes associated with a shopping cart and the associated order. These codes are entered by a shopper when proceeding to checkout. - /// public List CouponCodes { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///Unique identifer of the customer account. This ID is used to associate numerous types of data and object with the customer account, including orders, returns, wish lists, and in-store credit. - /// public int? CustomerAccountId { get; set; } - /// - ///The type of customer interaction used to create this shopping cart. Possible values are Website, Call, Store, or Unknown. - /// public string CustomerInteractionType { get; set; } - /// - ///The tax identification number (TIN) of the customer who submitted the order. If the customer who submitted the order has a customer account defined for the tenant, the system sets this value when the order is submitted. - /// public string CustomerTaxId { get; set; } - /// - ///Custom data for a given vendor set within the commerce process. - /// public JObject Data { get; set; } /// @@ -131,89 +83,41 @@ public class Order /// public List DigitalPackages { get; set; } - /// - ///The aggregate total for all items in the cart, including costs associated with shopper-defined options or extras and any applied discounts. - /// public decimal? DiscountedSubtotal { get; set; } - /// - ///The subtotal of the cart, order, and wishlist items, including any applied discount calculations. Wishlist subtotals may change depending on the length of time, available discounts, and stock amounts of products at the time of review by shoppers. - /// public decimal? DiscountedTotal { get; set; } - /// - ///Estimated amount of discounts applied to all items in the carts and orders. System-supplied and read-only. This value will be available at the wish list, cart item, order item, and wish list item level at a later time. - /// public decimal? DiscountTotal { get; set; } - /// - ///Order level duty or tariff amount. Does not take into account duties or tariffs specifically on items on the order - /// public decimal? DutyAmount { get; set; } - /// - ///Duties or tariffs for the Order as well as OrderItems (e.g. if the Order has a $5 duty or tariff for any reason and an OrderItem has a $2 duty or tariff then the value in this property would be $7) - /// public decimal? DutyTotal { get; set; } - /// - ///The email address of the specified user or the email address associated with the specified entity. - /// public string Email { get; set; } - /// - ///Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only. - /// public DateTime? ExpirationDate { get; set; } - /// - ///Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values. - /// public List ExtendedProperties { get; set; } /// - ///Unique identifier used by an external program to identify a order, customer account, or wish list. + ///Unique identifier used by an external program to identify a Mozu order. /// public string ExternalId { get; set; } - /// - ///The monetary sum of all fees incurred in the cart, order, line item in a cart, or line item in an order. This value is not calculated for wish lists at this time. - /// public decimal? FeeTotal { get; set; } - /// - ///Properties of the information required to fulfill the cart, order, or wish list. Shoppers can fulfill ordered items by using in-store pickup or direct shipping. - /// public FulfillmentInfo FulfillmentInfo { get; set; } - /// - ///The current fulfillment status of the order, which is "Fulfilled," "NotFulfilled," or "PartiallyFulfilled." The order is considered fulfilled when all packages are shipped or all pickups are picked up. - /// public string FulfillmentStatus { get; set; } - /// - ///The amount to adjust the order handling fee. - /// public Adjustment HandlingAdjustment { get; set; } - /// - ///The combined price for all handling costs calculated together for shipped orders, not for digital or in-store pickup. This includes all handling costs per the product line items and options, excluding taxes and discounts. - /// public decimal? HandlingAmount { get; set; } - /// - ///The list of historically-applied handling discounts. The active one will have IsExcluded == false - /// public List HandlingDiscounts { get; set; } - /// - ///Handling fees for the Order as well as OrderItems (e.g. if the Order has a $5 handling fee and an OrderItem has a $2 handling fee per item quantity then the value in this property would be $9) - /// public decimal? HandlingSubTotal { get; set; } - /// - ///Calculated total tax amount for handling costs if the cart/order is subject to sales tax. - /// public decimal? HandlingTaxTotal { get; set; } /// @@ -221,34 +125,22 @@ public class Order /// public decimal? HandlingTotal { get; set; } - /// - ///If true, the order has a draft that may include one or more uncommitted changes to the order or its components. - /// public bool? HasDraft { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } /// - ///The date and time an order or wish list is imported into . This is not the date and time it was created in the external application. + ///If the order was imported from an external program, the date and time the order was imported into Mozu. /// public DateTime? ImportDate { get; set; } /// - ///The list of invalid coupons the shopper attempted to enter for the cart or order. These coupons may no longer be valid or incorrectly entered. + ///List of invalid coupon codes the shopper entered for the order. /// public List InvalidCoupons { get; set; } - /// - ///A captured and stored IP address. IP addresses are stored for the origin location of submitted orders and the tenant domain. - /// public string IpAddress { get; set; } - /// - ///If true, this version of the order is a draft that might contain uncommitted changes. - /// public bool? IsDraft { get; set; } /// @@ -256,204 +148,96 @@ public class Order /// public bool IsEligibleForReturns { get; set; } - /// - ///Indicates if this object/data was imported from an outside source such as a data import or synchronization via an app or service. If true, this data was originally imported into and accessible through your store database. Examples of imported objects/data include orders and customer accounts. - /// public bool? IsImport { get; set; } - /// - ///If true, the order is exempt from applied sales tax. - /// + public bool IsPartialOrder { get; set; } + public bool? IsTaxExempt { get; set; } - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The total amount of calculated tax for items, used by carts, orders, and wish lists. - /// public decimal? ItemTaxTotal { get; set; } - /// - ///The date in UTC Date/Time when the items in the cart were last validated against the site's product catalog. System-supplied and read-only. - /// public DateTime? LastValidationDate { get; set; } - /// - ///The total charge for the line item with all weighted order level manual adjustments. - /// public decimal? LineItemSubtotalWithOrderAdjustments { get; set; } - /// - ///The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. - /// public string LocationCode { get; set; } - /// - ///Paged list collection of note content for objects including customers, orders, and returns. - /// public List Notes { get; set; } - /// - ///List of order-level discounts projected to apply to the cart at checkout or order. - /// public List OrderDiscounts { get; set; } - /// - ///The order number that displays on the storefront which differs from the order ID. - /// public int? OrderNumber { get; set; } - /// - ///Identifier of the cart prior to the customer proceeding to checkout. - /// public string OriginalCartId { get; set; } - /// - ///Array list of physical packages shipped for a specified order. - /// public List Packages { get; set; } - /// - ///If this Order has a parent Order, the parent Order ID is recorded here. - /// + public string ParentCheckoutId { get; set; } + + public int? ParentCheckoutNumber { get; set; } + public string ParentOrderId { get; set; } - /// - ///If the Order has a parent Order, the order number is recorded here. - /// public int? ParentOrderNumber { get; set; } - /// - ///If this order was created to fulfill an item replacement as part of a return merchandise authorization (RMA), the unique identifier of the return. - /// public string ParentReturnId { get; set; } - /// - ///If the Order has a parent Order with a return, the return number is recorded here. - /// public int? ParentReturnNumber { get; set; } - /// - ///Wrapper for a collection of payments associated with an order or return. An order can include a number of payments until the full total is covered. - /// + public int? PartialOrderCount { get; set; } + + public int? PartialOrderNumber { get; set; } + public List Payments { get; set; } - /// - ///Status of the payment for the specified order. - /// public string PaymentStatus { get; set; } - /// - ///Array list of the in-store pickups defined for the order. - /// public List Pickups { get; set; } - /// - ///If the order is associated with a price list, this is the unique code of the price list. - /// public string PriceListCode { get; set; } - /// - ///Refunds associated with this order. A refund is a single exchange of money from merchant to customer that either encapsulates a refund to a credit card or an issuance of a store credit. Refunds does not reduce the 'amount collected' on an order and it is possible for refunds to exceed the total order amount. - /// public List Refunds { get; set; } - /// - ///Status of any returns associated with this order after it was completed. - /// public string ReturnStatus { get; set; } - /// - ///Array list of the shipments defined to fulfill items in this order using the direct ship fulfillment method. - /// public List Shipments { get; set; } - /// - ///Properties of an ad-hoc price adjustment made for an order. - /// public Adjustment ShippingAdjustment { get; set; } - /// - ///The total shipping amount for the order before discounts and adjustments. - /// public decimal? ShippingAmountBeforeDiscountsAndAdjustments { get; set; } - /// - ///List of shipping discounts projected to apply to carts, orders, and wish lists and items at checkout. - /// public List ShippingDiscounts { get; set; } - /// - ///The shipping subtotal amount calculated without any applied discounts for line item and entire amounts of carts and orders. This property is not calculated for wish lists at this time. - /// public decimal? ShippingSubTotal { get; set; } - /// - ///The total amount of tax incurred on the shipping charges in the cart and order. This property is not calculated at this time for wish lists. - /// public decimal? ShippingTaxTotal { get; set; } - /// - ///The calculated total shipping amount estimated for carts or orders, including tax. This amount is not calculated for wish lists at this time. - /// public decimal? ShippingTotal { get; set; } - /// - ///A paged list collection of shopper notes for the order. - /// public ShopperNotes ShopperNotes { get; set; } - /// - ///Unique identifier of the site. - /// public int? SiteId { get; set; } - /// - ///The device from which the order originated in the case of offline orders. - /// public string SourceDevice { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// public string Status { get; set; } - /// - ///The date and time the order was submitted. System-supplied and read-only. - /// public DateTime? SubmittedDate { get; set; } - /// - ///Estimated amount of the cart or order without sales tax, shipping costs, and other fees. This amount is not calculated for wish lists at this time. - /// public decimal? Subtotal { get; set; } - /// - ///Leverage this property within a [tax Arc.js action](https://www.mozu.com/docs/arcjs/commerce-catalog-storefront-tax/commerce-catalog-storefront-tax.htm) to supplement the tax information for this item or object with custom JSON data. - /// + public List SuggestedDiscounts { get; set; } + public JObject TaxData { get; set; } - /// - ///The total monetary sum of sales tax estimated for a cart or order. - /// public decimal? TaxTotal { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int? TenantId { get; set; } - /// - ///Total is used to indicate the monetary, estimated total amount of the cart or order, including items, sales tax, shipping costs, and other fees. Totals are not estimated for wish lists at this time. - /// public decimal? Total { get; set; } - /// - ///The total amount collected to date for the order. - /// public decimal TotalCollected { get; set; } /// @@ -466,19 +250,10 @@ public class Order /// public List ValidationResults { get; set; } - /// - ///The current version number of the order, wish list, document list, or document type list. - /// public string Version { get; set; } - /// - ///Unique identifier of the customer visit in which the cart was created or last modified. - /// public string VisitId { get; set; } - /// - ///Unique identifier of the web session in which the cart, order, return, or wish list was created or last modified. - /// public string WebSessionId { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderAction.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderAction.cs old mode 100644 new mode 100755 index 306d99ce..ee92f1a5 --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderAction.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderAction.cs @@ -18,9 +18,6 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders /// public class OrderAction { - /// - ///The name of the action to perform for the payment, fulfillment, order, or return. - /// public string ActionName { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderAttribute.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderAttribute.cs old mode 100644 new mode 100755 index 5e97c465..f94b7541 --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderAttribute.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderAttribute.cs @@ -20,24 +20,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders /// public class OrderAttribute { - /// - ///Unique identifier of the attribute definition. - /// public int? AttributeDefinitionId { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string FullyQualifiedName { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderCollection.cs old mode 100644 new mode 100755 index e614fa7e..ac5db76b --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders /// public class OrderCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderItem.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderItem.cs old mode 100644 new mode 100755 index f5ee243a..1af1adee --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderItem.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderItem.cs @@ -24,229 +24,103 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders /// public class OrderItem { - /// - ///The adjusted subtotal of the line item, including all manual adjustments, discounts, shipping charges and discounts, and duty or any other additional line item fees. - /// public decimal? AdjustedLineItemSubtotal { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Custom data for a given vendor set within the commerce process. - /// + public int? AutoAddDiscountId { get; set; } + public JObject Data { get; set; } - /// - ///The subtotal of the cart, order, and wishlist items, including any applied discount calculations. Wishlist subtotals may change depending on the length of time, available discounts, and stock amounts of products at the time of review by shoppers. - /// + public string DestinationId { get; set; } + public decimal? DiscountedTotal { get; set; } - /// - ///Estimated amount of discounts applied to all items in the carts and orders. System-supplied and read-only. This value will be available at the wish list, cart item, order item, and wish list item level at a later time. - /// public decimal? DiscountTotal { get; set; } - /// - ///Duty or Tariff for this item - /// public decimal? DutyAmount { get; set; } - /// - ///Represents the total price of the cart item extended to the shopper. This begins with the Unit Price, then uses any of the following prices if they are defined, in the following order: Override Amount, Sale Amount, List Amount. This value is not calculated for wish lists at this time. - /// public decimal? ExtendedTotal { get; set; } - /// - ///The monetary sum of all fees incurred in the cart, order, line item in a cart, or line item in an order. This value is not calculated for wish lists at this time. - /// public decimal? FeeTotal { get; set; } - /// - ///The code that identifies the location used to fulfill the cart/cart item or order/order item. This code can include physical store locations for in-store pickup, warehouse locations providing the products for shipment, or the location for the digital file(s). - /// public string FulfillmentLocationCode { get; set; } - /// - ///The method used to fulfill this cart or order item. The method includes direct ship or in-store pickup. The available methods depend on the supported fulfillment types for the product. - /// public string FulfillmentMethod { get; set; } - /// - ///The combined price for all handling costs calculated together for shipped orders, not for digital or in-store pickup. This includes all handling costs per the product line items and options, excluding taxes and discounts. - /// public decimal? HandlingAmount { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. - /// public bool? IsRecurring { get; set; } - /// - ///Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules. - /// public bool? IsTaxable { get; set; } - /// - ///The total amount of calculated tax for items, used by carts, orders, and wish lists. - /// public decimal? ItemTaxTotal { get; set; } - /// - ///The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or in CommerceRuntime when a cart is converted to an order. - /// public int? LineId { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The unique identifier of the item when it was applied to a cart, prior to checkout, when the cart became an order. - /// public string OriginalCartItemId { get; set; } - /// - ///The properties of a product, referenced and used by carts, orders, wish lists, and returns. - /// public Product Product { get; set; } /// - ///The applicable product discount for an associated cart, order, or wish list. + ///The discount that applies to the product. /// public AppliedLineItemProductDiscount ProductDiscount { get; set; } - /// - ///List of product-level discounts projected to apply to a cart, order, or wish list. - /// public List ProductDiscounts { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// + public string PurchaseLocation { get; set; } + public int Quantity { get; set; } - /// - ///The total shipping amount for the line item before discounts and adjustments. - /// public decimal? ShippingAmountBeforeDiscountsAndAdjustments { get; set; } - /// - ///List of shipping discounts projected to apply to carts, orders, and wish lists and items at checkout. - /// public List ShippingDiscounts { get; set; } - /// - ///The total amount of tax incurred on the shipping charges in the cart and order. This property is not calculated at this time for wish lists. - /// public decimal? ShippingTaxTotal { get; set; } - /// - ///The calculated total shipping amount estimated for carts or orders, including tax. This amount is not calculated for wish lists at this time. - /// public decimal? ShippingTotal { get; set; } - /// - ///Estimated amount of the cart or order without sales tax, shipping costs, and other fees. This amount is not calculated for wish lists at this time. - /// public decimal? Subtotal { get; set; } - /// - ///The monetary amount of an item in the cart that is subject to tax. This amount typically represents the line item subtotal before applied discounts for an order. - /// public decimal? TaxableTotal { get; set; } - /// - ///Leverage this property within a [tax Arc.js action](https://www.mozu.com/docs/arcjs/commerce-catalog-storefront-tax/commerce-catalog-storefront-tax.htm) to supplement the tax information for this item or object with custom JSON data. - /// public JObject TaxData { get; set; } - /// - ///Total is used to indicate the monetary, estimated total amount of the cart or order, including items, sales tax, shipping costs, and other fees. Totals are not estimated for wish lists at this time. - /// public decimal? Total { get; set; } - /// - ///The total charge for the line item without any weighted order level shipping and handling charges. - /// public decimal? TotalWithoutWeightedShippingAndHandling { get; set; } - /// - ///The total charge for the line item with all weighted order level shipping and handling charges. - /// public decimal? TotalWithWeightedShippingAndHandling { get; set; } - /// - ///Properties of the price per unit of a product, associated with cart and order items. This price is not used for wish lists at this time. - /// public CommerceUnitPrice UnitPrice { get; set; } - /// - ///The total weighted order level manual adjustment amount. - /// public decimal? WeightedOrderAdjustment { get; set; } - /// - ///The total weighted order level discount amount. - /// public decimal? WeightedOrderDiscount { get; set; } - /// - ///The total weighted order level duty charges. - /// public decimal? WeightedOrderDuty { get; set; } - /// - ///The weighted order handling adjustment. - /// public decimal? WeightedOrderHandlingAdjustment { get; set; } - /// - ///The total weighted order level handling fee amount. - /// public decimal? WeightedOrderHandlingFee { get; set; } - /// - ///The total weighted order handling fee discount amount. - /// public decimal? WeightedOrderHandlingFeeDiscount { get; set; } - /// - ///The total weighted order level handling fee tax amount. - /// public decimal? WeightedOrderHandlingFeeTax { get; set; } - /// - ///The total weighted order level shipping charge. - /// public decimal? WeightedOrderShipping { get; set; } - /// - ///The total weighted order level shipping discount amount. - /// public decimal? WeightedOrderShippingDiscount { get; set; } - /// - ///The total weighted order level shipping manual adjustment amount. - /// public decimal? WeightedOrderShippingManualAdjustment { get; set; } - /// - ///The total weighted order level shipping tax amount. - /// public decimal? WeightedOrderShippingTax { get; set; } - /// - ///The total weighted order level tax amount. - /// public decimal? WeightedOrderTax { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderItemCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderItemCollection.cs old mode 100644 new mode 100755 index 4dced533..3dc8639e --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderItemCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderItemCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders /// public class OrderItemCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderNote.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderNote.cs old mode 100644 new mode 100755 index 455224c0..d15ff7fa --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderNote.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderNote.cs @@ -19,19 +19,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders /// public class OrderNote { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The text content of the order note. - /// public string Text { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderReturnableItem.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderReturnableItem.cs old mode 100644 new mode 100755 index 3c0465ff..87963ba6 --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderReturnableItem.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderReturnableItem.cs @@ -13,84 +13,36 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders { - /// - /// Mozu.CommerceRuntime.Contracts.Orders.OrderReturnableItem ApiType DOCUMENT_HERE - /// public class OrderReturnableItem { - /// - ///Specifies whether to exclude product extras when you return a product or bundle. For example, assume the following order items:* Product A (bundle item)* Product B (bundle item)* Product C (bundle item)* Product D (extra on bundle)* Product F (extra on product)If this property is , Products D or F are included when the bundle or Product E are added to a return. If this property is , Products D or F are not included unless added individually. - /// public bool ExcludeProductExtras { get; set; } - /// - ///The fulfillment status of the item, which is one of the following values:* * - /// public string FulfillmentStatus { get; set; } - /// - ///Unique identifier of the order item associated with a validation message, order, or return. - /// public string OrderItemId { get; set; } - /// - ///The fully-qualified name of an attribute option on the item if it has an extra. For bundle items, this property is null. - /// public string OrderItemOptionAttributeFQN { get; set; } - /// - ///The unique identifier of the line number associated with the item. - /// public int OrderLineId { get; set; } - /// - ///The product code of the parent item, if applicable. For example, a product bundle is the parent of the items in the bundle, and a product is the parent of a product extra. - /// public string ParentProductCode { get; set; } - /// - ///The name of the parent item, if applicable. For example, a product bundle is the parent of the items in the bundle, and a product is the parent of a product extra. - /// public string ParentProductName { get; set; } - /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// public string ProductCode { get; set; } - /// - ///The name of the product that represents a line item in a taxable order or product bundle. - /// public string ProductName { get; set; } - /// - ///The quantity of the item that a shopper or CSR has directly requested for return. For example, if someone requests a return on a product bundle, the bundle is directly returned, but the bundle items are indirectly returned. Conversely, if someone requests a return on a bundle item, the bundle item is directly returned, while the bundle is indirectly returned (in this case, the bundle is only partially returned, unless the other bundle items are also requested for return). - /// public int QuantityDirectlyReturned { get; set; } - /// - ///The quantity that has been fulfilled for the given line item. An item must be fulfilled before it is returnable. If an order contains Product X with a quantity of 3, and the quantity fulfilled is 2, then two Product X items are returnable (assuming all other return conditions are met). - /// public int QuantityFulfilled { get; set; } - /// - ///The quantity of the item that is required for the successful return of another item. For example, if someone requests a return on a product bundle, the bundle is directly returned, but the bundle items are indirectly returned. Conversely, if someone requests a return on a bundle item, the bundle item is directly returned, while the bundle is indirectly returned (in this case, the bundle is only partially returned, unless the other bundle items are also requested for return). - /// public int QuantityIndirectlyReturned { get; set; } - /// - ///The total quantity of an item on the order. - /// public int QuantityOrdered { get; set; } - /// - ///The quantity of a given item that is eligible for return. This number may be smaller than the quantity ordered, and changes depending on the actions taken on the return. For example, if an order contains five of Product X, but only three of those items are fulfilled, then only three items show as returnable (assuming all other return conditions are met). - /// public int QuantityReturnable { get; set; } - /// - ///The number of discrete units that make up an individual item. For example, 1 (ordered quantity) bag of screws may contain a unity quantity of 50 screws. - /// public int UnitQuantity { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderReturnableItemCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderReturnableItemCollection.cs old mode 100644 new mode 100755 index d34866cf..aaa58263 --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderReturnableItemCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderReturnableItemCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders { - /// - /// Mozu.CommerceRuntime.Contracts.Orders.OrderReturnableItemCollection ApiType DOCUMENT_HERE - /// public class OrderReturnableItemCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderValidationMessage.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderValidationMessage.cs old mode 100644 new mode 100755 index 45bfa5ff..f0e63c31 --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderValidationMessage.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderValidationMessage.cs @@ -19,7 +19,7 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders public class OrderValidationMessage { /// - ///The text of the change message, such as "This product is no longer available." System-supplied and read-only. + ///The body of the message returned by the order validation capability. /// public string Message { get; set; } @@ -29,7 +29,7 @@ public class OrderValidationMessage public string MessageType { get; set; } /// - ///Unique identifier of the order item associated with a validation message, order, or return. + ///Unique identifier of the order item associated with the validation message. /// public string OrderItemId { get; set; } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderValidationResult.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderValidationResult.cs old mode 100644 new mode 100755 index 43b6d81a..21b1d48c --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderValidationResult.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/OrderValidationResult.cs @@ -25,12 +25,12 @@ public class OrderValidationResult public DateTime? CreatedDate { get; set; } /// - ///Array list of validation and status messages associated with shipping rates, orders, and product purchasable state. + ///Collection of messages returned by the order validation capability. /// public List Messages { get; set; } /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". + ///The status returned from the order validation capability for the order specified in the request, which is Pass, Fail, Error, or Review. /// public string Status { get; set; } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Orders/ShopperNotes.cs b/Mozu.Api/Contracts/CommerceRuntime/Orders/ShopperNotes.cs old mode 100644 new mode 100755 index 832c09ee..63a4b5bf --- a/Mozu.Api/Contracts/CommerceRuntime/Orders/ShopperNotes.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Orders/ShopperNotes.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Orders /// public class ShopperNotes { - /// - ///Notes entered and saved with an order. These notes may be entered by a shopper on a wishlist or for an order. Comments may also be entered by Admins on an order that may be visible only to authorized shoppers and users. - /// public string Comments { get; set; } - /// - ///Shopper-entered gift message for the associated order. - /// public string GiftMessage { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/BillingInfo.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/BillingInfo.cs old mode 100644 new mode 100755 index 9ad45487..68e86cb9 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/BillingInfo.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/BillingInfo.cs @@ -20,54 +20,26 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments /// public class BillingInfo { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The cardholder's billing contact information, including addresses. - /// public Contact BillingContact { get; set; } - /// - ///If the customer is paying by card, the credit card information. - /// public PaymentCard Card { get; set; } - /// - ///Information about the check used in the billing information, if it exists. - /// public CheckPayment Check { get; set; } - /// - ///Custom data originated by the billing service. - /// + public string CustomCreditType { get; set; } + public JObject Data { get; set; } - /// - ///Holds the transaction ID for an external payment type service. - /// public string ExternalTransactionId { get; set; } - /// - ///If true, the system overrides the customer's billing address information with the supplied fulfillment information. - /// public bool IsSameBillingShippingAddress { get; set; } - /// - ///The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases. - /// public string PaymentType { get; set; } - /// - ///Identifies a specific workflow the payment goes through. This is used to define a workflow for external payment services. - /// public string PaymentWorkflow { get; set; } - /// - ///The purchase order payment details. - /// public PurchaseOrderPayment PurchaseOrder { get; set; } /// @@ -75,6 +47,8 @@ public class BillingInfo /// public string StoreCreditCode { get; set; } + public string StoreCreditType { get; set; } + } } \ No newline at end of file diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/CheckPayment.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/CheckPayment.cs old mode 100644 new mode 100755 index 5a7bbe21..4a937562 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/CheckPayment.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/CheckPayment.cs @@ -13,14 +13,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments { - /// - /// Mozu.CommerceRuntime.Contracts.Payments.CheckPayment ApiType DOCUMENT_HERE - /// public class CheckPayment { - /// - ///If applicable, the check number associated with the payment action or interaction. - /// public string CheckNumber { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/Payment.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/Payment.cs old mode 100644 new mode 100755 index ac534f12..681b7a0c --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/Payment.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/Payment.cs @@ -22,14 +22,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments /// public class Payment { - /// - ///The total monetary amount collected in this payment transaction for the order. - /// public decimal AmountCollected { get; set; } - /// - ///If the payment transaction is a shopper store credit, the total monetary amount credited in this payment transaction for the order. - /// public decimal AmountCredited { get; set; } /// @@ -37,74 +31,35 @@ public class Payment /// public decimal AmountRequested { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Available actions you can complete for an order. These actions may differ depending on the status of the order, such as actions required to enter a payment, return of a package, and fulfillment of a shipment. - /// public List AvailableActions { get; set; } - /// - ///Properties for the customer's billing information associated with an order or specific payment. - /// public BillingInfo BillingInfo { get; set; } /// - ///Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only. + ///List of change messages associated with the payment. /// public List ChangeMessages { get; set; } - /// - ///Custom data originated by the payment service. - /// public JObject Data { get; set; } - /// - ///The external/third party transaction Id for this payment. This is used to store the transaction Id from digital wallet like Visa Checkout - /// public string ExternalTransactionId { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Container for the interactions associated with the payment, which includes details for each action performed for the payment. - /// public List Interactions { get; set; } - /// - ///Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. - /// public bool IsRecurring { get; set; } - /// - ///Unique identifier of the order associated with the payment. - /// public string OrderId { get; set; } - /// - ///The transaction ID supplied by the payment service to associate with this order payment. - /// public string PaymentServiceTransactionId { get; set; } - /// - ///The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases. - /// public string PaymentType { get; set; } - /// - ///The source of data for this payment. By default, this will be set to 'mozu' - /// public string PaymentWorkflow { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// public string Status { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentAction.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentAction.cs old mode 100644 new mode 100755 index 6975afc9..732cc1e8 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentAction.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentAction.cs @@ -20,64 +20,28 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments /// public class PaymentAction { - /// - ///The name of the action to perform for the payment, fulfillment, order, or return. - /// public string ActionName { get; set; } - /// - ///The total monetary amount of the payment transaction. - /// public decimal? Amount { get; set; } - /// - ///The URL provided to cancel payments submitted using PayPal Express or another non-gateway payment provider. - /// public string CancelUrl { get; set; } - /// - ///If applicable, the check number associated with the payment action or interaction. - /// public string CheckNumber { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///A general field for data to be communicated from an external payment service. - /// public JObject Data { get; set; } - /// - ///An ID provided by a third party external payment service to identify a transaction. - /// public string ExternalTransactionId { get; set; } - /// - ///Date and time of a payment interaction, including handling and processing a payment and validating and completing a payment with a payment gateway. - /// public DateTime? InteractionDate { get; set; } - /// - ///Properties of a manually performed interaction with the payment gateway. - /// public PaymentGatewayInteraction ManualGatewayInteraction { get; set; } - /// - ///The billing information associated with this payment action. - /// public BillingInfo NewBillingInfo { get; set; } - /// - ///Unique ID that references an original transaction in the event of a credit back. - /// public string ReferenceSourcePaymentId { get; set; } - /// - ///The URL provided to redirect users who submit payments using PayPal Express or another non-gateway payment provider. - /// public string ReturnUrl { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentCard.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentCard.cs old mode 100644 new mode 100755 index b907d592..6253be0e --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentCard.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentCard.cs @@ -18,44 +18,22 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments /// public class PaymentCard { - /// - ///The masked credit card number part returned from the payment gateway. - /// + public string Bin { get; set; } + public string CardNumberPartOrMask { get; set; } - /// - ///The two-digit month a credit card expires for a payment method. - /// public short ExpireMonth { get; set; } - /// - ///The four-digit year the credit card expires for a payment method. - /// public short ExpireYear { get; set; } - /// - ///If true, the credit card information is saved to the customer account for future use. - /// public bool IsCardInfoSaved { get; set; } - /// - ///If true, the credit card is used for a recurring order payment. - /// public bool? IsUsedRecurring { get; set; } - /// - ///The full name printed on a credit card. The name should match what is printed on the card exactly, used in validation during a payment. - /// public string NameOnCard { get; set; } - /// - ///The type of credit card, such as Visa or Amex. - /// public string PaymentOrCardType { get; set; } - /// - ///Unique identifier of the credit card from the payment service. - /// public string PaymentServiceCardId { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentCollection.cs old mode 100644 new mode 100755 index e05739f3..6c2cc122 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments /// public class PaymentCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentGatewayInteraction.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentGatewayInteraction.cs old mode 100644 new mode 100755 index 4b547049..d39fd355 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentGatewayInteraction.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentGatewayInteraction.cs @@ -18,39 +18,21 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments /// public class PaymentGatewayInteraction { - /// - ///If required by the payment gateway, the authorization code of the transaction. - /// public string GatewayAuthCode { get; set; } - /// - ///AVS (Address Verification Service) codes supplied by the payment gateway. The codes indicate partial to complete or failed matches against the billing address for the shopper against the financial institute data through the gateway. - /// public string GatewayAVSCodes { get; set; } - /// - ///CVV2 (Card Verification Value) codes supplied by the payment gateway. The codes indicate a verified or failed match of the encrypted code entered against the financial institution data through the gateway. - /// public string GatewayCVV2Codes { get; set; } - /// - ///Unique identifier of the payment interaction from the payment gateway. - /// public int? GatewayInteractionId { get; set; } - /// - ///Response code from the gateway associated with the payment interaction. The response code is unique to the gateway.The response code is associated with the , which contains the textual response message.Refer to [Gateway Response Code and Text](https://www.mozu.com/docs/developer/api-guides/payment-gateways.htm#gateway_response_code_and_text) in the API Guides for more information. - /// public string GatewayResponseCode { get; set; } /// - ///Textual message returned by the payment gateway for the associated .Refer to [Gateway Response Code and Text](https://www.mozu.com/docs/developer/api-guides/payment-gateways.htm#gateway_response_code_and_text) in the API Guides for more information. + ///Textual message returned by the payment gateway. /// public string GatewayResponseText { get; set; } - /// - ///Unique identifier of the gateway transaction associated with the payment interaction. - /// public string GatewayTransactionId { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentGatewayResponseData.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentGatewayResponseData.cs old mode 100644 new mode 100755 index ee7c9a12..096ba750 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentGatewayResponseData.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentGatewayResponseData.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments { - /// - /// The raw payment response from the gateway.This is a list of key value pairs. - /// public class PaymentGatewayResponseData { - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentInteraction.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentInteraction.cs old mode 100644 new mode 100755 index d1ea061a..e3a43c10 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentInteraction.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/PaymentInteraction.cs @@ -20,129 +20,57 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments /// public class PaymentInteraction { - /// - ///If applicable, the total monetary amount associated with this payment interaction. - /// public decimal? Amount { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///If applicable, the check number associated with the payment action or interaction. - /// public string CheckNumber { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///If required by the payment gateway, the authorization code of the transaction. - /// public string GatewayAuthCode { get; set; } - /// - ///AVS (Address Verification Service) codes supplied by the payment gateway. The codes indicate partial to complete or failed matches against the billing address for the shopper against the financial institute data through the gateway. - /// public string GatewayAVSCodes { get; set; } - /// - ///CVV2 (Card Verification Value) codes supplied by the payment gateway. The codes indicate a verified or failed match of the encrypted code entered against the financial institution data through the gateway. - /// public string GatewayCVV2Codes { get; set; } - /// - ///Unique identifier of the payment interaction from the payment gateway. - /// public int? GatewayInteractionId { get; set; } - /// - ///Response code from the gateway associated with the payment interaction. The response code is unique to the gateway.The response code is associated with the , which contains the textual response message.Refer to [Gateway Response Code and Text](https://www.mozu.com/docs/developer/api-guides/payment-gateways.htm#gateway_response_code_and_text) in the API Guides for more information. - /// public string GatewayResponseCode { get; set; } - /// - ///Additional response data from the gateway that's unique to each gateway.This is a list of key value pairs.Refer to [Gateway Response Data](https://www.mozu.com/docs/developer/api-guides/payment-gateways.htm#gateway_response_data) in the API Guides for more information. - /// public List GatewayResponseData { get; set; } /// - ///Textual message returned by the payment gateway for the associated .Refer to [Gateway Response Code and Text](https://www.mozu.com/docs/developer/api-guides/payment-gateways.htm#gateway_response_code_and_text) in the API Guides for more information. + ///Textual message returned by the payment gateway. /// public string GatewayResponseText { get; set; } - /// - ///Unique identifier of the gateway transaction associated with the payment interaction. - /// public string GatewayTransactionId { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Date and time of a payment interaction, including handling and processing a payment and validating and completing a payment with a payment gateway. - /// public DateTime? InteractionDate { get; set; } - /// - ///The type of payment interaction. The payment can be Capture or CheckReceived. The value also includes customer payment interactions such as Website, Call, Store, or Unknown. - /// public string InteractionType { get; set; } - /// - ///If true, the payment interaction was manually defined s part of offline order processing. - /// public bool IsManual { get; set; } - /// - ///Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. - /// public bool? IsRecurring { get; set; } - /// - ///User-entered notation content for an object, used to save information such as payment, return, account, and order notes. - /// public string Note { get; set; } - /// - ///Unique identifier of the order associated with the payment. - /// public string OrderId { get; set; } - /// - ///The status of the payment prior to the interaction being performed, which enables manual rollback of previous transactions. - /// public string PaymentEntryStatus { get; set; } - /// - ///Unique identifier of the payment associated with this transaction. - /// public string PaymentId { get; set; } - /// - ///Unique identifier of previous interaction that this payment interaction is modifying. For example, when refunding a payment, the crediting interaction would reference the capture interaction. - /// public int? PaymentTransactionInteractionIdReference { get; set; } - /// - ///The unique identifier of the refund for a given interaction. - /// public string RefundId { get; set; } - /// - ///The unique identifier of the return associated with a given interaction. - /// public string ReturnId { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// public string Status { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderCustomField.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderCustomField.cs old mode 100644 new mode 100755 index ed417a53..29841be2 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderCustomField.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderCustomField.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments { - /// - /// The details of the custom fields associated with the purchase order payment.Refer to [Custom Text Fields](https://www.mozu.com/docs/guides/orders/purchase-order.htm#custom_text_fields) in the Purchase Orders guides topic for more information. - /// public class PurchaseOrderCustomField { - /// - ///The code for the custom field associated with the purchase order.Refer to [Custom Text Fields](https://www.mozu.com/docs/guides/orders/purchase-order.htm#custom_text_fields) in the Purchase Order guides topic for more information. - /// public string Code { get; set; } - /// - ///Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. - /// public string Label { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderPayment.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderPayment.cs old mode 100644 new mode 100755 index e3e8a479..ed2b3713 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderPayment.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderPayment.cs @@ -14,24 +14,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments { - /// - /// The details of the purchase order payment. - /// public class PurchaseOrderPayment { - /// - ///Details of the custom text fields associated with the purchase order.Refer to [Custom Text Fields](https://www.mozu.com/docs/guides/orders/purchase-order.htm#custom_text_fields) in the Purchase Order guides topic for more information. - /// public List CustomFields { get; set; } - /// - ///The details of the payment terms. The payment terms are made up of a and a .Refer to [Payment Terms](https://www.mozu.com/docs/guides/orders/purchase-order.htm#payment_terms) in the Purchase Order guides topic for more information. - /// public PurchaseOrderPaymentTerm PaymentTerm { get; set; } - /// - ///The purchase order number. - /// public string PurchaseOrderNumber { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderPaymentTerm.cs b/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderPaymentTerm.cs old mode 100644 new mode 100755 index 29e7e305..95f8d1d5 --- a/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderPaymentTerm.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Payments/PurchaseOrderPaymentTerm.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Payments { - /// - /// The details of the payment terms assocaited with the purchase order payment.Refer to [Payment Terms](https://www.mozu.com/docs/guides/orders/purchase-order.htm#payment_terms) in the Purchase Orders guides topic for more information. - /// public class PurchaseOrderPaymentTerm { - /// - ///The payment term code associated with the purchase order.Refer to [Payment Terms](https://www.mozu.com/docs/guides/orders/purchase-order.htm#payment_terms) in the Purchase Order guides topic for more information. - /// public string Code { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Products/BundledProduct.cs b/Mozu.Api/Contracts/CommerceRuntime/Products/BundledProduct.cs old mode 100644 new mode 100755 index 374a8614..a0bab097 --- a/Mozu.Api/Contracts/CommerceRuntime/Products/BundledProduct.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Products/BundledProduct.cs @@ -15,47 +15,35 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Products { /// - /// Properties of a component product in a product bundle. A product bundle can represent either a collection of multiple products sold as a single entity, or a collection of the same product sold as a package. For example, a 10-pack of socks or multiple parts and devices in a technology bundle for a computer. + /// Properties of a component product in a product bundle. A product bundle can represent either a collection of multiple products sold as a single entity, or a collection of the same product sold as a package. For example, a 10-pack of socks. /// public class BundledProduct { - /// - ///Allocation ID associated with this product on this order. - /// public DateTime? AllocationExpiration { get; set; } - /// - ///Allocation ID associated with this product on this order. - /// public int? AllocationId { get; set; } /// - ///The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. + ///The credit value of the bundled product. /// public decimal? CreditValue { get; set; } - /// - ///If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".Refer to [Product Variant Pricing and Weight](../../../guides/catalog/products.htm#product_variant_pricing_and_weight) in the Products guides topic for more information. - /// public decimal? DeltaPrice { get; set; } /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. + ///The description defined for a component product in a product bundle. System-supplied and read only. /// public string Description { get; set; } - /// - ///Fulfillment status of the product. - /// public string FulfillmentStatus { get; set; } /// - ///The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit. + ///The type of goods in a bundled product. For example: physical, digital, or digital credit. /// public string GoodsType { get; set; } /// - ///Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself. + ///If true, this product cannot be shipped in a package with other items and must ship in a package by itself. /// public bool IsPackagedStandAlone { get; set; } @@ -65,7 +53,7 @@ public class BundledProduct public PackageMeasurements Measurements { get; set; } /// - ///The user supplied name that appears in . You can use this field for identification purposes. + ///The name of a component product in a product bundle. System-supplied and read only. /// public string Name { get; set; } @@ -75,7 +63,7 @@ public class BundledProduct public string OptionAttributeFQN { get; set; } /// - ///The value of the option attribute. These values are associated and used by product bundles and options. + ///The value of the bundled product. /// public object OptionValue { get; set; } @@ -85,12 +73,12 @@ public class BundledProduct public string ProductCode { get; set; } /// - ///Unique identifier of the product reservation associated with the component product in a product bundle or item in a cart/order. System-supplied and read only. + ///Unique identifier of the product reservation associated with the component product in a product bundle. System-supplied and read only. /// public int? ProductReservationId { get; set; } /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. + ///The quantity of a component product in its product bundle. System-supplied and read only. /// public int Quantity { get; set; } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Products/Category.cs b/Mozu.Api/Contracts/CommerceRuntime/Products/Category.cs old mode 100644 new mode 100755 index d37dd9b8..ec456520 --- a/Mozu.Api/Contracts/CommerceRuntime/Products/Category.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Products/Category.cs @@ -14,18 +14,12 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Products { /// - /// The category associated with assigned products. Products, product bundles, and options can be classified to multiple categories. + /// The category into which products are classified. /// public class Category { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///If applicable, the parent category in the category tree. This can be associated to a product as the parent category. - /// public Category Parent { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Products/Product.cs b/Mozu.Api/Contracts/CommerceRuntime/Products/Product.cs old mode 100644 new mode 100755 index 54346e5c..b9a2fe1c --- a/Mozu.Api/Contracts/CommerceRuntime/Products/Product.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Products/Product.cs @@ -20,33 +20,21 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Products /// public class Product { - /// - ///Allocation ID associated with this product on this order. - /// public DateTime? AllocationExpiration { get; set; } - /// - ///Allocation ID associated with this product on this order. - /// public int? AllocationId { get; set; } /// - ///Properties of a collection of component products that make up a single product bundle with its own product code. Tenants can define product bundles for any product type that supports the Bundle product usage. + ///Collection of component products that make up a single product bundle with its own product code, added to a cart or order. /// public List BundledProducts { get; set; } - /// - ///The list of all categories associated with the product. These categories contain products, can have discounts associated, and define the grouping of products to display on the storefront. - /// public List Categories { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } /// - ///Indicates if the discount is restricted. If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval.For price list entries, specifies whether discounts are restricted for the specific entry if is set to .Refer to [Discount Restriction](../../../guides/catalog/price-lists.htm#discountrestriction) in the Price Lists guides topic for more information. + ///If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval. /// public bool? DiscountsRestricted { get; set; } @@ -60,49 +48,34 @@ public class Product /// public DateTime? DiscountsRestrictedStartDate { get; set; } - /// - ///Fulfillment status of the product. - /// public string FulfillmentStatus { get; set; } /// - ///List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both. + ///List of fulfillment types that the product supports. /// public List FulfillmentTypesSupported { get; set; } /// - ///The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit. + ///The type of goods of a product. For example: physical, digital, or digital credit. /// public string GoodsType { get; set; } - /// - ///The alternate image description defined for the product, in the language specified in the locale code for the storefront. - /// public string ImageAlternateText { get; set; } /// - ///The URL link for the image file associated with a product or category. + ///The URL of the image file associated with a product on a storefront. /// public string ImageUrl { get; set; } /// - ///Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself. + ///If true, this product cannot ship in a package with other items and must ship in a package by itself. /// public bool IsPackagedStandAlone { get; set; } - /// - ///Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. - /// public bool? IsRecurring { get; set; } - /// - ///Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules. - /// public bool? IsTaxable { get; set; } - /// - ///Dimensions of the packaged product. - /// public PackageMeasurements Measurements { get; set; } /// @@ -110,34 +83,19 @@ public class Product /// public string MfgPartNumber { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } - /// - ///The price of the product that appears on the storefront including any applied discounts. - /// public ProductPrice Price { get; set; } - /// - ///Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// public string ProductCode { get; set; } /// - ///Unique identifier of the product reservation associated with the component product in a product bundle or item in a cart/order. System-supplied and read only. + ///The unique identifier of the product reservation created for this item in the cart or order. /// public int? ProductReservationId { get; set; } - /// - ///A product type is like a product template. - /// public string ProductType { get; set; } /// @@ -145,19 +103,13 @@ public class Product /// public string ProductUsage { get; set; } - /// - ///Collection of property attributes defined for the object. Properties are associated to all objects within , including documents, products, and product types. - /// public List Properties { get; set; } /// - ///The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels. + ///The universal product code defined for the product. /// public string Upc { get; set; } - /// - ///Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// public string VariationProductCode { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Products/ProductOption.cs b/Mozu.Api/Contracts/CommerceRuntime/Products/ProductOption.cs old mode 100644 new mode 100755 index f8c46462..0e10656a --- a/Mozu.Api/Contracts/CommerceRuntime/Products/ProductOption.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Products/ProductOption.cs @@ -18,34 +18,16 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Products /// public class ProductOption { - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The value a shopper entered for an attribute that requires additional input for the product on a storefront. This entered value is a selected option or entered content for an extra, such as selecting a color or entering content for a monogram. - /// public object ShopperEnteredValue { get; set; } - /// - ///If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options. - /// public string StringValue { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Products/ProductPrice.cs b/Mozu.Api/Contracts/CommerceRuntime/Products/ProductPrice.cs old mode 100644 new mode 100755 index fa8af595..6de6cb6e --- a/Mozu.Api/Contracts/CommerceRuntime/Products/ProductPrice.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Products/ProductPrice.cs @@ -19,38 +19,23 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Products public class ProductPrice { /// - ///The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. + ///The credit value when the product happens to be a gift card or similar product. /// public decimal? CreditValue { get; set; } /// - ///The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier. + ///The manufacturer's suggested retail price for the product. /// public decimal? Msrp { get; set; } - /// - ///The price the merchant charges for a product on a storefront if no sales price is defined. - /// public decimal? Price { get; set; } - /// - ///If the product's price comes from a price list, this property is the code of the price list with which the product is associated. - /// public string PriceListCode { get; set; } - /// - ///The price list entry mode of the product. This property is for future funtionality and currently should only be . - /// public string PriceListEntryMode { get; set; } - /// - ///The set sale price for a product consisting of a price with a discount already applied.For price list entries, this property is the product's sale price if the is set to . - /// public decimal? SalePrice { get; set; } - /// - ///The override price defined by the tenant for this cart or order item. - /// public decimal? TenantOverridePrice { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Products/ProductProperty.cs b/Mozu.Api/Contracts/CommerceRuntime/Products/ProductProperty.cs old mode 100644 new mode 100755 index 75954f21..4ffddf29 --- a/Mozu.Api/Contracts/CommerceRuntime/Products/ProductProperty.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Products/ProductProperty.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Products /// public class ProductProperty { - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///Indicates if the object has or can have multiple properties or values. If true, the object can have more than one value, selectable by shoppers through the storefront or configurable through the catalogs. - /// public bool IsMultiValue { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Products/ProductPropertyValue.cs b/Mozu.Api/Contracts/CommerceRuntime/Products/ProductPropertyValue.cs old mode 100644 new mode 100755 index f81d5bd0..0ce308bf --- a/Mozu.Api/Contracts/CommerceRuntime/Products/ProductPropertyValue.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Products/ProductPropertyValue.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Products /// public class ProductPropertyValue { - /// - ///If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options. - /// public string StringValue { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Refunds/Refund.cs b/Mozu.Api/Contracts/CommerceRuntime/Refunds/Refund.cs old mode 100644 new mode 100755 index f7adc74c..e5c87c66 --- a/Mozu.Api/Contracts/CommerceRuntime/Refunds/Refund.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Refunds/Refund.cs @@ -15,39 +15,18 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Refunds { - /// - /// Mozu.CommerceRuntime.Contracts.Refunds.Refund ApiType DOCUMENT_HERE - /// public class Refund { - /// - ///Amount refunded. - /// public decimal Amount { get; set; } - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Unique identifier of the order associated with the payment. - /// public string OrderId { get; set; } - /// - ///The payment associated with this refund (if applicable). - /// public Payment Payment { get; set; } - /// - ///The reason description for an action, including item return, coupon not valid, and item is taxed. - /// public string Reason { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReasonCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReasonCollection.cs old mode 100644 new mode 100755 index f6baca8d..efcc2dd0 --- a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReasonCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReasonCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Returns { - /// - /// Mozu.CommerceRuntime.Contracts.Returns.ReasonCollection ApiType DOCUMENT_HERE - /// public class ReasonCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Returns/Return.cs b/Mozu.Api/Contracts/CommerceRuntime/Returns/Return.cs old mode 100644 new mode 100755 index 1194bd0d..34864390 --- a/Mozu.Api/Contracts/CommerceRuntime/Returns/Return.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Returns/Return.cs @@ -24,179 +24,77 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Returns /// public class Return { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Available actions you can complete for an order. These actions may differ depending on the status of the order, such as actions required to enter a payment, return of a package, and fulfillment of a shipment. - /// public List AvailableActions { get; set; } /// - ///Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only. + ///List of change messages associated with the return. /// public List ChangeMessages { get; set; } - /// - ///Code that identifies the channel associated with the site for the shopper's created shopping cart, order, and return. - /// public string ChannelCode { get; set; } - /// - ///contact ApiType DOCUMENT_HERE - /// public Contact Contact { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///Unique identifer of the customer account. This ID is used to associate numerous types of data and object with the customer account, including orders, returns, wish lists, and in-store credit. - /// public int? CustomerAccountId { get; set; } - /// - ///The type of customer interaction used to create this shopping cart. Possible values are Website, Call, Store, or Unknown. - /// public string CustomerInteractionType { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. - /// public string LocationCode { get; set; } - /// - ///The total value of the return to the merchant for accounting purposes. This total represents the combined product loss and shipping loss associated with the return. - /// public decimal? LossTotal { get; set; } - /// - ///Paged list collection of note content for objects including customers, orders, and returns. - /// public List Notes { get; set; } - /// - ///If this return is associated with a previously completed order, the unique identifier of the original order. - /// public string OriginalOrderId { get; set; } - /// - ///The order number of the original order where the return was created. - /// public int? OriginalOrderNumber { get; set; } - /// - ///Array list of physical packages shipped for a specified order. - /// public List Packages { get; set; } - /// - ///Wrapper for a collection of payments associated with an order or return. An order can include a number of payments until the full total is covered. - /// public List Payments { get; set; } - /// - ///The total tax amount levied on the product loss amount. - /// public decimal? ProductLossTaxTotal { get; set; } - /// - ///The total value of the product returned to the merchant for accounting purposes, calculated by multiplying the cost of the item by its quantity returned. - /// public decimal? ProductLossTotal { get; set; } - /// - ///The status that indicates whether you have received the return item from the shopper. The accepted values are , , or . - /// public string ReceiveStatus { get; set; } - /// - ///If a refund action was performed for this return, the total amount refunded to the shopper. The refund amount can differ from the sum of the price of the returned items. - /// public decimal? RefundAmount { get; set; } - /// - ///The status of the refund. The accepted values are if the shopper only wants a replacement or if either a partial or full refund is applied to the return. - /// public string RefundStatus { get; set; } - /// - ///The status of the replacement order. The accepted values are if there is no replacement order or if a replacement order exits. - /// public string ReplaceStatus { get; set; } - /// - ///A merchant-specific identifier used to sequentially order returns. - /// public int? ReturnNumber { get; set; } - /// - ///Unique identifier for the last order created as a result of the return. If the return results in shipping a replacement item, the order includes shipment information for the replaced items. If the return results in a refund, the order includes payment transactions to credit the shopper. - /// public string ReturnOrderId { get; set; } - /// - ///The type of return, which is or .At the top-level return level, this field is DEPRECATED because Refund and Replace items can now be mixed within a single return. For backwards-compatibility with older applications, the field defaults to . - /// public string ReturnType { get; set; } - /// - ///The date by which a shopper must ship items associated with a return in an "awaiting items" state to the merchant. - /// public DateTime? RmaDeadline { get; set; } - /// - ///The total tax amount levied on the shipping loss amount. - /// public decimal? ShippingLossTaxTotal { get; set; } - /// - ///The total value of shipping the returned product to the merchant for accounting purposes, calculated by multiplying the shipping cost of the item by its quantity returned. - /// public decimal? ShippingLossTotal { get; set; } - /// - ///Unique identifier of the site. - /// public int? SiteId { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// public string Status { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int? TenantId { get; set; } - /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. - /// public string UserId { get; set; } - /// - ///Unique identifier of the customer visit in which the cart was created or last modified. - /// public string VisitId { get; set; } - /// - ///Unique identifier of the web session in which the cart, order, return, or wish list was created or last modified. - /// public string WebSessionId { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnAction.cs b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnAction.cs old mode 100644 new mode 100755 index eba51951..0dc99f0d --- a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnAction.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnAction.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Returns /// public class ReturnAction { - /// - ///The name of the action to perform for the payment, fulfillment, order, or return. - /// public string ActionName { get; set; } - /// - ///The list of returns for which to perform the action. - /// public List ReturnIds { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnBundle.cs b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnBundle.cs old mode 100644 new mode 100755 index 9cd244ad..c3a88c2c --- a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnBundle.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnBundle.cs @@ -24,7 +24,7 @@ public class ReturnBundle public string ProductCode { get; set; } /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. + ///The number of returned product bundles in the return. /// public int Quantity { get; set; } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnCollection.cs old mode 100644 new mode 100755 index 27719da8..dcb727a2 --- a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Returns /// public class ReturnCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItem.cs b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItem.cs old mode 100644 new mode 100755 index 76ef5819..7aa0cfa9 --- a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItem.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItem.cs @@ -22,128 +22,59 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Returns public class ReturnItem { /// - ///Properties of a collection of component products that make up a single product bundle with its own product code. Tenants can define product bundles for any product type that supports the Bundle product usage. + ///Properties of a collection of component products that make up a single returned product bundle with its own product code. /// public List BundledProducts { get; set; } - /// - ///Specifies whether to exclude product extras when you return a product or bundle. For example, assume the following order items:* Product A (bundle item)* Product B (bundle item)* Product C (bundle item)* Product D (extra on bundle)* Product F (extra on product)If this property is , Products D or F are included when the bundle or Product E are added to a return. If this property is , Products D or F are not included unless added individually. - /// public bool? ExcludeProductExtras { get; set; } /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: + ///Unique identifier of the return whose items you want to get. /// public string Id { get; set; } - /// - ///Paged list collection of note content for objects including customers, orders, and returns. - /// public List Notes { get; set; } - /// - ///Unique identifier of the order item associated with a validation message, order, or return. - /// public string OrderItemId { get; set; } - /// - ///This is the Option attribute FQN for the item being returned .. typically only when the return item is a product bundle item. - /// public string OrderItemOptionAttributeFQN { get; set; } - /// - ///The OrderLineId that this ReturnItem is associated with. If order item is present, the orderLineId should be present also. - /// public int? OrderLineId { get; set; } - /// - ///The properties of a product, referenced and used by carts, orders, wish lists, and returns. - /// public Product Product { get; set; } - /// - ///The total value of the product returned to the merchant for accounting purposes, calculated by multiplying the cost of the item by its quantity returned. - /// public decimal? ProductLossAmount { get; set; } - /// - ///The total tax amount levied on the product loss amount. - /// public decimal? ProductLossTaxAmount { get; set; } - /// - ///The actual quantity received for the return item. - /// public int QuantityReceived { get; set; } - /// - ///The quantity of the given line item that will be replaced. - /// public int? QuantityReplaced { get; set; } - /// - ///The quantity of returned items that can be returned to active product stock. - /// public int QuantityRestockable { get; set; } - /// - ///The quantity of the item shipped to the shopper in the event of a return item replacement. - /// public int QuantityShipped { get; set; } - /// - ///The list of return reasons for the item and the quantity associated with each return reason. - /// public List Reasons { get; set; } - /// - ///The status that indicates whether the shopper has returned the item. The accepted values are , , or . - /// public string ReceiveStatus { get; set; } - /// - ///The amount of the refund. - /// public decimal? RefundAmount { get; set; } - /// - ///The status of the refund for the item. The accepted values are if the shopper only wants a replacement or if either a partial or full refund is applied to the item. - /// public string RefundStatus { get; set; } - /// - ///The status of the replacement order for the item. The accepted values are if there is no replacement order or if a replacement order exits. - /// public string ReplaceStatus { get; set; } - /// - ///A Boolean that indicates whether the item requires the shopper to return the item. - /// public bool ReturnNotRequired { get; set; } - /// - ///The type of the return for the item. Either or . - /// public string ReturnType { get; set; } - /// - ///The total value of shipping the returned product to the merchant for accounting purposes, calculated by multiplying the shipping cost of the item by its quantity returned. - /// public decimal? ShippingLossAmount { get; set; } - /// - ///The total tax amount levied on the shipping loss amount. - /// public decimal? ShippingLossTaxAmount { get; set; } - /// - ///The total cost without shipping and handling applied. - /// public decimal? TotalWithoutWeightedShippingAndHandling { get; set; } - /// - ///The total cost with shipping and handling applied. - /// public decimal? TotalWithWeightedShippingAndHandling { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItemCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItemCollection.cs old mode 100644 new mode 100755 index 57b4fc61..1fb824b3 --- a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItemCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItemCollection.cs @@ -20,13 +20,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Returns public class ReturnItemCollection { /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. + ///Retrieves the details of all return items in an order. /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItemSpecifier.cs b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItemSpecifier.cs old mode 100644 new mode 100755 index 1da67066..c5405167 --- a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItemSpecifier.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnItemSpecifier.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Returns { - /// - /// Mozu.CommerceRuntime.Contracts.Returns.ReturnItemSpecifier ApiType DOCUMENT_HERE - /// public class ReturnItemSpecifier { - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int Quantity { get; set; } - /// - ///The ID of the return item to add to a replacement order. - /// public string ReturnItemId { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnReason.cs b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnReason.cs old mode 100644 new mode 100755 index c4adff74..c19e3003 --- a/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnReason.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Returns/ReturnReason.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Returns /// public class ReturnReason { - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int Quantity { get; set; } - /// - ///The reason description for an action, including item return, coupon not valid, and item is taxed. - /// public string Reason { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Wishlists/Wishlist.cs b/Mozu.Api/Contracts/CommerceRuntime/Wishlists/Wishlist.cs old mode 100644 new mode 100755 index 59662e40..7f3b55a8 --- a/Mozu.Api/Contracts/CommerceRuntime/Wishlists/Wishlist.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Wishlists/Wishlist.cs @@ -24,209 +24,97 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Wishlists /// public class Wishlist { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only. - /// public List ChangeMessages { get; set; } - /// - ///Code that identifies the channel associated with the site for the shopper's created shopping cart, order, and return. - /// public string ChannelCode { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///Unique identifer of the customer account. This ID is used to associate numerous types of data and object with the customer account, including orders, returns, wish lists, and in-store credit. - /// public int? CustomerAccountId { get; set; } - /// - ///The type of customer interaction used to create this shopping cart. Possible values are Website, Call, Store, or Unknown. - /// public string CustomerInteractionType { get; set; } - /// - ///Custom data for a given vendor set within the commerce process. - /// public JObject Data { get; set; } - /// - ///The aggregate total for all items in the cart, including costs associated with shopper-defined options or extras and any applied discounts. - /// public decimal? DiscountedSubtotal { get; set; } - /// - ///The subtotal of the cart, order, and wishlist items, including any applied discount calculations. Wishlist subtotals may change depending on the length of time, available discounts, and stock amounts of products at the time of review by shoppers. - /// public decimal? DiscountedTotal { get; set; } - /// - ///Estimated amount of discounts applied to all items in the carts and orders. System-supplied and read-only. This value will be available at the wish list, cart item, order item, and wish list item level at a later time. - /// public decimal? DiscountTotal { get; set; } - /// - ///Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only. - /// public DateTime? ExpirationDate { get; set; } - /// - ///Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values. - /// public List ExtendedProperties { get; set; } /// - ///Unique identifier used by an external program to identify a order, customer account, or wish list. + ///The identifier an external program uses to identify the Mozu wish list. /// public string ExternalId { get; set; } - /// - ///The monetary sum of all fees incurred in the cart, order, line item in a cart, or line item in an order. This value is not calculated for wish lists at this time. - /// public decimal? FeeTotal { get; set; } - /// - ///Properties of the information required to fulfill the cart, order, or wish list. Shoppers can fulfill ordered items by using in-store pickup or direct shipping. - /// public FulfillmentInfo FulfillmentInfo { get; set; } - /// - ///Calculated total tax amount for handling costs if the cart/order is subject to sales tax. - /// public decimal? HandlingTaxTotal { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } /// - ///The date and time an order or wish list is imported into . This is not the date and time it was created in the external application. + ///If this wish list was imported from an external program, the date and time the wish list was imported. /// public DateTime? ImportDate { get; set; } /// - ///Indicates if this object/data was imported from an outside source such as a data import or synchronization via an app or service. If true, this data was originally imported into and accessible through your store database. Examples of imported objects/data include orders and customer accounts. + ///If true, this wish list was imported from an external program. /// public bool? IsImport { get; set; } - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The total amount of calculated tax for items, used by carts, orders, and wish lists. - /// public decimal? ItemTaxTotal { get; set; } - /// - ///The date in UTC Date/Time when the items in the cart were last validated against the site's product catalog. System-supplied and read-only. - /// public DateTime? LastValidationDate { get; set; } - /// - ///The total charge for the line item with all weighted order level manual adjustments. - /// public decimal? LineItemSubtotalWithOrderAdjustments { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///List of order-level discounts projected to apply to the cart at checkout or order. - /// public List OrderDiscounts { get; set; } - /// - ///The type of privacy to apply to this wish list. Possible values are "Private" which makes the wish list viewable only to the shopper, "DirectShare" which makes the wish list viewable only to people with whom the shopper shares the wish list link, or "Public" which makes the wish list available to everyone. At this time, the system treats all shopper wish lists as "Public" regardless of the defined privacy type. - /// public string PrivacyType { get; set; } - /// - ///The total shipping amount for the wishlist before discounts and adjustments. - /// public decimal? ShippingAmountBeforeDiscountsAndAdjustments { get; set; } - /// - ///The shipping subtotal amount calculated without any applied discounts for line item and entire amounts of carts and orders. This property is not calculated for wish lists at this time. - /// public decimal? ShippingSubTotal { get; set; } - /// - ///The total amount of tax incurred on the shipping charges in the cart and order. This property is not calculated at this time for wish lists. - /// public decimal? ShippingTaxTotal { get; set; } - /// - ///The calculated total shipping amount estimated for carts or orders, including tax. This amount is not calculated for wish lists at this time. - /// public decimal? ShippingTotal { get; set; } - /// - ///Unique identifier of the site. - /// public int? SiteId { get; set; } - /// - ///The integer that represents the sequential order of this wish list in the customer's collection of wish lists. - /// public int? SortOrder { get; set; } - /// - ///Estimated amount of the cart or order without sales tax, shipping costs, and other fees. This amount is not calculated for wish lists at this time. - /// public decimal? Subtotal { get; set; } - /// - ///Leverage this property within a [tax Arc.js action](https://www.mozu.com/docs/arcjs/commerce-catalog-storefront-tax/commerce-catalog-storefront-tax.htm) to supplement the tax information for this item or object with custom JSON data. - /// + public List SuggestedDiscounts { get; set; } + public JObject TaxData { get; set; } - /// - ///The total monetary sum of sales tax estimated for a cart or order. - /// public decimal? TaxTotal { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int? TenantId { get; set; } - /// - ///Total is used to indicate the monetary, estimated total amount of the cart or order, including items, sales tax, shipping costs, and other fees. Totals are not estimated for wish lists at this time. - /// public decimal? Total { get; set; } - /// - ///User-defined string that defines the type of wish list to define, such as wish list, baby registry, or Christmas list. - /// public string TypeTag { get; set; } - /// - ///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. - /// public string Version { get; set; } - /// - ///Unique identifier of the customer visit in which the cart was created or last modified. - /// public string VisitId { get; set; } - /// - ///Unique identifier of the web session in which the cart, order, return, or wish list was created or last modified. - /// public string WebSessionId { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistCollection.cs old mode 100644 new mode 100755 index 8bac0e0c..8152f179 --- a/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Wishlists /// public class WishlistCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistItem.cs b/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistItem.cs old mode 100644 new mode 100755 index 49518d70..a2cd3fb5 --- a/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistItem.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistItem.cs @@ -24,224 +24,99 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Wishlists /// public class WishlistItem { - /// - ///The adjusted subtotal of the line item, including all manual adjustments, discounts, shipping charges and discounts, and duty or any other additional line item fees. - /// public decimal? AdjustedLineItemSubtotal { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Notes entered and saved with an order. These notes may be entered by a shopper on a wishlist or for an order. Comments may also be entered by Admins on an order that may be visible only to authorized shoppers and users. - /// + public int? AutoAddDiscountId { get; set; } + public string Comments { get; set; } - /// - ///Custom data for a given vendor set within the commerce process. - /// public JObject Data { get; set; } - /// - ///The subtotal of the cart, order, and wishlist items, including any applied discount calculations. Wishlist subtotals may change depending on the length of time, available discounts, and stock amounts of products at the time of review by shoppers. - /// public decimal? DiscountedTotal { get; set; } - /// - ///Estimated amount of discounts applied to all items in the carts and orders. System-supplied and read-only. This value will be available at the wish list, cart item, order item, and wish list item level at a later time. - /// public decimal? DiscountTotal { get; set; } - /// - ///Represents the total price of the cart item extended to the shopper. This begins with the Unit Price, then uses any of the following prices if they are defined, in the following order: Override Amount, Sale Amount, List Amount. This value is not calculated for wish lists at this time. - /// public decimal? ExtendedTotal { get; set; } - /// - ///The monetary sum of all fees incurred in the cart, order, line item in a cart, or line item in an order. This value is not calculated for wish lists at this time. - /// public decimal? FeeTotal { get; set; } - /// - ///The combined price for all handling costs calculated together for shipped orders, not for digital or in-store pickup. This includes all handling costs per the product line items and options, excluding taxes and discounts. - /// public decimal? HandlingAmount { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. - /// public bool? IsRecurring { get; set; } - /// - ///Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules. - /// public bool? IsTaxable { get; set; } - /// - ///The total amount of calculated tax for items, used by carts, orders, and wish lists. - /// public decimal? ItemTaxTotal { get; set; } - /// - ///The line id assigned to the order item. Visible only in the Admin, this is set from the Admin or in CommerceRuntime when a cart is converted to an order. - /// public int? LineId { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///User-defined string that indicates the priority of an item in a wish list. Possible values are Lowest, Low, Medium, High, and Highest. - /// public string PriorityType { get; set; } - /// - ///The properties of a product, referenced and used by carts, orders, wish lists, and returns. - /// public Product Product { get; set; } /// - ///The applicable product discount for an associated cart, order, or wish list. + ///List of product discounts that apply to the item in the wishlist. /// public AppliedLineItemProductDiscount ProductDiscount { get; set; } - /// - ///List of product-level discounts projected to apply to a cart, order, or wish list. - /// public List ProductDiscounts { get; set; } - /// - ///The status of the item that indicates whether an item in a wish list can be purchased. Possible values are "Purchasable" which indicates the item can be purchased, "NotPurchasable" which indicates the item is out of stock or otherwise unavailable, or "Missing" which indicates the item has been deleted from the catalog since it was added to the wish list. - /// public string PurchasableStatusType { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// + public string PurchaseLocation { get; set; } + public int Quantity { get; set; } - /// - ///The total shipping amount for the line item before discounts and adjustments. - /// public decimal? ShippingAmountBeforeDiscountsAndAdjustments { get; set; } - /// - ///List of shipping discounts projected to apply to carts, orders, and wish lists and items at checkout. - /// public List ShippingDiscounts { get; set; } - /// - ///The total amount of tax incurred on the shipping charges in the cart and order. This property is not calculated at this time for wish lists. - /// public decimal? ShippingTaxTotal { get; set; } - /// - ///The calculated total shipping amount estimated for carts or orders, including tax. This amount is not calculated for wish lists at this time. - /// public decimal? ShippingTotal { get; set; } - /// - ///Estimated amount of the cart or order without sales tax, shipping costs, and other fees. This amount is not calculated for wish lists at this time. - /// public decimal? Subtotal { get; set; } - /// - ///The monetary amount of an item in the cart that is subject to tax. This amount typically represents the line item subtotal before applied discounts for an order. - /// public decimal? TaxableTotal { get; set; } - /// - ///Leverage this property within a [tax Arc.js action](https://www.mozu.com/docs/arcjs/commerce-catalog-storefront-tax/commerce-catalog-storefront-tax.htm) to supplement the tax information for this item or object with custom JSON data. - /// public JObject TaxData { get; set; } - /// - ///Total is used to indicate the monetary, estimated total amount of the cart or order, including items, sales tax, shipping costs, and other fees. Totals are not estimated for wish lists at this time. - /// public decimal? Total { get; set; } - /// - ///The total charge for the line item without any weighted order level shipping and handling charges. - /// public decimal? TotalWithoutWeightedShippingAndHandling { get; set; } - /// - ///The total charge for the line item with all weighted order level shipping and handling charges. - /// public decimal? TotalWithWeightedShippingAndHandling { get; set; } - /// - ///Properties of the price per unit of a product, associated with cart and order items. This price is not used for wish lists at this time. - /// public CommerceUnitPrice UnitPrice { get; set; } - /// - ///The total weighted order level manual adjustment amount. - /// public decimal? WeightedOrderAdjustment { get; set; } - /// - ///The total weighted order level discount amount. - /// public decimal? WeightedOrderDiscount { get; set; } - /// - ///The total weighted order level duty charges. - /// public decimal? WeightedOrderDuty { get; set; } - /// - ///The adjustment to apply to the order handling fee. - /// public decimal? WeightedOrderHandlingAdjustment { get; set; } - /// - ///The total weighted order level handling fee amount. - /// public decimal? WeightedOrderHandlingFee { get; set; } - /// - ///The total weighted order handling fee discount amount. - /// public decimal? WeightedOrderHandlingFeeDiscount { get; set; } - /// - ///The total weighted order level handling fee tax amount. - /// public decimal? WeightedOrderHandlingFeeTax { get; set; } - /// - ///The total weighted order level shipping charge. - /// public decimal? WeightedOrderShipping { get; set; } - /// - ///The total weighted order level shipping discount amount. - /// public decimal? WeightedOrderShippingDiscount { get; set; } - /// - ///The total weighted order level shipping manual adjustment amount. - /// public decimal? WeightedOrderShippingManualAdjustment { get; set; } - /// - ///The total weighted order level shipping tax amount. - /// public decimal? WeightedOrderShippingTax { get; set; } - /// - ///The total weighted order level tax amount. - /// public decimal? WeightedOrderTax { get; set; } } diff --git a/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistItemCollection.cs b/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistItemCollection.cs old mode 100644 new mode 100755 index 62639c1d..31d9cfdb --- a/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistItemCollection.cs +++ b/Mozu.Api/Contracts/CommerceRuntime/Wishlists/WishlistItemCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.CommerceRuntime.Wishlists /// public class WishlistItemCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Content/ActiveDateRange.cs b/Mozu.Api/Contracts/Content/ActiveDateRange.cs old mode 100644 new mode 100755 index 42ed97fb..14f78271 --- a/Mozu.Api/Contracts/Content/ActiveDateRange.cs +++ b/Mozu.Api/Contracts/Content/ActiveDateRange.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.Content { - /// - /// Specifies a start date and end date for when associated object is on the live site, if is set to .If is set to ignores this property. - /// public class ActiveDateRange { - /// - ///The end of the active date range for this document - /// public DateTime? EndDate { get; set; } - /// - ///The beginning of the active date range of this document - /// public DateTime? StartDate { get; set; } } diff --git a/Mozu.Api/Contracts/Content/AddOrDeletePublishItem.cs b/Mozu.Api/Contracts/Content/AddOrDeletePublishItem.cs old mode 100644 new mode 100755 index e06ab194..b8b9ad1d --- a/Mozu.Api/Contracts/Content/AddOrDeletePublishItem.cs +++ b/Mozu.Api/Contracts/Content/AddOrDeletePublishItem.cs @@ -13,29 +13,14 @@ namespace Mozu.Api.Contracts.Content { - /// - /// This property is not exposed in documentation. - /// public class AddOrDeletePublishItem { - /// - ///The fully qualified name of the document list that the pending content change is associated with. - /// public string DocListFQN { get; set; } - /// - ///The unique identifier of the pending content change or the document. - /// public string DocumentId { get; set; } - /// - ///The unique identifier of the scope. For example, if your scope type is site, then this value would be the site id. - /// public int ScopeId { get; set; } - /// - ///The type of scope associated with the documentList. For example, if the documentList is pageTemplateContent, the scopeType is Site.Valid values are: "Tenant", "MasterCatalog", and "Site". - /// public string ScopeType { get; set; } } diff --git a/Mozu.Api/Contracts/Content/Document.cs b/Mozu.Api/Contracts/Content/Document.cs old mode 100644 new mode 100755 index e0eff266..faa85b0b --- a/Mozu.Api/Contracts/Content/Document.cs +++ b/Mozu.Api/Contracts/Content/Document.cs @@ -20,74 +20,32 @@ namespace Mozu.Api.Contracts.Content /// public class Document { - /// - ///Mozu.Content.Contracts.Document activeDateRange ApiTypeMember DOCUMENT_HERE - /// public ActiveDateRange ActiveDateRange { get; set; } - /// - ///The character length allowed for the content text. - /// public long ContentLength { get; set; } - /// - ///The mime type associated with the document content, if applicable. - /// public string ContentMimeType { get; set; } - /// - ///The date and time the most recent content update was made. UTC date/time. System-supplied and read-only. - /// public DateTime? ContentUpdateDate { get; set; } - /// - ///Fully qualified name of the document type. - /// public string DocumentTypeFQN { get; set; } - /// - ///If applicable, the file extension associated with the document content. For example, the extension may be .html for an HTML web page. - /// public string Extension { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The date and time when a document was added to the document list. System-supplied and read-only. - /// public DateTime? InsertDate { get; set; } - /// - ///The fully qualified name of the document list. - /// public string ListFQN { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Collection of property attributes defined for the object. Properties are associated to all objects within , including documents, products, and product types. - /// public JObject Properties { get; set; } - /// - ///The name of the publish set that this document belongs to, if any. - /// public string PublishSetCode { get; set; } - /// - ///The current state of the document or product definition. States for documents include Active, Draft, or Latest. Active documents are published and cannot be deleted. Querying Latest returns the most recent version of the document, regardless of whether it is published or a draft. States for product include New, Draft, or Live. - /// public string PublishState { get; set; } - /// - ///Date and time when the entity was last updated, represented in UTC Date/Time. - /// public DateTime? UpdateDate { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentCollection.cs b/Mozu.Api/Contracts/Content/DocumentCollection.cs old mode 100644 new mode 100755 index 3b607263..3a7a6c29 --- a/Mozu.Api/Contracts/Content/DocumentCollection.cs +++ b/Mozu.Api/Contracts/Content/DocumentCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Content /// public class DocumentCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentDraftSummary.cs b/Mozu.Api/Contracts/Content/DocumentDraftSummary.cs old mode 100644 new mode 100755 index 4ad15cea..1cb1abb2 --- a/Mozu.Api/Contracts/Content/DocumentDraftSummary.cs +++ b/Mozu.Api/Contracts/Content/DocumentDraftSummary.cs @@ -18,69 +18,30 @@ namespace Mozu.Api.Contracts.Content /// public class DocumentDraftSummary { - /// - ///Detailed information of the date and time for the active update date for the document draft summary. This data is associated to document and content data. - /// public DateTime? ActiveUpdateDate { get; set; } - /// - ///The unique identifier of the user that last updated the content or document draft. - /// public string ActiveUpdatedBy { get; set; } - /// - ///The unique identifier for the product catalog. Catalogs are part of a master catalog. - /// public int? CatalogId { get; set; } - /// - ///Fully qualified name of the document type. - /// public string DocumentTypeFQN { get; set; } - /// - ///Detailed information of the date and time for the draft update date for the document draft summary. This data is associated to document and content data. - /// public DateTime DraftUpdateDate { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The fully qualified name of the document list. - /// public string ListFQN { get; set; } - /// - ///Unique identifier for the master catalog. - /// public int? MasterCatalogId { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The unique identifier of the publish set. - /// public string PublishSetCode { get; set; } - /// - ///Whether the draft has been published. - /// public string PublishType { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int? SiteId { get; set; } - /// - ///Unique identifier of the user who last modified the item. This value is system-supplied and read-only. - /// public string UpdatedBy { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentDraftSummaryPagedCollection.cs b/Mozu.Api/Contracts/Content/DocumentDraftSummaryPagedCollection.cs old mode 100644 new mode 100755 index 075a29fe..d8dcd8b5 --- a/Mozu.Api/Contracts/Content/DocumentDraftSummaryPagedCollection.cs +++ b/Mozu.Api/Contracts/Content/DocumentDraftSummaryPagedCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Content /// public class DocumentDraftSummaryPagedCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentInstallation.cs b/Mozu.Api/Contracts/Content/DocumentInstallation.cs old mode 100644 new mode 100755 index 6cf5f0eb..c0d80440 --- a/Mozu.Api/Contracts/Content/DocumentInstallation.cs +++ b/Mozu.Api/Contracts/Content/DocumentInstallation.cs @@ -15,29 +15,14 @@ namespace Mozu.Api.Contracts.Content { - /// - /// Properties for the document installation package and data. This information details the installation of document content and files within the site. - /// public class DocumentInstallation { - /// - ///Fully qualified name of the document type. - /// public string DocumentTypeFQN { get; set; } - /// - ///Localized properties for the document installation package and data. This information details the installation of document content and files within the site and is localized based on the `localeCode`. - /// public string Locale { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Collection of property attributes defined for the object. Properties are associated to all objects within , including documents, products, and product types. - /// public JObject Properties { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentList.cs b/Mozu.Api/Contracts/Content/DocumentList.cs old mode 100644 new mode 100755 index 9cc78962..12bcee44 --- a/Mozu.Api/Contracts/Content/DocumentList.cs +++ b/Mozu.Api/Contracts/Content/DocumentList.cs @@ -21,79 +21,34 @@ namespace Mozu.Api.Contracts.Content /// public class DocumentList { - /// - ///The type of the document list, containing content for a site. For example, a list type could be web pages. - /// public string DocumentListType { get; set; } - /// - ///List of document types associated with this document list. - /// public List DocumentTypes { get; set; } - /// - ///If set, documents in this list will only be returned if the date queried for their is within their ActiveDateRange. - /// public bool? EnableActiveDateRanges { get; set; } - /// - ///Indicates if the document list and document list type are enabled to publish. If true, publishing of draft documents in this document list/document list type is enabled for the site. If false, all document changes are immediately published in live mode. - /// public bool? EnablePublishing { get; set; } - /// - ///The fully qualified name of the document list. - /// public string ListFQN { get; set; } - /// - ///Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. - /// public JObject Metadata { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The namespace for the accessible APIs and source capabilities in the core of APIs. - /// public string Namespace { get; set; } - /// - ///The unique identifier of the scope. For example, if your scope type is site, then this value would be the site id. - /// public int? ScopeId { get; set; } - /// - ///The type of scope associated with the documentList. For example, if the documentList is pageTemplateContent, the scopeType is Site.Valid values are: "Tenant", "MasterCatalog", and "Site". - /// public string ScopeType { get; set; } - /// - ///Indicates the security level for the document content as public, administrator, or owner. - /// public string Security { get; set; } - /// - ///Determines if the documentList will support ranges of dates that documents are considered 'active'. This field defaults to false and cannot be updated. If the documentList is based on a documentListType, then this value will be derived from the documentListType. - /// public bool? SupportsActiveDateRanges { get; set; } - /// - ///Indicates if modified documents are published automatically or saved to publish at a later time. If true, changed documents in this list can be saved as drafts until they are published to the site. If false, all document changes are immediately published in live mode. System-supplied and read only. - /// public bool? SupportsPublishing { get; set; } - /// - ///A string array that determines where the document or entity list displays. The options are , for displaying content in the Custom Schema page in , and , for displaying content in the site tree in Site Builder (applies only to document lists). The following example demonstrates how to display content across both options: - /// public List Usages { get; set; } - /// - ///The view in the site used by associated entities or document lists/list types. - /// public List Views { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentListCollection.cs b/Mozu.Api/Contracts/Content/DocumentListCollection.cs old mode 100644 new mode 100755 index 3e992774..99009849 --- a/Mozu.Api/Contracts/Content/DocumentListCollection.cs +++ b/Mozu.Api/Contracts/Content/DocumentListCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Content /// public class DocumentListCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentListType.cs b/Mozu.Api/Contracts/Content/DocumentListType.cs old mode 100644 new mode 100755 index 5c088fe0..9b46299e --- a/Mozu.Api/Contracts/Content/DocumentListType.cs +++ b/Mozu.Api/Contracts/Content/DocumentListType.cs @@ -16,84 +16,36 @@ namespace Mozu.Api.Contracts.Content { - /// - /// Properties for the document list type. Document lists contain documents with an associated document type, such as web pages. - /// public class DocumentListType { - /// - ///Definition of any documents to create with a document list is created. - /// public List DefaultDocuments { get; set; } - /// - ///The fully qualified name for the document list type for content. - /// public string DocumentListTypeFQN { get; set; } - /// - ///List of fully qualified names for the document type. - /// public List DocumentTypeFQNs { get; set; } - /// - ///Determines if documentLists belonging to this documentListType have ActiveDateRanges turned on or off. Each documentList created from the documentListType will use this value, but it can be overridden in an individual documentList. - /// public bool? EnableActiveDateRanges { get; set; } - /// - ///Indicates if the document list and document list type are enabled to publish. If true, publishing of draft documents in this document list/document list type is enabled for the site. If false, all document changes are immediately published in live mode. - /// public bool? EnablePublishing { get; set; } - /// - ///The package of document lists and content documents to be installed. - /// public string InstallationPackage { get; set; } - /// - ///Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. - /// public JObject Metadata { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The namespace for the accessible APIs and source capabilities in the core of APIs. - /// public string Namespace { get; set; } - /// - ///The type of scope associated with the documentList. For example, if the documentList is pageTemplateContent, the scopeType is Site.Valid values are: "Tenant", "MasterCatalog", and "Site". - /// public string ScopeType { get; set; } - /// - ///Determines if documentLists belonging to this documentListType will support drafting and ActiveDateRanges documents. This field defaults to false and cannot be updated. Each documentList created from the documentListType will use this value. - /// public bool SupportsActiveDateRanges { get; set; } - /// - ///Indicates if modified documents are published automatically or saved to publish at a later time. If true, changed documents in this list can be saved as drafts until they are published to the site. If false, all document changes are immediately published in live mode. System-supplied and read only. - /// public bool SupportsPublishing { get; set; } - /// - ///A string array that determines where the document or entity list displays. The options are , for displaying content in the Custom Schema page in , and , for displaying content in the site tree in Site Builder (applies only to document lists). The following example demonstrates how to display content across both options: - /// public List Usages { get; set; } - /// - ///The current version number of the order, wish list, document list, or document type list. - /// public string Version { get; set; } - /// - ///The view in the site used by associated entities or document lists/list types. - /// public List Views { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentListTypeCollection.cs b/Mozu.Api/Contracts/Content/DocumentListTypeCollection.cs old mode 100644 new mode 100755 index 8c6b509e..063a2735 --- a/Mozu.Api/Contracts/Content/DocumentListTypeCollection.cs +++ b/Mozu.Api/Contracts/Content/DocumentListTypeCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.Content { - /// - /// Mozu.Content.Contracts.DocumentListTypeCollection ApiType DOCUMENT_HERE - /// public class DocumentListTypeCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentType.cs b/Mozu.Api/Contracts/Content/DocumentType.cs old mode 100644 new mode 100755 index ea595b1d..43388bd3 --- a/Mozu.Api/Contracts/Content/DocumentType.cs +++ b/Mozu.Api/Contracts/Content/DocumentType.cs @@ -21,44 +21,20 @@ namespace Mozu.Api.Contracts.Content /// public class DocumentType { - /// - ///The administrator name associated with the object/data. - /// public string AdminName { get; set; } - /// - ///Fully qualified name of the document type. - /// public string DocumentTypeFQN { get; set; } - /// - ///The package of document lists and content documents to be installed. - /// public string InstallationPackage { get; set; } - /// - ///Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. - /// public JObject Metadata { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The namespace for the accessible APIs and source capabilities in the core of APIs. - /// public string Namespace { get; set; } - /// - ///Collection of property attributes defined for the object. Properties are associated to all objects within , including documents, products, and product types. - /// public List Properties { get; set; } - /// - ///The current version number of the order, wish list, document list, or document type list. - /// public string Version { get; set; } } diff --git a/Mozu.Api/Contracts/Content/DocumentTypeCollection.cs b/Mozu.Api/Contracts/Content/DocumentTypeCollection.cs old mode 100644 new mode 100755 index 0eef8ae3..3dfcf252 --- a/Mozu.Api/Contracts/Content/DocumentTypeCollection.cs +++ b/Mozu.Api/Contracts/Content/DocumentTypeCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Content /// public class DocumentTypeCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Content/Facet.cs b/Mozu.Api/Contracts/Content/Facet.cs old mode 100644 new mode 100755 index 8d1b371f..d17d80cf --- a/Mozu.Api/Contracts/Content/Facet.cs +++ b/Mozu.Api/Contracts/Content/Facet.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Content /// public class Facet { - /// - ///The total number of associated items. - /// public int Count { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/Content/Property.cs b/Mozu.Api/Contracts/Content/Property.cs old mode 100644 new mode 100755 index cbfb8d6a..81284436 --- a/Mozu.Api/Contracts/Content/Property.cs +++ b/Mozu.Api/Contracts/Content/Property.cs @@ -13,29 +13,14 @@ namespace Mozu.Api.Contracts.Content { - /// - /// Provides details and data for properties for content in the site. - /// public class Property { - /// - ///If true, the attribute can have more than one value. - /// public bool IsMultiValued { get; set; } - /// - ///Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value. - /// public bool IsRequired { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Property type available for content. Property types are like templates that can be reused. - /// public PropertyType PropertyType { get; set; } } diff --git a/Mozu.Api/Contracts/Content/PropertyType.cs b/Mozu.Api/Contracts/Content/PropertyType.cs old mode 100644 new mode 100755 index 234fce82..cca39e34 --- a/Mozu.Api/Contracts/Content/PropertyType.cs +++ b/Mozu.Api/Contracts/Content/PropertyType.cs @@ -18,54 +18,24 @@ namespace Mozu.Api.Contracts.Content /// public class PropertyType { - /// - ///The administrator name associated with the object/data. - /// public string AdminName { get; set; } - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///The package of document lists and content documents to be installed. - /// public string InstallationPackage { get; set; } - /// - ///If true, this entity can be grouped. - /// public bool? IsAggregatable { get; set; } - /// - ///Indicates if the entity can be located and returned in a search, used for fields and property types. If true, the entity can be searched. - /// public bool? IsQueryable { get; set; } - /// - ///Indicates if the fields or property types are sortable on the page. If true, the property type results are sortable. If false, the property type results cannot be sorted by any options. - /// public bool? IsSortable { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The namespace for the accessible APIs and source capabilities in the core of APIs. - /// public string Namespace { get; set; } - /// - ///The fully qualified name for the property type for content. - /// public string PropertyTypeFQN { get; set; } - /// - ///The current version number of the order, wish list, document list, or document type list. - /// public string Version { get; set; } } diff --git a/Mozu.Api/Contracts/Content/PropertyTypeCollection.cs b/Mozu.Api/Contracts/Content/PropertyTypeCollection.cs old mode 100644 new mode 100755 index a667d05f..8dc9267a --- a/Mozu.Api/Contracts/Content/PropertyTypeCollection.cs +++ b/Mozu.Api/Contracts/Content/PropertyTypeCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Content /// public class PropertyTypeCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Content/PublishSetSummary.cs b/Mozu.Api/Contracts/Content/PublishSetSummary.cs old mode 100644 new mode 100755 index 30643b51..c3097154 --- a/Mozu.Api/Contracts/Content/PublishSetSummary.cs +++ b/Mozu.Api/Contracts/Content/PublishSetSummary.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.Content { - /// - /// Mozu.Content.Contracts.PublishSetSummary ApiType DOCUMENT_HERE - /// public class PublishSetSummary { - /// - ///The total number of associated items. - /// public int Count { get; set; } - /// - ///The unique identifier of the content publish set. - /// public string PublishSetCode { get; set; } } diff --git a/Mozu.Api/Contracts/Content/PublishSetSummaryPagedCollection.cs b/Mozu.Api/Contracts/Content/PublishSetSummaryPagedCollection.cs old mode 100644 new mode 100755 index 04bdf8ce..ca5dfa3a --- a/Mozu.Api/Contracts/Content/PublishSetSummaryPagedCollection.cs +++ b/Mozu.Api/Contracts/Content/PublishSetSummaryPagedCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.Content { - /// - /// Mozu.Content.Contracts.PublishSetSummaryPagedCollection ApiType DOCUMENT_HERE - /// public class PublishSetSummaryPagedCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Content/View.cs b/Mozu.Api/Contracts/Content/View.cs old mode 100644 new mode 100755 index e497a821..38fd924b --- a/Mozu.Api/Contracts/Content/View.cs +++ b/Mozu.Api/Contracts/Content/View.cs @@ -16,14 +16,8 @@ namespace Mozu.Api.Contracts.Content { - /// - /// A view can select which fields are returned from a document query. - /// public class View { - /// - ///The list of fields to display for a view or an associated schema. For example, the address schema would display fields for postal addresses. - /// public List Fields { get; set; } /// @@ -31,34 +25,16 @@ public class View /// public string Filter { get; set; } - /// - ///Specifies how to filter views based on the status of a document.You can specify the following values for this property: or null—all documents return in the view.—only documents within the active date range (or documents without an active date range specified) return in the view.—only documents with an active date range set in the future return in the view.—only scheduled and active documents return in the view.—only documents with an active date range set in the past return in the view. - /// public string IncludeInactiveMode { get; set; } - /// - ///If , specifies that the view is the default view for a documentList or documentListType when viewed in . If no view is specified as default, then the first view in the documentList or documentListType is default. Only one view within a documentList or documentListType can have this value set to . - /// public bool? IsAdminDefault { get; set; } - /// - ///The isVisibleInStorefront field indicates whether documents in the view can be accessed from the storefront application. If true, the storefront application and storefront client application (javascript tier) can GET documents from the view. - /// public bool? IsVisibleInStorefront { get; set; } - /// - ///Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. - /// public JObject Metadata { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///A string array that determines where the document or entity list displays. The options are , for displaying content in the Custom Schema page in , and , for displaying content in the site tree in Site Builder (applies only to document lists). The following example demonstrates how to display content across both options: - /// public List Usages { get; set; } } diff --git a/Mozu.Api/Contracts/Content/ViewField.cs b/Mozu.Api/Contracts/Content/ViewField.cs old mode 100644 new mode 100755 index 98c492be..7039c387 --- a/Mozu.Api/Contracts/Content/ViewField.cs +++ b/Mozu.Api/Contracts/Content/ViewField.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.Content { - /// - /// Field within a view of the content. - /// public class ViewField { - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property. - /// public string Target { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Address.cs b/Mozu.Api/Contracts/Core/Address.cs old mode 100644 new mode 100755 index d8760450..cd38c8b8 --- a/Mozu.Api/Contracts/Core/Address.cs +++ b/Mozu.Api/Contracts/Core/Address.cs @@ -18,54 +18,24 @@ namespace Mozu.Api.Contracts.Core /// public class Address { - /// - ///Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200. - /// public string Address1 { get; set; } - /// - ///Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200. - /// public string Address2 { get; set; } - /// - ///Physical or mailing address line three. Max length: 200. - /// public string Address3 { get; set; } - /// - ///Physical or mailing address line four. Max length: 200. - /// public string Address4 { get; set; } - /// - ///The type of address, which is commercial or residential. - /// public string AddressType { get; set; } - /// - ///City or town for the physical or mailing address. The maximum character length is 100. - /// public string CityOrTown { get; set; } - /// - ///The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// public string CountryCode { get; set; } - /// - ///Indicates if the address has been validated. If true, the address has been verified by an address validation service. - /// public bool? IsValidated { get; set; } - /// - ///The postal or zip code for the address. For example, a USPS-approved ZIP code standard is ZIP+4: 12345-6789. The maximum character length is 100. - /// public string PostalOrZipCode { get; set; } - /// - ///The two-letter geographic code representing the state for the physical or mailing address. This is currently limited to the US. - /// public string StateOrProvince { get; set; } } diff --git a/Mozu.Api/Contracts/Core/AuditInfo.cs b/Mozu.Api/Contracts/Core/AuditInfo.cs old mode 100644 new mode 100755 index 9fca921b..f2dceaf9 --- a/Mozu.Api/Contracts/Core/AuditInfo.cs +++ b/Mozu.Api/Contracts/Core/AuditInfo.cs @@ -13,29 +13,14 @@ namespace Mozu.Api.Contracts.Core { - /// - /// Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public class AuditInfo { - /// - ///Unique identifier of the user created the resource entity. This value is system-supplied and read-only. - /// public string CreateBy { get; set; } - /// - ///Date and time when the entity was created, represented in UTC Date/Time. - /// public DateTime? CreateDate { get; set; } - /// - ///Unique identifier of the user who last modified the item. This value is system-supplied and read-only. - /// public string UpdateBy { get; set; } - /// - ///Date and time when the entity was last updated, represented in UTC Date/Time. - /// public DateTime? UpdateDate { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Behavior.cs b/Mozu.Api/Contracts/Core/Behavior.cs old mode 100644 new mode 100755 index ddee7ad7..afd9df20 --- a/Mozu.Api/Contracts/Core/Behavior.cs +++ b/Mozu.Api/Contracts/Core/Behavior.cs @@ -15,33 +15,18 @@ namespace Mozu.Api.Contracts.Core { /// - /// Properties of an application's behavior. + /// Properties of an application behavior. /// public class Behavior { - /// - ///Unique identifier of a category. - /// public int CategoryId { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///If true, this application behavior is not part of the public API. - /// public bool IsPrivate { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///For validation purposes, the integer value must be a list of behavior IDs. - /// public List RequiresBehaviorIds { get; set; } /// @@ -49,9 +34,6 @@ public class Behavior /// public List SystemRoles { get; set; } - /// - ///The user types that are valid for this behavior. - /// public List ValidUserTypes { get; set; } } diff --git a/Mozu.Api/Contracts/Core/BehaviorCategory.cs b/Mozu.Api/Contracts/Core/BehaviorCategory.cs old mode 100644 new mode 100755 index 85be5f78..7b915afb --- a/Mozu.Api/Contracts/Core/BehaviorCategory.cs +++ b/Mozu.Api/Contracts/Core/BehaviorCategory.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Core /// public class BehaviorCategory { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/Core/BehaviorCategoryCollection.cs b/Mozu.Api/Contracts/Core/BehaviorCategoryCollection.cs old mode 100644 new mode 100755 index b29c8aca..78130063 --- a/Mozu.Api/Contracts/Core/BehaviorCategoryCollection.cs +++ b/Mozu.Api/Contracts/Core/BehaviorCategoryCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Core /// public class BehaviorCategoryCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Core/BehaviorCollection.cs b/Mozu.Api/Contracts/Core/BehaviorCollection.cs old mode 100644 new mode 100755 index c17a115c..83a0aecb --- a/Mozu.Api/Contracts/Core/BehaviorCollection.cs +++ b/Mozu.Api/Contracts/Core/BehaviorCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Core /// public class BehaviorCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Contact.cs b/Mozu.Api/Contracts/Core/Contact.cs old mode 100644 new mode 100755 index 21fad548..622eaacd --- a/Mozu.Api/Contracts/Core/Contact.cs +++ b/Mozu.Api/Contracts/Core/Contact.cs @@ -18,44 +18,20 @@ namespace Mozu.Api.Contracts.Core /// public class Contact { - /// - ///Address information to supply for a contact. - /// public Address Address { get; set; } - /// - ///The legal or doing business as (DBA) or tradestyle name of the business or organization. The maximum character length is 200. - /// public string CompanyOrOrganization { get; set; } - /// - ///The email address of the specified user or the email address associated with the specified entity. - /// public string Email { get; set; } - /// - ///The first name of the contact. The maximum character length is 200. - /// public string FirstName { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///The last name or surname of the contact. The maximum character length is 200. - /// public string LastNameOrSurname { get; set; } - /// - ///The middle name or the first initial of the middle name of the contact. The maximum character length is 100. - /// public string MiddleNameOrInitial { get; set; } - /// - ///List of phone numbers associated with the customer account contact. The phone numbers include area codes. - /// public Phone PhoneNumbers { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Extensible/Attribute.cs b/Mozu.Api/Contracts/Core/Extensible/Attribute.cs old mode 100644 new mode 100755 index fcfb0387..a9ba3d31 --- a/Mozu.Api/Contracts/Core/Extensible/Attribute.cs +++ b/Mozu.Api/Contracts/Core/Extensible/Attribute.cs @@ -20,59 +20,29 @@ namespace Mozu.Api.Contracts.Core.Extensible /// public class Attribute { - /// - ///The administrator name associated with the object/data. - /// public string AdminName { get; set; } - /// - ///Merchant-defined code for an extensible attribute. This code may be used to generate an object's fully qualified name, such as for products. - /// public string AttributeCode { get; set; } - /// - ///The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name. - /// public string AttributeFQN { get; set; } - /// - ///List of metadata key-value pairs defined for an extensible attribute. - /// public List AttributeMetadata { get; set; } - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes. - /// public AttributeLocalizedContent Content { get; set; } - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } /// - ///Whether the customer or order attribute appears in only, or in both and the website storefront. Possible values are Admin and AdminAndStorefront. + ///Whether the customer or order attribute appears in Mozu Admin only, or in both Mozu Admin and the website storefront. Possible values are Admin and AdminAndStorefront. /// public string DisplayGroup { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea. - /// public string InputType { get; set; } - /// - ///Indicates if the object or feature is active. - /// public bool? IsActive { get; set; } /// @@ -80,13 +50,10 @@ public class Attribute /// public bool? IsMultiValued { get; set; } - /// - ///Flag used to indicate if this attribute definition is read-only. Once an attribute definition is set to read-only this action cannot be undone. - /// public bool IsReadOnly { get; set; } /// - ///Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value. + ///If true, the attribute must have a defined value. /// public bool? IsRequired { get; set; } @@ -95,29 +62,20 @@ public class Attribute /// public bool? IsVisible { get; set; } - /// - ///The namespace for the accessible APIs and source capabilities in the core of APIs. - /// public string Namespace { get; set; } /// - ///Integer that represents the sequence order of the attribute. + ///Integer that represents the sequence of the attribute. /// public int? Order { get; set; } - /// - ///Properties used when validating a value entered for an object, including extensible attributes, products attributes, and database entries. - /// public AttributeValidation Validation { get; set; } /// - ///An attribute value type is either predefined vocabulary by the admin during attribute set up or user-defined with an appropriate type (AdminEntered or ShopperEntered depending on the user). These types are used by products and attributes. The difference between predefined values versus manually entered values is such that the first choice is a set of options to choose from. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order. + ///An attribute value type is either predefined vocabulary by the admin during attribute set up or it can be "AdminEntered" or "ShopperEntered". The difference between predefined values versus manually entered values is such that the first choice is a set of options to choose from. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order. /// public string ValueType { get; set; } - /// - ///List of valid vocabulary values defined for an attribute. - /// public List VocabularyValues { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Extensible/AttributeCollection.cs b/Mozu.Api/Contracts/Core/Extensible/AttributeCollection.cs old mode 100644 new mode 100755 index 43c7b1dd..1ed6283c --- a/Mozu.Api/Contracts/Core/Extensible/AttributeCollection.cs +++ b/Mozu.Api/Contracts/Core/Extensible/AttributeCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.Core.Extensible /// public class AttributeCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Extensible/AttributeLocalizedContent.cs b/Mozu.Api/Contracts/Core/Extensible/AttributeLocalizedContent.cs old mode 100644 new mode 100755 index 778ac5d6..5ccf9e7f --- a/Mozu.Api/Contracts/Core/Extensible/AttributeLocalizedContent.cs +++ b/Mozu.Api/Contracts/Core/Extensible/AttributeLocalizedContent.cs @@ -18,13 +18,10 @@ namespace Mozu.Api.Contracts.Core.Extensible /// public class AttributeLocalizedContent { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. + ///The localized value defined for the attribute. /// public string Value { get; set; } diff --git a/Mozu.Api/Contracts/Core/Extensible/AttributeMetadataItem.cs b/Mozu.Api/Contracts/Core/Extensible/AttributeMetadataItem.cs old mode 100644 new mode 100755 index 9625f9da..f3583547 --- a/Mozu.Api/Contracts/Core/Extensible/AttributeMetadataItem.cs +++ b/Mozu.Api/Contracts/Core/Extensible/AttributeMetadataItem.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Core.Extensible /// public class AttributeMetadataItem { - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Extensible/AttributeValidation.cs b/Mozu.Api/Contracts/Core/Extensible/AttributeValidation.cs old mode 100644 new mode 100755 index 539e3bdd..c6130076 --- a/Mozu.Api/Contracts/Core/Extensible/AttributeValidation.cs +++ b/Mozu.Api/Contracts/Core/Extensible/AttributeValidation.cs @@ -14,43 +14,22 @@ namespace Mozu.Api.Contracts.Core.Extensible { /// - /// Validates the attribute configured for the customer in the storefront against the attribute configured in . + /// Validates the attribute configured for the customer in the storefront against the attribute configured in Mozu admin. /// public class AttributeValidation { - /// - ///The latest possible date and time the extensible attribute can be validated. - /// public DateTime? MaxDateTime { get; set; } - /// - ///The maximum number that can be entered as a value for an extensible attribute. - /// public decimal? MaxNumericValue { get; set; } - /// - ///The maximum character length possible for a string value entered for an extensible attribute. - /// public int? MaxStringLength { get; set; } - /// - ///The earliest date and time an extensible attribute can be validated. - /// public DateTime? MinDateTime { get; set; } - /// - ///The minimum numeric value required to validate an extensible attribute. - /// public decimal? MinNumericValue { get; set; } - /// - ///The minimum character length possible for a string value entered for an extensible attribute. - /// public int? MinStringLength { get; set; } - /// - ///Regular expression used to process and validate an extensible attribute value that require special formatting, such as phone numbers. - /// public string RegularExpression { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Extensible/AttributeValueLocalizedContent.cs b/Mozu.Api/Contracts/Core/Extensible/AttributeValueLocalizedContent.cs old mode 100644 new mode 100755 index 216acb10..e91a7cde --- a/Mozu.Api/Contracts/Core/Extensible/AttributeValueLocalizedContent.cs +++ b/Mozu.Api/Contracts/Core/Extensible/AttributeValueLocalizedContent.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Core.Extensible /// public class AttributeValueLocalizedContent { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Extensible/AttributeVocabularyValue.cs b/Mozu.Api/Contracts/Core/Extensible/AttributeVocabularyValue.cs old mode 100644 new mode 100755 index 7bc9e938..323c5a4b --- a/Mozu.Api/Contracts/Core/Extensible/AttributeVocabularyValue.cs +++ b/Mozu.Api/Contracts/Core/Extensible/AttributeVocabularyValue.cs @@ -18,24 +18,15 @@ namespace Mozu.Api.Contracts.Core.Extensible /// public class AttributeVocabularyValue { - /// - ///Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes. - /// public AttributeValueLocalizedContent Content { get; set; } /// - ///Indicates if the object is hidden or breaks inheritance, primarily used by facets, products, and attribute vocabulary values. For example, if true, the attribute vocabulary value does not appear in the list when defining a value for an attribute. + ///If true, the attribute vocabulary value does not appear in the list when defining a value for the attribute. /// public bool? IsHidden { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int? Sequence { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Measurement.cs b/Mozu.Api/Contracts/Core/Measurement.cs old mode 100644 new mode 100755 index 547f7fa7..549e2cc2 --- a/Mozu.Api/Contracts/Core/Measurement.cs +++ b/Mozu.Api/Contracts/Core/Measurement.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Core /// public class Measurement { - /// - ///The unit of measurement, such as length or weight. - /// public string Unit { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public decimal? Value { get; set; } } diff --git a/Mozu.Api/Contracts/Core/Phone.cs b/Mozu.Api/Contracts/Core/Phone.cs old mode 100644 new mode 100755 index 8ebda3f4..ae943db9 --- a/Mozu.Api/Contracts/Core/Phone.cs +++ b/Mozu.Api/Contracts/Core/Phone.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.Core /// public class Phone { - /// - ///Home phone number. - /// public string Home { get; set; } - /// - ///Mobile phone number. - /// public string Mobile { get; set; } - /// - ///Work phone number. - /// public string Work { get; set; } } diff --git a/Mozu.Api/Contracts/Core/ThirdParty/ActiveShippingCountry.cs b/Mozu.Api/Contracts/Core/ThirdParty/ActiveShippingCountry.cs old mode 100644 new mode 100755 index ca39c770..351a9ba2 --- a/Mozu.Api/Contracts/Core/ThirdParty/ActiveShippingCountry.cs +++ b/Mozu.Api/Contracts/Core/ThirdParty/ActiveShippingCountry.cs @@ -19,9 +19,6 @@ namespace Mozu.Api.Contracts.Core.ThirdParty /// public class ActiveShippingCountry { - /// - ///Array list of the active shipping carriers for the country. - /// public List ActiveCarriers { get; set; } public string CountryCode { get; set; } diff --git a/Mozu.Api/Contracts/Core/ThirdParty/InitializablePropertyValue.cs b/Mozu.Api/Contracts/Core/ThirdParty/InitializablePropertyValue.cs old mode 100644 new mode 100755 index fc6b8937..07388e88 --- a/Mozu.Api/Contracts/Core/ThirdParty/InitializablePropertyValue.cs +++ b/Mozu.Api/Contracts/Core/ThirdParty/InitializablePropertyValue.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Core.ThirdParty /// public class InitializablePropertyValue { - /// - ///Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage. - /// public bool Initialized { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/Core/ThirdParty/InitializableShippingCountryPropertyValue.cs b/Mozu.Api/Contracts/Core/ThirdParty/InitializableShippingCountryPropertyValue.cs old mode 100644 new mode 100755 index a7f59a6a..31845257 --- a/Mozu.Api/Contracts/Core/ThirdParty/InitializableShippingCountryPropertyValue.cs +++ b/Mozu.Api/Contracts/Core/ThirdParty/InitializableShippingCountryPropertyValue.cs @@ -19,19 +19,10 @@ namespace Mozu.Api.Contracts.Core.ThirdParty /// public class InitializableShippingCountryPropertyValue { - /// - ///Child value in a hierarchy of shipping country properties. - /// public List Child { get; set; } - /// - ///Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage. - /// public bool Initialized { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/Core/ThirdParty/OperationUrl.cs b/Mozu.Api/Contracts/Core/ThirdParty/OperationUrl.cs old mode 100644 new mode 100755 index f89d3c96..89e7f274 --- a/Mozu.Api/Contracts/Core/ThirdParty/OperationUrl.cs +++ b/Mozu.Api/Contracts/Core/ThirdParty/OperationUrl.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Core.ThirdParty /// public class OperationUrl { - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The URL endpoint address. - /// public string Url { get; set; } } diff --git a/Mozu.Api/Contracts/Core/User.cs b/Mozu.Api/Contracts/Core/User.cs old mode 100644 new mode 100755 index 349b81cf..f0690d59 --- a/Mozu.Api/Contracts/Core/User.cs +++ b/Mozu.Api/Contracts/Core/User.cs @@ -15,53 +15,26 @@ namespace Mozu.Api.Contracts.Core { /// - /// Properties of the user. Users include customers and users. + /// Properties of the user. /// public class User { - /// - ///The email address of the specified user or the email address associated with the specified entity. - /// public string EmailAddress { get; set; } - /// - ///The first name of the contact. The maximum character length is 200. - /// public string FirstName { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Indicates if the object or feature is active. - /// public bool IsActive { get; set; } - /// - ///The last name or surname of the contact. The maximum character length is 200. - /// public string LastName { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The write-only password for the customer account. - /// public string Password { get; set; } - /// - ///Collection of roles assigned to the user. - /// public List Roles { get; set; } - /// - ///Collection of system-supplied data about the user. - /// public UserSystemData SystemData { get; set; } } diff --git a/Mozu.Api/Contracts/Core/UserAuthInfo.cs b/Mozu.Api/Contracts/Core/UserAuthInfo.cs old mode 100644 new mode 100755 index ccf163a4..6c90efaf --- a/Mozu.Api/Contracts/Core/UserAuthInfo.cs +++ b/Mozu.Api/Contracts/Core/UserAuthInfo.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Core /// public class UserAuthInfo { - /// - ///The email address of the specified user or the email address associated with the specified entity. - /// public string EmailAddress { get; set; } - /// - ///The write-only password for the customer account. - /// public string Password { get; set; } } diff --git a/Mozu.Api/Contracts/Core/UserProfile.cs b/Mozu.Api/Contracts/Core/UserProfile.cs old mode 100644 new mode 100755 index 9cd8f023..c94245e5 --- a/Mozu.Api/Contracts/Core/UserProfile.cs +++ b/Mozu.Api/Contracts/Core/UserProfile.cs @@ -18,28 +18,16 @@ namespace Mozu.Api.Contracts.Core /// public class UserProfile { - /// - ///The email address of the specified user or the email address associated with the specified entity. - /// public string EmailAddress { get; set; } - /// - ///The first name of the contact. The maximum character length is 200. - /// public string FirstName { get; set; } - /// - ///The last name or surname of the contact. The maximum character length is 200. - /// public string LastName { get; set; } - /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. - /// public string UserId { get; set; } /// - ///The user name associated with the user profile. The customer uses the user name to access the account. + ///The user name associated with the user profile. /// public string UserName { get; set; } diff --git a/Mozu.Api/Contracts/Core/UserRole.cs b/Mozu.Api/Contracts/Core/UserRole.cs old mode 100644 new mode 100755 index daf2c11b..35cc22d7 --- a/Mozu.Api/Contracts/Core/UserRole.cs +++ b/Mozu.Api/Contracts/Core/UserRole.cs @@ -18,29 +18,14 @@ namespace Mozu.Api.Contracts.Core /// public class UserRole { - /// - ///Properties of the developer account or tenant associated with the user role. - /// public UserScope AssignedInScope { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Unique identifier of the user role. - /// public int RoleId { get; set; } - /// - ///The name of the user role, such as "developer" or "administrator". - /// public string RoleName { get; set; } - /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. - /// public string UserId { get; set; } } diff --git a/Mozu.Api/Contracts/Core/UserScope.cs b/Mozu.Api/Contracts/Core/UserScope.cs old mode 100644 new mode 100755 index 6a6c8664..3b8ceb38 --- a/Mozu.Api/Contracts/Core/UserScope.cs +++ b/Mozu.Api/Contracts/Core/UserScope.cs @@ -14,23 +14,14 @@ namespace Mozu.Api.Contracts.Core { /// - /// Properties of the scope in which a user operates, which represents a developer account or production tenant. + /// Properties of the scope in which a user operates, which represents a developer account or Mozu production tenant. /// public class UserScope { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The type of scope, which is a developer account or production tenant. - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/Core/UserSystemData.cs b/Mozu.Api/Contracts/Core/UserSystemData.cs old mode 100644 new mode 100755 index 3e7d97e9..60c52f3d --- a/Mozu.Api/Contracts/Core/UserSystemData.cs +++ b/Mozu.Api/Contracts/Core/UserSystemData.cs @@ -18,54 +18,24 @@ namespace Mozu.Api.Contracts.Core /// public class UserSystemData { - /// - ///Date and time when the entity was created, represented in UTC Date/Time. - /// public DateTime? CreatedOn { get; set; } - /// - ///The total number of failed authentication attempts associated with a customer account attempting access. - /// public byte FailedLoginAttemptCount { get; set; } - /// - ///The date and time the initial login was unsuccessful. System-supplied and read only. Each time user authentication fails, an update occurs on this field. The amount of failures is calculated together for `failedLoginAttemptCount`. - /// public DateTime? FirstFailedLoginAttemptOn { get; set; } - /// - ///Indicates if a customer account and associated data is locked. If true, the user account is locked due to multiple failed authentication attempts. The user cannot login until the account is unlocked. - /// public bool IsLocked { get; set; } - /// - ///Indicates if the customer account must have the password changed on login. If true, the login action requires a password change for increased security. If false, the login does not require a password change. - /// public bool IsPasswordChangeRequired { get; set; } - /// - ///Provides date and time data when the customer's account was last locked. System-supplied and read-only. - /// public DateTime? LastLockedOn { get; set; } - /// - ///Provides the date and time the customer last logged into the store. System-supplied and read-only. - /// public DateTime? LastLoginOn { get; set; } - /// - ///Date and time the customer's password was last modified. System-supplied and read-only. - /// public DateTime? LastPasswordChangeOn { get; set; } - /// - ///The number of login attempts remaining for the customer. The user must login successfully before this value reaches zero otherwise the account locks. - /// public int RemainingLoginAttempts { get; set; } - /// - ///Date and time when the entity was last updated, represented in UTC Date/Time. - /// public DateTime? UpdatedOn { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/AccountPasswordInfo.cs b/Mozu.Api/Contracts/Customer/AccountPasswordInfo.cs old mode 100644 new mode 100755 index cc096ce9..f6923b13 --- a/Mozu.Api/Contracts/Customer/AccountPasswordInfo.cs +++ b/Mozu.Api/Contracts/Customer/AccountPasswordInfo.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// The details of the account password. - /// public class AccountPasswordInfo { - /// - ///Unique identifier of the customer account generated by the system. Account IDs are generated at account creation. - /// public int AccountId { get; set; } - /// - ///The Old and New Password for the Account - /// public PasswordInfo PasswordInfo { get; set; } - /// - ///Indicates to unlock the Account - /// public bool? UnlockAccount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/AccountPasswordInfoCollection.cs b/Mozu.Api/Contracts/Customer/AccountPasswordInfoCollection.cs old mode 100644 new mode 100755 index 3004d66a..338ace42 --- a/Mozu.Api/Contracts/Customer/AccountPasswordInfoCollection.cs +++ b/Mozu.Api/Contracts/Customer/AccountPasswordInfoCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// A collection of account password information. - /// public class AccountPasswordInfoCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/AddressValidationRequest.cs b/Mozu.Api/Contracts/Customer/AddressValidationRequest.cs old mode 100644 new mode 100755 index 66853888..407e5433 --- a/Mozu.Api/Contracts/Customer/AddressValidationRequest.cs +++ b/Mozu.Api/Contracts/Customer/AddressValidationRequest.cs @@ -15,13 +15,10 @@ namespace Mozu.Api.Contracts.Customer { /// - /// 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. + /// Properties of the address to validate. /// public class AddressValidationRequest { - /// - ///Address information to supply for a contact. - /// public Address Address { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/AddressValidationResponse.cs b/Mozu.Api/Contracts/Customer/AddressValidationResponse.cs old mode 100644 new mode 100755 index 2e58aeac..432ce716 --- a/Mozu.Api/Contracts/Customer/AddressValidationResponse.cs +++ b/Mozu.Api/Contracts/Customer/AddressValidationResponse.cs @@ -20,9 +20,6 @@ namespace Mozu.Api.Contracts.Customer /// public class AddressValidationResponse { - /// - ///Array list of possible valid address matches based on the entry supplied in the request. - /// public List
AddressCandidates { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/Card.cs b/Mozu.Api/Contracts/Customer/Card.cs old mode 100644 new mode 100755 index fdd16a09..28297e15 --- a/Mozu.Api/Contracts/Customer/Card.cs +++ b/Mozu.Api/Contracts/Customer/Card.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Customer /// public class Card { - /// - ///The masked credit card number part returned from the payment gateway. - /// public string CardNumberPart { get; set; } - /// - ///The type of credit card, such as Visa or Amex. - /// public string CardType { get; set; } /// @@ -33,29 +27,14 @@ public class Card /// public int ContactId { get; set; } - /// - ///The two-digit month a credit card expires for a payment method. - /// public short ExpireMonth { get; set; } - /// - ///The four-digit year the credit card expires for a payment method. - /// public short ExpireYear { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///A boolean that signals whether this credit card is the default payment method for this customer account. - /// public bool IsDefaultPayMethod { get; set; } - /// - ///The full name printed on a credit card. The name should match what is printed on the card exactly, used in validation during a payment. - /// public string NameOnCard { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CardCollection.cs b/Mozu.Api/Contracts/Customer/CardCollection.cs old mode 100644 new mode 100755 index 213620cd..1f054132 --- a/Mozu.Api/Contracts/Customer/CardCollection.cs +++ b/Mozu.Api/Contracts/Customer/CardCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Customer /// public class CardCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/ChangePasswordResult.cs b/Mozu.Api/Contracts/Customer/ChangePasswordResult.cs old mode 100644 new mode 100755 index b3b982ed..95a135ac --- a/Mozu.Api/Contracts/Customer/ChangePasswordResult.cs +++ b/Mozu.Api/Contracts/Customer/ChangePasswordResult.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// Mozu.Customer.Contracts.ChangePasswordResult ApiType DOCUMENT_HERE - /// public class ChangePasswordResult { - /// - ///Unique identifier of the customer account generated by the system. Account IDs are generated at account creation. - /// public int AccountId { get; set; } - /// - ///A message describing why the operation failed. - /// public string ErrorMessage { get; set; } - /// - ///TRUE if the operation completes without error. - /// public bool Succeeded { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/ChangePasswordResultCollection.cs b/Mozu.Api/Contracts/Customer/ChangePasswordResultCollection.cs old mode 100644 new mode 100755 index deda98c5..c0583f21 --- a/Mozu.Api/Contracts/Customer/ChangePasswordResultCollection.cs +++ b/Mozu.Api/Contracts/Customer/ChangePasswordResultCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// Mozu.Customer.Contracts.ChangePasswordResultCollection ApiType DOCUMENT_HERE - /// public class ChangePasswordResultCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CommerceSummary.cs b/Mozu.Api/Contracts/Customer/CommerceSummary.cs old mode 100644 new mode 100755 index 4425026f..8671802e --- a/Mozu.Api/Contracts/Customer/CommerceSummary.cs +++ b/Mozu.Api/Contracts/Customer/CommerceSummary.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.Customer /// public class CommerceSummary { - /// - ///The date and time the shopper last submitted an order for any site associated with the tenant. - /// public DateTime? LastOrderDate { get; set; } - /// - ///The total number of order the shopper submitted across all sites associated with the tenant. - /// public int OrderCount { get; set; } - /// - ///The aggregate total amount of all orders the shopper submitted, across all sites associated with the tenant. - /// public CurrencyAmount TotalOrderAmount { get; set; } /// @@ -38,9 +29,6 @@ public class CommerceSummary /// public int VisitsCount { get; set; } - /// - ///The number of wish lists associated with a customer account. This number represents the total number of a shopper's wish lists across all sites associated with a tenant. - /// public int WishlistCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/ContactType.cs b/Mozu.Api/Contracts/Customer/ContactType.cs old mode 100644 new mode 100755 index 87f4d152..505e5f0f --- a/Mozu.Api/Contracts/Customer/ContactType.cs +++ b/Mozu.Api/Contracts/Customer/ContactType.cs @@ -19,12 +19,12 @@ namespace Mozu.Api.Contracts.Customer public class ContactType { /// - ///Indicates if the object is primary, used to indicate primary contacts and entities within a tenant. If true, this marker indicates that the object is the primary in a set. + ///If true, this is the primary contact of this contact type. /// public bool IsPrimary { get; set; } /// - ///The user supplied name that appears in . You can use this field for identification purposes. + ///The name of this contact type. /// public string Name { get; set; } diff --git a/Mozu.Api/Contracts/Customer/Credit/Credit.cs b/Mozu.Api/Contracts/Customer/Credit/Credit.cs old mode 100644 new mode 100755 index 5b397cde..b52727c4 --- a/Mozu.Api/Contracts/Customer/Credit/Credit.cs +++ b/Mozu.Api/Contracts/Customer/Credit/Credit.cs @@ -50,12 +50,12 @@ public class Credit public decimal? CurrentBalance { get; set; } /// - ///Unique identifier of the customer in , used to associate customers with data, orders, returns, and in-store credit. + ///Unique identifier of the shopper associated with the applied credit. For gift cards, this property is not required. /// public int? CustomerId { get; set; } /// - ///Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only. + ///The date and time the credit expires and can no longer be redeemed. /// public DateTime? ExpirationDate { get; set; } diff --git a/Mozu.Api/Contracts/Customer/Credit/CreditAuditEntry.cs b/Mozu.Api/Contracts/Customer/Credit/CreditAuditEntry.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/Customer/Credit/CreditAuditEntryCollection.cs b/Mozu.Api/Contracts/Customer/Credit/CreditAuditEntryCollection.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/Customer/Credit/CreditCollection.cs b/Mozu.Api/Contracts/Customer/Credit/CreditCollection.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/Customer/Credit/CreditTransaction.cs b/Mozu.Api/Contracts/Customer/Credit/CreditTransaction.cs old mode 100644 new mode 100755 index dae57880..11280674 --- a/Mozu.Api/Contracts/Customer/Credit/CreditTransaction.cs +++ b/Mozu.Api/Contracts/Customer/Credit/CreditTransaction.cs @@ -25,12 +25,12 @@ public class CreditTransaction public AuditInfo AuditInfo { get; set; } /// - ///Notes entered and saved with an order. These notes may be entered by a shopper on a wishlist or for an order. Comments may also be entered by Admins on an order that may be visible only to authorized shoppers and users. + ///Comments entered for a transaction. Depending on the interface, these comments might be visible to authorized shoppers and users. /// public string Comments { get; set; } /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: + ///Unique identifier of the customer credit transaction. /// public int? Id { get; set; } @@ -39,13 +39,10 @@ public class CreditTransaction /// public decimal? ImpactAmount { get; set; } - /// - ///Unique identifier of the order associated with the payment. - /// public string OrderId { get; set; } /// - ///Specifies the type of transaction, including customer transactions and credit transactions.Valid values for credit transactions are the following:* —decreases the credit amount* —updates the credit amountValid values for customer transaction types are the following:* * * * + ///The type of transaction to perform for the customer credit. To decrease the balance, set this parameter to "Debit". To increase the balance, set this parameter to "Credit". /// public string TransactionType { get; set; } diff --git a/Mozu.Api/Contracts/Customer/Credit/CreditTransactionCollection.cs b/Mozu.Api/Contracts/Customer/Credit/CreditTransactionCollection.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/Customer/CurrencyAmount.cs b/Mozu.Api/Contracts/Customer/CurrencyAmount.cs old mode 100644 new mode 100755 index 9da5a57f..c5c7a833 --- a/Mozu.Api/Contracts/Customer/CurrencyAmount.cs +++ b/Mozu.Api/Contracts/Customer/CurrencyAmount.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Customer /// public class CurrencyAmount { - /// - ///The monetary amount in the specified currency locale code. - /// public decimal Amount { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerAccount.cs b/Mozu.Api/Contracts/Customer/CustomerAccount.cs old mode 100644 new mode 100755 index 679cfd77..97f2ea60 --- a/Mozu.Api/Contracts/Customer/CustomerAccount.cs +++ b/Mozu.Api/Contracts/Customer/CustomerAccount.cs @@ -20,74 +20,41 @@ namespace Mozu.Api.Contracts.Customer /// public class CustomerAccount { - /// - ///Indicates if the customer account is opted to receive marketing materials. If true, the customer account is opted in for receiving the content. - /// public bool AcceptsMarketing { get; set; } - /// - ///Collection of attributes that may be paged list or a list, depending on the usage per object and API type. - /// public List Attributes { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Properties of the commerce summary associated with a customer account, which includes details about the shopper's most recent order, wish lists, and total order value over time. - /// public CommerceSummary CommerceSummary { get; set; } - /// - ///The legal or doing business as (DBA) or tradestyle name of the business or organization. The maximum character length is 200. - /// public string CompanyOrOrganization { get; set; } - /// - ///Contact information, including the contact's name, address, phone numbers, email addresses, and company (if supplied). Also indicates whether this is a billing, shipping, or billing and shipping contact. - /// public List Contacts { get; set; } - /// - ///customerSet ApiType DOCUMENT_HERE - /// public string CustomerSet { get; set; } - /// - ///This property tracks the customer account creation date. This date can be set manually via the API for customer accounts that are imported into . - /// public DateTime? CustomerSinceDate { get; set; } /// - ///The email address for the customer account and contact. This email may be used for login to the storefront and for subscription mailing lists. + ///The email address associated with the customer account. /// public string EmailAddress { get; set; } /// - ///Unique identifier used by an external program to identify a order, customer account, or wish list. + ///Unique identifier an external system uses to identify this customer account. /// public string ExternalId { get; set; } /// - ///The full first name of a customer or contact name. + ///The first name associated with the customer account. /// public string FirstName { get; set; } - /// - ///Indicates if an external password is set on this account. - /// public bool HasExternalPassword { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///Indicates if the object or feature is active. - /// public bool IsActive { get; set; } /// @@ -95,13 +62,10 @@ public class CustomerAccount /// public bool IsAnonymous { get; set; } - /// - ///Indicates if a customer account and associated data is locked. If true, the user account is locked due to multiple failed authentication attempts. The user cannot login until the account is unlocked. - /// public bool IsLocked { get; set; } /// - ///The full last name of a customer or contact name. + ///The last name associated with the customer account. /// public string LastName { get; set; } @@ -110,9 +74,6 @@ public class CustomerAccount /// public string LocaleCode { get; set; } - /// - ///Paged list collection of note content for objects including customers, orders, and returns. - /// public List Notes { get; set; } /// @@ -120,23 +81,14 @@ public class CustomerAccount /// public List Segments { get; set; } - /// - ///If true, this customer account has tax exempt status. - /// public bool TaxExempt { get; set; } - /// - ///The tax identification number associated with the customer account. - /// public string TaxId { get; set; } - /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. - /// public string UserId { get; set; } /// - ///The user name associated with the user profile. The customer uses the user name to access the account. + ///The user name of the user associated with the customer account. /// public string UserName { get; set; } diff --git a/Mozu.Api/Contracts/Customer/CustomerAccountAndAuthInfo.cs b/Mozu.Api/Contracts/Customer/CustomerAccountAndAuthInfo.cs old mode 100644 new mode 100755 index 1c9803b6..565a60d8 --- a/Mozu.Api/Contracts/Customer/CustomerAccountAndAuthInfo.cs +++ b/Mozu.Api/Contracts/Customer/CustomerAccountAndAuthInfo.cs @@ -14,7 +14,7 @@ namespace Mozu.Api.Contracts.Customer { /// - /// The authentication information associated with a customer account. The data includes the account properties such as the name, username, authorization access, and email address, the required password to match, and indicates if the account was imported from a third party resource. + /// The authentication information associated with a customer account. /// public class CustomerAccountAndAuthInfo { @@ -23,18 +23,15 @@ public class CustomerAccountAndAuthInfo /// public CustomerAccount Account { get; set; } - /// - ///If you are importing existing customer accounts to or using two customer systems simultaneously, you use this property to store an external password hash that helps you migrate existing customer accounts seamlessly into , without having to require shoppers to create new passwords for the platform. If you set this property, you must use the [embedded.verifyExternalPassword](https://www.mozu.com/docs/arcjs/commerce-customer/actions/verifyexternalpassword.htm) action to verify that the hashed version of a cleartext password provided by a shopper matches the external password hash specified in this property. - /// public string ExternalPassword { get; set; } /// - ///Indicates if this object/data was imported from an outside source such as a data import or synchronization via an app or service. If true, this data was originally imported into and accessible through your store database. Examples of imported objects/data include orders and customer accounts. + ///If true, this customer account and its associated data was imported from an external source. /// public bool IsImport { get; set; } /// - ///The write-only password for the customer account. + ///The password required to authenticate this customer account. /// public string Password { get; set; } diff --git a/Mozu.Api/Contracts/Customer/CustomerAccountCollection.cs b/Mozu.Api/Contracts/Customer/CustomerAccountCollection.cs old mode 100644 new mode 100755 index 61f2cc30..d36fec20 --- a/Mozu.Api/Contracts/Customer/CustomerAccountCollection.cs +++ b/Mozu.Api/Contracts/Customer/CustomerAccountCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.Customer /// public class CustomerAccountCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerAttribute.cs b/Mozu.Api/Contracts/Customer/CustomerAttribute.cs old mode 100644 new mode 100755 index 9015a5b5..c5731d45 --- a/Mozu.Api/Contracts/Customer/CustomerAttribute.cs +++ b/Mozu.Api/Contracts/Customer/CustomerAttribute.cs @@ -20,24 +20,12 @@ namespace Mozu.Api.Contracts.Customer /// public class CustomerAttribute { - /// - ///Unique identifier of the attribute definition. - /// public int? AttributeDefinitionId { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string FullyQualifiedName { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerAttributeCollection.cs b/Mozu.Api/Contracts/Customer/CustomerAttributeCollection.cs old mode 100644 new mode 100755 index 05542104..40efca37 --- a/Mozu.Api/Contracts/Customer/CustomerAttributeCollection.cs +++ b/Mozu.Api/Contracts/Customer/CustomerAttributeCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Customer /// public class CustomerAttributeCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerAuditEntry.cs b/Mozu.Api/Contracts/Customer/CustomerAuditEntry.cs old mode 100644 new mode 100755 index 61457c4c..77d85f9a --- a/Mozu.Api/Contracts/Customer/CustomerAuditEntry.cs +++ b/Mozu.Api/Contracts/Customer/CustomerAuditEntry.cs @@ -13,59 +13,26 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// A list of audit details associated with a specific customer account. - /// public class CustomerAuditEntry { - /// - ///Applicattion associated with this entry - /// public string Application { get; set; } - /// - ///Unique identifer of the customer account. This ID is used to associate numerous types of data and object with the customer account, including orders, returns, wish lists, and in-store credit. - /// public int CustomerAccountId { get; set; } - /// - ///The unique identifier of the audit entry associated with the customer account. - /// public int CustomerAuditEntryId { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///The date the audit entries was created. - /// public DateTime EntryDate { get; set; } - /// - ///The unique identifier of the user who created the audit entry. - /// public string EntryUser { get; set; } - /// - ///The path of the field value that was changed, for example - /// public string FieldPath { get; set; } - /// - ///The field's new value after the audit entry event. - /// public string NewValue { get; set; } - /// - ///The field's original value before the audit entry event. - /// public string OldValue { get; set; } - /// - ///The site identifier associated with this audit entry. - /// public string Site { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerAuditEntryCollection.cs b/Mozu.Api/Contracts/Customer/CustomerAuditEntryCollection.cs old mode 100644 new mode 100755 index e0be3c31..1be9d377 --- a/Mozu.Api/Contracts/Customer/CustomerAuditEntryCollection.cs +++ b/Mozu.Api/Contracts/Customer/CustomerAuditEntryCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// A collection of audit entries assocaited with a specific customer acocunt. - /// public class CustomerAuditEntryCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerAuthTicket.cs b/Mozu.Api/Contracts/Customer/CustomerAuthTicket.cs old mode 100644 new mode 100755 index 93a6343f..f7346657 --- a/Mozu.Api/Contracts/Customer/CustomerAuthTicket.cs +++ b/Mozu.Api/Contracts/Customer/CustomerAuthTicket.cs @@ -19,12 +19,12 @@ namespace Mozu.Api.Contracts.Customer public class CustomerAuthTicket { /// - ///Alphanumeric string used to authenticate the user in API request headers. The token stores an encrypted list of the application's configured behaviors and authenticates the application. + ///Access token string that enables authentication for the customer account. /// public string AccessToken { get; set; } /// - ///The date and time the user access token expires. If the token will expire, a new token will need to be generated and assigned to the account to continue and restore access to the store, data, and account. + ///The date and time the access token expires. /// public DateTime AccessTokenExpiration { get; set; } @@ -34,17 +34,17 @@ public class CustomerAuthTicket public CustomerAccount CustomerAccount { get; set; } /// - ///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. + ///Refresh token string used to generate a new access token after expiration for a customer account authentication ticket. /// public string RefreshToken { get; set; } /// - ///The date and time the developer account or application refresh token expires. + ///The date and time the refresh token expires. /// public DateTime RefreshTokenExpiration { get; set; } /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. + ///User ID associated with the customer account authentication ticket. /// public string UserId { get; set; } diff --git a/Mozu.Api/Contracts/Customer/CustomerContact.cs b/Mozu.Api/Contracts/Customer/CustomerContact.cs old mode 100644 new mode 100755 index 56fbb06b..3cb04b68 --- a/Mozu.Api/Contracts/Customer/CustomerContact.cs +++ b/Mozu.Api/Contracts/Customer/CustomerContact.cs @@ -20,29 +20,14 @@ namespace Mozu.Api.Contracts.Customer /// public class CustomerContact { - /// - ///Unique identifier of the customer account generated by the system. Account IDs are generated at account creation. - /// public int AccountId { get; set; } - /// - ///Address information to supply for a contact. - /// public Address Address { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The legal or doing business as (DBA) or tradestyle name of the business or organization. The maximum character length is 200. - /// public string CompanyOrOrganization { get; set; } - /// - ///The email address of the specified user or the email address associated with the specified entity. - /// public string Email { get; set; } /// @@ -50,34 +35,16 @@ public class CustomerContact /// public string FaxNumber { get; set; } - /// - ///The first name of the contact. The maximum character length is 200. - /// public string FirstName { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. - /// public string Label { get; set; } - /// - ///The last name or surname of the contact. The maximum character length is 200. - /// public string LastNameOrSurname { get; set; } - /// - ///The middle name or the first initial of the middle name of the contact. The maximum character length is 100. - /// public string MiddleNameOrInitial { get; set; } - /// - ///List of phone numbers associated with the customer account contact. The phone numbers include area codes. - /// public Phone PhoneNumbers { get; set; } /// diff --git a/Mozu.Api/Contracts/Customer/CustomerContactCollection.cs b/Mozu.Api/Contracts/Customer/CustomerContactCollection.cs old mode 100644 new mode 100755 index 030989bc..e23b9d0b --- a/Mozu.Api/Contracts/Customer/CustomerContactCollection.cs +++ b/Mozu.Api/Contracts/Customer/CustomerContactCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Customer /// public class CustomerContactCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerLoginInfo.cs b/Mozu.Api/Contracts/Customer/CustomerLoginInfo.cs old mode 100644 new mode 100755 index f52a0491..97360ee3 --- a/Mozu.Api/Contracts/Customer/CustomerLoginInfo.cs +++ b/Mozu.Api/Contracts/Customer/CustomerLoginInfo.cs @@ -19,27 +19,24 @@ namespace Mozu.Api.Contracts.Customer public class CustomerLoginInfo { /// - ///The email address for the customer account and contact. This email may be used for login to the storefront and for subscription mailing lists. + ///The email address associated with the customer login. /// public string EmailAddress { get; set; } - /// - ///If you are importing existing customer accounts to or using two customer systems simultaneously, you use this property to store an external password hash that helps you migrate existing customer accounts seamlessly into , without having to require shoppers to create new passwords for the platform. If you set this property, you must use the [embedded.verifyExternalPassword](https://www.mozu.com/docs/arcjs/commerce-customer/actions/verifyexternalpassword.htm) action to verify that the hashed version of a cleartext password provided by a shopper matches the external password hash specified in this property. - /// public string ExternalPassword { get; set; } /// - ///Indicates if this object/data was imported from an outside source such as a data import or synchronization via an app or service. If true, this data was originally imported into and accessible through your store database. Examples of imported objects/data include orders and customer accounts. + ///If true, this customer account data was imported from an external program. /// public bool? IsImport { get; set; } /// - ///The write-only password for the customer account. + ///The password associated with the customer login. /// public string Password { get; set; } /// - ///The user name associated with the user profile. The customer uses the user name to access the account. + ///The user name associated with the customer login. /// public string Username { get; set; } diff --git a/Mozu.Api/Contracts/Customer/CustomerNote.cs b/Mozu.Api/Contracts/Customer/CustomerNote.cs old mode 100644 new mode 100755 index 19d6d79e..3ff259c7 --- a/Mozu.Api/Contracts/Customer/CustomerNote.cs +++ b/Mozu.Api/Contracts/Customer/CustomerNote.cs @@ -19,19 +19,10 @@ namespace Mozu.Api.Contracts.Customer /// public class CustomerNote { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes. - /// public string Content { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerNoteCollection.cs b/Mozu.Api/Contracts/Customer/CustomerNoteCollection.cs old mode 100644 new mode 100755 index d85fe54b..91df0d46 --- a/Mozu.Api/Contracts/Customer/CustomerNoteCollection.cs +++ b/Mozu.Api/Contracts/Customer/CustomerNoteCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Customer /// public class CustomerNoteCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderAccount.cs b/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderAccount.cs old mode 100644 new mode 100755 index ee727647..26c452a5 --- a/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderAccount.cs +++ b/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderAccount.cs @@ -15,59 +15,26 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// The details of a customer's purchase order account. - /// public class CustomerPurchaseOrderAccount { - /// - ///Unique identifier of the customer account generated by the system. Account IDs are generated at account creation. - /// public int AccountId { get; set; } - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The available balance the customer has on their purchase order account. This balance is the result of the minus the customer's total amount due. - /// public decimal AvailableBalance { get; set; } - /// - ///The total credit limit the customer can spend using purchase orders. - /// public decimal CreditLimit { get; set; } - /// - ///The specific payment terms for the customer's purchase order account. Each payment term is associated with a specific site, and you can specify more than one payment term for each site. - /// public List CustomerPurchaseOrderPaymentTerms { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order. - /// public bool IsEnabled { get; set; } - /// - ///The total monetary amount the customer can spend over their purchase order . The controls the units of this amount. - /// public decimal? OverdraftAllowance { get; set; } - /// - ///Specifies the type and units of the amount.The valid values are:* — specifies that the amount is a decimal amount.* — specifies that the amount is a percentage amount. - /// public string OverdraftAllowanceType { get; set; } - /// - ///The total available balance the customer has on their purchase order account. This balance is the result of the minus the . - /// public decimal TotalAvailableBalance { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderAccountCollection.cs b/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderAccountCollection.cs old mode 100644 new mode 100755 index 074dade8..874b6eb9 --- a/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderAccountCollection.cs +++ b/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderAccountCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// A list of customer purchase order accounts and their details. - /// public class CustomerPurchaseOrderAccountCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderPaymentTerm.cs b/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderPaymentTerm.cs old mode 100644 new mode 100755 index 88a03514..a731b85a --- a/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderPaymentTerm.cs +++ b/Mozu.Api/Contracts/Customer/CustomerPurchaseOrderPaymentTerm.cs @@ -14,29 +14,14 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// The purchase order payment terms that are associated with the specific customer account. Usually the payment terms are an amount of time, such as a certain amount of days the customer has in order to pay the order balance in full. - /// public class CustomerPurchaseOrderPaymentTerm { - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The code of the payment term associated with the customer purchase order account. This term must match the payment term code specified in the purchase order site settings.Refer to [Payment Terms](https://www.mozu.com/guides/orders/purchase-order.htm#payment_terms) in the Purchase Order guides topic for more information. - /// public string Code { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int SiteId { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerSegment.cs b/Mozu.Api/Contracts/Customer/CustomerSegment.cs old mode 100644 new mode 100755 index ffa742f2..925994a3 --- a/Mozu.Api/Contracts/Customer/CustomerSegment.cs +++ b/Mozu.Api/Contracts/Customer/CustomerSegment.cs @@ -27,17 +27,17 @@ public class CustomerSegment public string Code { get; set; } /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. + ///Description of the customer segment. /// public string Description { get; set; } /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: + ///Unique identifier of the customer segment. System-supplied and read only. /// public int Id { get; set; } /// - ///The user supplied name that appears in . You can use this field for identification purposes. + ///Name of the customer segment. /// public string Name { get; set; } diff --git a/Mozu.Api/Contracts/Customer/CustomerSegmentCollection.cs b/Mozu.Api/Contracts/Customer/CustomerSegmentCollection.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/Customer/CustomerSet.cs b/Mozu.Api/Contracts/Customer/CustomerSet.cs old mode 100644 new mode 100755 index d58a4a9b..d20b81d4 --- a/Mozu.Api/Contracts/Customer/CustomerSet.cs +++ b/Mozu.Api/Contracts/Customer/CustomerSet.cs @@ -15,44 +15,20 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// The details of the customer set. - /// public class CustomerSet { - /// - ///A collection of aggregate information about the customer set, including the amount of sites and customers assocaited with the customer set. - /// public CustomerSetAggregateInfo AggregateInfo { get; set; } - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The unique identifier of the customer set. - /// public string Code { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Indicates if the object is default. This indicator is used for product variations and site search settings. If true, the value/object is the default option. - /// public bool IsDefault { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Collection of sites associated with the tenant. - /// public List Sites { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerSetAggregateInfo.cs b/Mozu.Api/Contracts/Customer/CustomerSetAggregateInfo.cs old mode 100644 new mode 100755 index 57291728..b6e765a0 --- a/Mozu.Api/Contracts/Customer/CustomerSetAggregateInfo.cs +++ b/Mozu.Api/Contracts/Customer/CustomerSetAggregateInfo.cs @@ -13,14 +13,8 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// This property is not used. - /// public class CustomerSetAggregateInfo { - /// - ///The amount of customers associated with the customer set. - /// public int CustomerCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerSetCollection.cs b/Mozu.Api/Contracts/Customer/CustomerSetCollection.cs old mode 100644 new mode 100755 index b0f527d5..6cfeb53f --- a/Mozu.Api/Contracts/Customer/CustomerSetCollection.cs +++ b/Mozu.Api/Contracts/Customer/CustomerSetCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// A collection of customer sets and their details. - /// public class CustomerSetCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerSetSite.cs b/Mozu.Api/Contracts/Customer/CustomerSetSite.cs old mode 100644 new mode 100755 index 47ff0318..47529f90 --- a/Mozu.Api/Contracts/Customer/CustomerSetSite.cs +++ b/Mozu.Api/Contracts/Customer/CustomerSetSite.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// The site identifier assigned to the customer set. - /// public class CustomerSetSite { - /// - ///The unique code of the customer set. - /// public string CustomerSetCode { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int SiteId { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/CustomerUserAuthInfo.cs b/Mozu.Api/Contracts/Customer/CustomerUserAuthInfo.cs old mode 100644 new mode 100755 index 944062c6..51a862b0 --- a/Mozu.Api/Contracts/Customer/CustomerUserAuthInfo.cs +++ b/Mozu.Api/Contracts/Customer/CustomerUserAuthInfo.cs @@ -19,12 +19,12 @@ namespace Mozu.Api.Contracts.Customer public class CustomerUserAuthInfo { /// - ///The write-only password for the customer account. + ///The password of the user associated with the customer account. /// public string Password { get; set; } /// - ///The user name associated with the user profile. The customer uses the user name to access the account. + ///The user name of the user associated with the customer account. /// public string Username { get; set; } diff --git a/Mozu.Api/Contracts/Customer/InStockNotificationSubscription.cs b/Mozu.Api/Contracts/Customer/InStockNotificationSubscription.cs old mode 100644 new mode 100755 index 8cca722f..c3dae9b7 --- a/Mozu.Api/Contracts/Customer/InStockNotificationSubscription.cs +++ b/Mozu.Api/Contracts/Customer/InStockNotificationSubscription.cs @@ -25,7 +25,7 @@ public class InStockNotificationSubscription public AuditInfo AuditInfo { get; set; } /// - ///Unique identifier of the customer in , used to associate customers with data, orders, returns, and in-store credit. + ///Unique identifier of the customer associated with the in-stock notification subscription. /// public int? CustomerId { get; set; } @@ -35,12 +35,12 @@ public class InStockNotificationSubscription public string Email { get; set; } /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: + ///Unique identifier of the customer in-stock notification subscription. /// public int? Id { get; set; } /// - ///The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. + ///Tenant-defined code that identifies the customer in-stock notification subscription. /// public string LocationCode { get; set; } diff --git a/Mozu.Api/Contracts/Customer/InStockNotificationSubscriptionCollection.cs b/Mozu.Api/Contracts/Customer/InStockNotificationSubscriptionCollection.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/Customer/LoginState.cs b/Mozu.Api/Contracts/Customer/LoginState.cs old mode 100644 new mode 100755 index c647c9ab..795ca13a --- a/Mozu.Api/Contracts/Customer/LoginState.cs +++ b/Mozu.Api/Contracts/Customer/LoginState.cs @@ -24,42 +24,42 @@ public class LoginState public DateTime? CreatedOn { get; set; } /// - ///The total number of failed authentication attempts associated with a customer account attempting access. + ///The total number of times the customer account has unsuccessfully attempted to log in. /// public byte FailedLoginAttemptCount { get; set; } /// - ///The date and time the initial login was unsuccessful. System-supplied and read only. Each time user authentication fails, an update occurs on this field. The amount of failures is calculated together for `failedLoginAttemptCount`. + ///The date and time the customer's first unsuccessful attempt to log in was recorded. /// public DateTime? FirstFailedLoginAttemptOn { get; set; } /// - ///Indicates if a customer account and associated data is locked. If true, the user account is locked due to multiple failed authentication attempts. The user cannot login until the account is unlocked. + ///If true, the customer account is locked and the customer cannot log in. /// public bool IsLocked { get; set; } /// - ///Indicates if the customer account must have the password changed on login. If true, the login action requires a password change for increased security. If false, the login does not require a password change. + ///If true, the customer account user must change the password for the account. /// public bool IsPasswordChangeRequired { get; set; } /// - ///Provides date and time data when the customer's account was last locked. System-supplied and read-only. + ///The date and time the customer account was most recently locked. /// public DateTime? LastLockedOn { get; set; } /// - ///Provides the date and time the customer last logged into the store. System-supplied and read-only. + ///The date and time the customer account last logged in. /// public DateTime? LastLoginOn { get; set; } /// - ///Date and time the customer's password was last modified. System-supplied and read-only. + ///The date and the time the user associated with the customer account last changed the account password. /// public DateTime? LastPasswordChangeOn { get; set; } /// - ///The number of login attempts remaining for the customer. The user must login successfully before this value reaches zero otherwise the account locks. + ///The remaining number of login attempts the customer can perform before the system locks the customer account. /// public int RemainingLoginAttempts { get; set; } diff --git a/Mozu.Api/Contracts/Customer/PasswordInfo.cs b/Mozu.Api/Contracts/Customer/PasswordInfo.cs old mode 100644 new mode 100755 index 73b7887c..76d7f9be --- a/Mozu.Api/Contracts/Customer/PasswordInfo.cs +++ b/Mozu.Api/Contracts/Customer/PasswordInfo.cs @@ -18,13 +18,10 @@ namespace Mozu.Api.Contracts.Customer /// public class PasswordInfo { - /// - ///If you are importing existing customer accounts to or using two customer systems simultaneously, you use this property to store an external password hash that helps you migrate existing customer accounts seamlessly into , without having to require shoppers to create new passwords for the platform. If you set this property, you must use the [embedded.verifyExternalPassword](https://www.mozu.com/docs/arcjs/commerce-customer/actions/verifyexternalpassword.htm) action to verify that the hashed version of a cleartext password provided by a shopper matches the external password hash specified in this property. - /// public string ExternalPassword { get; set; } /// - ///The new password entered and saved by the user of the account. + ///The new account password value. /// public string NewPassword { get; set; } diff --git a/Mozu.Api/Contracts/Customer/PurchaseOrderTransaction.cs b/Mozu.Api/Contracts/Customer/PurchaseOrderTransaction.cs old mode 100644 new mode 100755 index a6535775..ed98f878 --- a/Mozu.Api/Contracts/Customer/PurchaseOrderTransaction.cs +++ b/Mozu.Api/Contracts/Customer/PurchaseOrderTransaction.cs @@ -14,84 +14,36 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// The details of the purchase order payment transaction. - /// public class PurchaseOrderTransaction { - /// - ///Additional transaction details or notes associated with the transaction. - /// public string AdditionalTransactionDetail { get; set; } - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The author of the purchase order transaction. - /// public string Author { get; set; } - /// - ///The available balance the customer has on their purchase order account. This balance is the result of the minus the customer's total amount due. - /// public decimal AvailableBalance { get; set; } - /// - ///The total credit limit the customer can spend using purchase orders. - /// public decimal CreditLimit { get; set; } - /// - ///The unique identifier of the customer purchase order account. - /// public int CustomerPurchaseOrderAccountId { get; set; } - /// - ///Unique identifier used by an external program to identify a order, customer account, or wish list. - /// public string ExternalId { get; set; } - /// - ///Unique identifier of the order associated with the payment. - /// public string OrderId { get; set; } - /// - ///The purchase order number. - /// public string PurchaseOrderNumber { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int SiteId { get; set; } - /// - ///Unique identifier for the tenant. - /// public int TenantId { get; set; } - /// - ///The amount of the purchase order transaction. - /// public decimal TransactionAmount { get; set; } - /// - ///The date when the purchase order transaction was made on a purchase order account. - /// public DateTime TransactionDate { get; set; } - /// - ///A description of the purchase order transaction type.This field is read-only dependent on the value of .* * * * * * - /// public string TransactionDescription { get; set; } - /// - ///The type of the purchase order transaction.The valid values are:* — Line of Credit Change* — Payment Requested* — Payment Collected * — Payment Voided* — Payment Refund* — Manual Adjustment - /// public int TransactionTypeId { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/PurchaseOrderTransactionCollection.cs b/Mozu.Api/Contracts/Customer/PurchaseOrderTransactionCollection.cs old mode 100644 new mode 100755 index dc606dd1..c3497fe0 --- a/Mozu.Api/Contracts/Customer/PurchaseOrderTransactionCollection.cs +++ b/Mozu.Api/Contracts/Customer/PurchaseOrderTransactionCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.Customer { - /// - /// A collection of purchase order payment transactions and their details. - /// public class PurchaseOrderTransactionCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/ResetPasswordInfo.cs b/Mozu.Api/Contracts/Customer/ResetPasswordInfo.cs old mode 100644 new mode 100755 index d7c877a6..33c5cad6 --- a/Mozu.Api/Contracts/Customer/ResetPasswordInfo.cs +++ b/Mozu.Api/Contracts/Customer/ResetPasswordInfo.cs @@ -18,9 +18,6 @@ namespace Mozu.Api.Contracts.Customer /// public class ResetPasswordInfo { - /// - ///The unique code of the customer set. - /// public string CustomerSetCode { get; set; } /// @@ -29,7 +26,7 @@ public class ResetPasswordInfo public string EmailAddress { get; set; } /// - ///The user name associated with the user profile. The customer uses the user name to access the account. + ///User name of the user associated with the customer account. /// public string UserName { get; set; } diff --git a/Mozu.Api/Contracts/Customer/Transaction.cs b/Mozu.Api/Contracts/Customer/Transaction.cs old mode 100644 new mode 100755 index f358fae9..698e21a7 --- a/Mozu.Api/Contracts/Customer/Transaction.cs +++ b/Mozu.Api/Contracts/Customer/Transaction.cs @@ -18,39 +18,18 @@ namespace Mozu.Api.Contracts.Customer /// public class Transaction { - /// - ///If applicable, the amount of the transaction. - /// public decimal Amount { get; set; } - /// - ///The localized currency code for the monetary amount. - /// public string CurrencyCode { get; set; } - /// - ///The date and time recording for a customer action including a transaction and storefront visit. - /// public DateTime Date { get; set; } - /// - ///The type of payment interaction. The payment can be Capture or CheckReceived. The value also includes customer payment interactions such as Website, Call, Store, or Unknown. - /// public string InteractionType { get; set; } - /// - ///The unique identifier of the transaction. - /// public string TransactionId { get; set; } - /// - ///Specifies the type of transaction, including customer transactions and credit transactions.Valid values for credit transactions are the following:* —decreases the credit amount* —updates the credit amountValid values for customer transaction types are the following:* * * * - /// public string TransactionType { get; set; } - /// - ///Unique identifier of the customer visit in which the cart was created or last modified. - /// public string VisitId { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/Visit.cs b/Mozu.Api/Contracts/Customer/Visit.cs old mode 100644 new mode 100755 index 1618382d..3efc57e4 --- a/Mozu.Api/Contracts/Customer/Visit.cs +++ b/Mozu.Api/Contracts/Customer/Visit.cs @@ -19,64 +19,28 @@ namespace Mozu.Api.Contracts.Customer /// public class Visit { - /// - ///Unique identifier of the customer account generated by the system. Account IDs are generated at account creation. - /// public int? AccountId { get; set; } - /// - ///If the customer visit is made online, the location code associated with the website visited. - /// public string BrowserLocationCode { get; set; } - /// - ///The date and time recording for a customer action including a transaction and storefront visit. - /// public DateTime Date { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. - /// public string LocationCode { get; set; } - /// - ///Array list of transactions the customer performed during the visit. A customer can perform multiple transactions in a single visit, or the visit can have no associated transactions. - /// public List Transactions { get; set; } - /// - ///The type of customer visit, which is "Website," "Store," "Call," or "Unknown." - /// public string Type { get; set; } - /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. - /// public string UserId { get; set; } - /// - ///The HTTP_Referrer that initiatied the visit started. If the shopper was not referred from another source, this value is null. - /// public string WebReferrer { get; set; } - /// - ///Unique identifier of the web session in which the cart, order, return, or wish list was created or last modified. - /// public string WebSessionId { get; set; } - /// - ///Unique identifier of the site. - /// public int? WebSiteId { get; set; } - /// - ///The user agent string for the browser. - /// public string WebUserAgent { get; set; } } diff --git a/Mozu.Api/Contracts/Customer/VisitCollection.cs b/Mozu.Api/Contracts/Customer/VisitCollection.cs old mode 100644 new mode 100755 index 04c2f252..e0a4ff82 --- a/Mozu.Api/Contracts/Customer/VisitCollection.cs +++ b/Mozu.Api/Contracts/Customer/VisitCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Customer /// public class VisitCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Event/Event.cs b/Mozu.Api/Contracts/Event/Event.cs old mode 100644 new mode 100755 index 55e56b22..804fd59e --- a/Mozu.Api/Contracts/Event/Event.cs +++ b/Mozu.Api/Contracts/Event/Event.cs @@ -16,18 +16,12 @@ namespace Mozu.Api.Contracts.Event { /// - /// Mozu.AppDev.Contracts.Event ApiType DOCUMENT_HERE + /// Properties of an event the system creates each time a create, read, update, or delete operation is performed. /// public class Event { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The unique identifier of the catalog of products used by a site. - /// public int? CatalogId { get; set; } /// @@ -35,43 +29,22 @@ public class Event /// public string CorrelationId { get; set; } - /// - ///The unique identifier of the entity that caused the event. For example, if the event is "product.created", the entity ID value represents the product code of the product that was created. - /// public string EntityId { get; set; } public string EventId { get; set; } - /// - ///Extended properties. Note: This is purposefully not a CollectionBase type wrapper so consumers start to get used to not having counts returned. - /// public List ExtendedProperties { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Indicates if the event is a test request or test entity. If true, the generated and captured event record was generated as a test request for an application. - /// public bool? IsTest { get; set; } - /// - ///The unique identifier of the master catalog associated with the entity. - /// public int? MasterCatalogId { get; set; } public int? SiteId { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int? TenantId { get; set; } - /// - ///The type of event that was performed, such as "product.created" or "category.deleted". - /// public string Topic { get; set; } } diff --git a/Mozu.Api/Contracts/Event/EventCollection.cs b/Mozu.Api/Contracts/Event/EventCollection.cs old mode 100644 new mode 100755 index 61cf2451..94b2f530 --- a/Mozu.Api/Contracts/Event/EventCollection.cs +++ b/Mozu.Api/Contracts/Event/EventCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.Event /// public class EventCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Event/EventDeliveryAttempt.cs b/Mozu.Api/Contracts/Event/EventDeliveryAttempt.cs old mode 100644 new mode 100755 index 890b7362..c3b5a81b --- a/Mozu.Api/Contracts/Event/EventDeliveryAttempt.cs +++ b/Mozu.Api/Contracts/Event/EventDeliveryAttempt.cs @@ -13,34 +13,16 @@ namespace Mozu.Api.Contracts.Event { - /// - /// Properties and information captured for an attempted delivery that failed. - /// public class EventDeliveryAttempt { - /// - ///Status of the delivery process `EventDeliveryStatusType`. System-supplied and read-only. - /// public string DeliveryStatus { get; set; } - /// - ///Type of error that occurred, if the delivery was unsuccessful - /// public string ErrorType { get; set; } - /// - ///The date that the delivery was attempted - /// public DateTime? ExecutionDate { get; set; } - /// - ///The HTTP Status (code and name) returned by the remote endpoint - /// public HttpStatus HttpStatus { get; set; } - /// - ///The text of the change message, such as "This product is no longer available." System-supplied and read-only. - /// public string Message { get; set; } } diff --git a/Mozu.Api/Contracts/Event/EventDeliverySummary.cs b/Mozu.Api/Contracts/Event/EventDeliverySummary.cs old mode 100644 new mode 100755 index 482ee754..4840a351 --- a/Mozu.Api/Contracts/Event/EventDeliverySummary.cs +++ b/Mozu.Api/Contracts/Event/EventDeliverySummary.cs @@ -14,59 +14,26 @@ namespace Mozu.Api.Contracts.Event { - /// - /// Data for event deliveries. Returned content details a summary of actions, events, and results for a delivery event. - /// public class EventDeliverySummary { - /// - ///The date and time in UTC format set when the object was created. - /// public DateTime? CreateDate { get; set; } - /// - ///Details about each attempted delivery of the event to the endpoint - /// public List DeliveryAttempts { get; set; } - /// - ///Status of the delivery process `EventDeliveryStatusType`. System-supplied and read-only. - /// public string DeliveryStatus { get; set; } - /// - ///Event Summary - /// public EventSummary EventSummary { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///Indicates whether delivery of the event is currently being attempted at this moment in time - /// public bool IsRunning { get; set; } - /// - ///The date that the delivery was last attempted (either successfully or not) - /// public DateTime LastExecutionDate { get; set; } - /// - ///The date that the delivery will next be attempted, if the event has not been successfully delivered yet and there are still retries remaining - /// public DateTime NextExecutionDate { get; set; } - /// - ///Number of delivery attempts remaining - /// public int? RetriesRemaining { get; set; } - /// - ///The date and time in UTC format the object was updated most recently. - /// public DateTime? UpdateDate { get; set; } } diff --git a/Mozu.Api/Contracts/Event/EventDeliverySummaryCollection.cs b/Mozu.Api/Contracts/Event/EventDeliverySummaryCollection.cs old mode 100644 new mode 100755 index 85e44c92..2b4068bf --- a/Mozu.Api/Contracts/Event/EventDeliverySummaryCollection.cs +++ b/Mozu.Api/Contracts/Event/EventDeliverySummaryCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.Event { - /// - /// Collection of data for event deliveries. Returned content details a summary of actions, events, and results for a delivery event. - /// public class EventDeliverySummaryCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Event/EventExtendedProperty.cs b/Mozu.Api/Contracts/Event/EventExtendedProperty.cs old mode 100644 new mode 100755 index 2c950d1d..b475107e --- a/Mozu.Api/Contracts/Event/EventExtendedProperty.cs +++ b/Mozu.Api/Contracts/Event/EventExtendedProperty.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.Event { - /// - /// Key and value data for an extended property event. - /// public class EventExtendedProperty { - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/Event/EventSummary.cs b/Mozu.Api/Contracts/Event/EventSummary.cs old mode 100644 new mode 100755 index 96abf338..597835b0 --- a/Mozu.Api/Contracts/Event/EventSummary.cs +++ b/Mozu.Api/Contracts/Event/EventSummary.cs @@ -14,49 +14,22 @@ namespace Mozu.Api.Contracts.Event { - /// - /// Properties of events as a summary of actions, data, and responses. - /// public class EventSummary { - /// - ///The unique identifier for the product catalog. Catalogs are part of a master catalog. - /// public int? CatalogId { get; set; } - /// - ///The unique identifier of the API request associated with the event action, which might contain multiple actions. - /// public string CorrelationId { get; set; } - /// - ///The date and time in UTC format set when the object was created. - /// public DateTime? CreateDate { get; set; } - /// - ///The unique identifier of the entity that caused the event. For example, if the event is "product.created", the entity ID value represents the product code of the product that was created. - /// public string EntityId { get; set; } - /// - ///Unique identifier for the event. - /// public string EventId { get; set; } - /// - ///Extended properties. Note: This is purposefully not a CollectionBase type wrapper so consumers start to get used to not having counts returned. - /// public List ExtendedProperties { get; set; } - /// - ///Unique identifier for the master catalog. - /// public int? MasterCatalogId { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int? SiteId { get; set; } /// @@ -64,9 +37,6 @@ public class EventSummary /// public int? TenantId { get; set; } - /// - ///The type of event that was performed, such as "product.created" or "category.deleted". - /// public string Topic { get; set; } } diff --git a/Mozu.Api/Contracts/Event/HttpStatus.cs b/Mozu.Api/Contracts/Event/HttpStatus.cs old mode 100644 new mode 100755 index b69defb3..a003abd9 --- a/Mozu.Api/Contracts/Event/HttpStatus.cs +++ b/Mozu.Api/Contracts/Event/HttpStatus.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.Event { - /// - /// Properties for the HTTP status for an event. - /// public class HttpStatus { - /// - ///The higher-level integer based HTTP Status Code returned by the remote endpoint - /// public int Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/Event/SubscribingSite.cs b/Mozu.Api/Contracts/Event/SubscribingSite.cs old mode 100644 new mode 100755 index 3526e47a..4a82260f --- a/Mozu.Api/Contracts/Event/SubscribingSite.cs +++ b/Mozu.Api/Contracts/Event/SubscribingSite.cs @@ -14,9 +14,6 @@ namespace Mozu.Api.Contracts.Event { - /// - /// Properties for the site associated with a subscription including audit info, if active, and the unique ID for the site. - /// public class SubscribingSite { /// @@ -25,13 +22,10 @@ public class SubscribingSite public AuditInfo AuditInfo { get; set; } /// - ///Indicates if the object or feature is active. + ///This specifies if the subscription is active at the site level. /// public bool? IsActive { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int? SiteId { get; set; } } diff --git a/Mozu.Api/Contracts/Event/SubscribingTenant.cs b/Mozu.Api/Contracts/Event/SubscribingTenant.cs old mode 100644 new mode 100755 index 7e0d9edd..dfca957c --- a/Mozu.Api/Contracts/Event/SubscribingTenant.cs +++ b/Mozu.Api/Contracts/Event/SubscribingTenant.cs @@ -26,7 +26,7 @@ public class SubscribingTenant public AuditInfo AuditInfo { get; set; } /// - ///Indicates if the object or feature is active. + ///This specifies if the subscription is active at the tenant level. If the subscription context is at the tenant level, this property is used over the site level. /// public bool? IsActive { get; set; } @@ -41,7 +41,7 @@ public class SubscribingTenant public List SubscribingSites { get; set; } /// - ///Unique identifier for the tenant. + ///This specifies the tenant identifier. /// public int? TenantId { get; set; } diff --git a/Mozu.Api/Contracts/Event/Subscription.cs b/Mozu.Api/Contracts/Event/Subscription.cs old mode 100644 new mode 100755 index 8249610c..c897b831 --- a/Mozu.Api/Contracts/Event/Subscription.cs +++ b/Mozu.Api/Contracts/Event/Subscription.cs @@ -14,64 +14,28 @@ namespace Mozu.Api.Contracts.Event { - /// - /// The subscription entity used to provide event notifications for third-parties. - /// public class Subscription { - /// - ///ApiVersion - /// public string ApiVersion { get; set; } - /// - ///Unique identifier of an app available in your tenant or within Dev Center. This ID is unique across all apps installed, initialized, and enabled in the and those in development through the Dev Center Console. - /// public string AppId { get; set; } - /// - ///A boolean value that indicates if the subscription endpoint has been confirmed - /// public bool? Confirmed { get; set; } - /// - ///Content type of the payload that will be delivered. This is utilized in combination with the notification delivery type. Example: A HTTP Post (notification delivery type) is performed with a JSON representation of the event data (content type). - /// public string ContentType { get; set; } - /// - ///Identifier of the user that created the object. System created and read only. - /// public string CreateBy { get; set; } - /// - ///The date and time in UTC format set when the object was created. - /// public DateTime? CreateDate { get; set; } - /// - ///The delivery endpoint that will receive notifications when events concerning the specified topics on the subscription occur. The format of the endpoint may differ depending on the notification type. For example, the endpoint may be a URL in some cases and an email address in others if multiple notification types are available. - /// public string Endpoint { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Indicates if the object or feature is active. - /// public bool? IsActive { get; set; } - /// - ///A boolean value that indicates if events should be delivered that resulted from an API call by the application. If true, any events that occur as a result of a direct API call by the same application will not be delivered. This can prevent an endless loop in certain scenarios. - /// public bool? NoCallback { get; set; } - /// - ///Notification delivery type which is a string representation of an enumeration of values. Example: Http (this is case insensitive, so http may also be passed in) - /// public string NotificationDeliveryType { get; set; } /// @@ -79,19 +43,10 @@ public class Subscription /// public List SubscribingTenants { get; set; } - /// - ///A list of topics that the subscription relates to - /// public List Topics { get; set; } - /// - ///Identifier of the user that updated the entity most recently. - /// public string UpdateBy { get; set; } - /// - ///The date and time in UTC format the object was updated most recently. - /// public DateTime? UpdateDate { get; set; } } diff --git a/Mozu.Api/Contracts/Event/SubscriptionCollection.cs b/Mozu.Api/Contracts/Event/SubscriptionCollection.cs old mode 100644 new mode 100755 index f9635fce..5e47c6d7 --- a/Mozu.Api/Contracts/Event/SubscriptionCollection.cs +++ b/Mozu.Api/Contracts/Event/SubscriptionCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.Event { - /// - /// Paged collection subscription entities used to provide event notifications for third-parties. - /// public class SubscriptionCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/InstalledApplications/Application.cs b/Mozu.Api/Contracts/InstalledApplications/Application.cs old mode 100644 new mode 100755 index 591c149b..80fb3862 --- a/Mozu.Api/Contracts/InstalledApplications/Application.cs +++ b/Mozu.Api/Contracts/InstalledApplications/Application.cs @@ -15,18 +15,15 @@ namespace Mozu.Api.Contracts.InstalledApplications { /// - /// Properties of an app installed in a tenant. + /// Properties of an application installed in a tenant. /// public class Application { /// - ///Unique identifier of an app available in your tenant or within Dev Center. This ID is unique across all apps installed, initialized, and enabled in the and those in development through the Dev Center Console. + ///The unique identifier of the application in Mozu Dev Center. /// public string AppId { get; set; } - /// - ///Unique identifier of an app or theme available in your tenant or within Dev Center. An appKey is composed of Developer Account namespace, app/theme ID, version, and package (e.g., devAccount.helloWorld.1.0.0.Release). - /// public string AppKey { get; set; } /// @@ -35,27 +32,24 @@ public class Application public List Capabilities { get; set; } /// - ///Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists. + ///If true, the application is enabled for the tenant. System-supplied and read-only. /// public bool? Enabled { get; set; } /// - ///Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage. + ///If true, the third party application settings have been configured and the application is initialized. /// public bool? Initialized { get; set; } /// - ///Indicates if the installed application is of type extension. An extension is an application that extends upon the infrastructure. Examples of extensions include Arc.js applications and applications that integrate third-party services. + ///If true, the application type is Extension. /// public bool? IsExtension { get; set; } - /// - ///Indicates if an Arc.js application is certified to run on tenants that lack a full installation of the Arc.js framework. - /// public bool? IsExtensionCertified { get; set; } /// - ///The URL defined for the application that represents the configuration website for the capability. This value is used by installed applications or the site. + ///The URL defined for the application that represents the configuration website for the capability. /// public string UiConfigurationUrl { get; set; } diff --git a/Mozu.Api/Contracts/InstalledApplications/Capability.cs b/Mozu.Api/Contracts/InstalledApplications/Capability.cs old mode 100644 new mode 100755 index f2b98d88..9d3e213e --- a/Mozu.Api/Contracts/InstalledApplications/Capability.cs +++ b/Mozu.Api/Contracts/InstalledApplications/Capability.cs @@ -26,17 +26,17 @@ public class Capability public List ActiveCreditTypes { get; set; } /// - ///Array list of the countries (by country code) to which this capability can actively ship. The entered shipping country is validated against a list of supported shipping countries. Messages return if the country code is not supported or duplicated. Supported carriers are also checked per country code. + ///Array list of the countries to which this capability can actively ship. /// public List ActiveShippingCountries { get; set; } /// - ///Array list of the countries (by country code) for which this capability can actively shop. All active shopping countries must be in the supported shopping country list. Validation rules determine the supported validity of the entered country against the list. + ///Array list of the countries for which this capability can actively shop. /// public List ActiveShoppingCountries { get; set; } /// - ///The enablement mode of the capability, typically read only. + ///The enablement mode of the capability. /// public string CapabilityMode { get; set; } @@ -46,17 +46,17 @@ public class Capability public string CapabilityType { get; set; } /// - ///Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists. + ///If true, the capability is enabled in the installed tenant. /// public bool? Enabled { get; set; } /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: + ///Unique identifier of the capability. /// public string Id { get; set; } /// - ///Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage. + ///If true, the application is initialized with the defined settings. /// public bool? Initialized { get; set; } @@ -66,12 +66,12 @@ public class Capability public List OperationUrls { get; set; } /// - ///The unique identifier of the scope. For example, if your scope type is site, then this value would be the site id. + ///Unique identifier of the developer account or tenant associated for which the capability is entitled. /// public int? ScopeId { get; set; } /// - ///The type of scope associated with the documentList. For example, if the documentList is pageTemplateContent, the scopeType is Site.Valid values are: "Tenant", "MasterCatalog", and "Site". + ///The type of scope for which the tenant is entitled, which is developer or tenant. /// public string ScopeType { get; set; } diff --git a/Mozu.Api/Contracts/InstalledApplications/CredentialStoreEntry.cs b/Mozu.Api/Contracts/InstalledApplications/CredentialStoreEntry.cs old mode 100644 new mode 100755 index 043a5a40..57839f8e --- a/Mozu.Api/Contracts/InstalledApplications/CredentialStoreEntry.cs +++ b/Mozu.Api/Contracts/InstalledApplications/CredentialStoreEntry.cs @@ -15,19 +15,10 @@ namespace Mozu.Api.Contracts.InstalledApplications { - /// - /// Mozu.InstalledApplications.Contracts.CredentialStoreEntry ApiType DOCUMENT_HERE - /// public class CredentialStoreEntry { - /// - ///The full name of the credential store entry. - /// public string FullName { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public JObject Value { get; set; } } diff --git a/Mozu.Api/Contracts/InstalledApplications/CustomFunction.cs b/Mozu.Api/Contracts/InstalledApplications/CustomFunction.cs old mode 100644 new mode 100755 index ae4274ed..584ddd85 --- a/Mozu.Api/Contracts/InstalledApplications/CustomFunction.cs +++ b/Mozu.Api/Contracts/InstalledApplications/CustomFunction.cs @@ -15,44 +15,20 @@ namespace Mozu.Api.Contracts.InstalledApplications { - /// - /// Mozu.InstalledApplications.Contracts.CustomFunction ApiType DOCUMENT_HERE - /// public class CustomFunction { - /// - ///The Arc.js application key. - /// public string ApplicationKey { get; set; } - /// - ///Custom function-level settings specified as key-value pairs. - /// public JObject Configuration { get; set; } - /// - ///Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists. - /// public bool? Enabled { get; set; } - /// - ///The behavior to take when an error is encountered. "fault" or "continue". The default is "fault". - /// public string ExceptionBehavior { get; set; } - /// - ///The name of the custom function tied to a particular action. - /// public string FunctionId { get; set; } - /// - ///The priority level to assign to logs related to a particular function. Possible values mirror Apache's log4net: "all", "debug", "info", "warn", "error", "fatal", and "off". - /// public string LogLevel { get; set; } - /// - ///The number of milliseconds that the function waits before timing out. The default is 5000 milliseconds - /// public int? TimeoutMilliseconds { get; set; } } diff --git a/Mozu.Api/Contracts/InstalledApplications/CustomFunctionsForAction.cs b/Mozu.Api/Contracts/InstalledApplications/CustomFunctionsForAction.cs old mode 100644 new mode 100755 index 73019bb7..895abad0 --- a/Mozu.Api/Contracts/InstalledApplications/CustomFunctionsForAction.cs +++ b/Mozu.Api/Contracts/InstalledApplications/CustomFunctionsForAction.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.InstalledApplications { - /// - /// Mozu.InstalledApplications.Contracts.CustomFunctionsForAction ApiType DOCUMENT_HERE - /// public class CustomFunctionsForAction { - /// - ///The full action ID for a specific action. - /// public string ActionId { get; set; } - /// - ///An array of settings for a particular action. - /// public List Contexts { get; set; } } diff --git a/Mozu.Api/Contracts/InstalledApplications/CustomFunctionsForContext.cs b/Mozu.Api/Contracts/InstalledApplications/CustomFunctionsForContext.cs old mode 100644 new mode 100755 index 420a8ca2..f72ba46e --- a/Mozu.Api/Contracts/InstalledApplications/CustomFunctionsForContext.cs +++ b/Mozu.Api/Contracts/InstalledApplications/CustomFunctionsForContext.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.InstalledApplications { - /// - /// Mozu.InstalledApplications.Contracts.CustomFunctionsForContext ApiType DOCUMENT_HERE - /// public class CustomFunctionsForContext { - /// - ///The site ID for the site you want to apply a group of settings to. You do not need to provide this value if you want to apply the same settings to a particular action across all your sites. - /// public int? Context { get; set; } - /// - ///An array of custom functions tied to a particular action. - /// public List CustomFunctions { get; set; } } diff --git a/Mozu.Api/Contracts/InstalledApplications/ExtensionConfiguration.cs b/Mozu.Api/Contracts/InstalledApplications/ExtensionConfiguration.cs old mode 100644 new mode 100755 index 3f183148..2fd69cdb --- a/Mozu.Api/Contracts/InstalledApplications/ExtensionConfiguration.cs +++ b/Mozu.Api/Contracts/InstalledApplications/ExtensionConfiguration.cs @@ -15,19 +15,10 @@ namespace Mozu.Api.Contracts.InstalledApplications { - /// - /// Mozu.InstalledApplications.Contracts.ExtensionConfiguration ApiType DOCUMENT_HERE - /// public class ExtensionConfiguration { - /// - ///The Arc.js application key. - /// public string ApplicationKey { get; set; } - /// - ///Custom application-level settings specified as key-value pairs. - /// public JObject Configuration { get; set; } } diff --git a/Mozu.Api/Contracts/InstalledApplications/TenantExtensions.cs b/Mozu.Api/Contracts/InstalledApplications/TenantExtensions.cs old mode 100644 new mode 100755 index f40fee67..5e538155 --- a/Mozu.Api/Contracts/InstalledApplications/TenantExtensions.cs +++ b/Mozu.Api/Contracts/InstalledApplications/TenantExtensions.cs @@ -14,24 +14,12 @@ namespace Mozu.Api.Contracts.InstalledApplications { - /// - /// Mozu.InstalledApplications.Contracts.TenantExtensions ApiType DOCUMENT_HERE - /// public class TenantExtensions { - /// - ///The list of actions configured for the site. - /// public List Actions { get; set; } - /// - ///An array of settings that apply to all actions within the application. - /// public List Configurations { get; set; } - /// - ///The priority level to assign to application logs. Possible values mirror Apache's log4net: "all", "debug", "info", "warn", "error", "fatal", and "off". - /// public string DefaultLogLevel { get; set; } } diff --git a/Mozu.Api/Contracts/Location/Coordinates.cs b/Mozu.Api/Contracts/Location/Coordinates.cs old mode 100644 new mode 100755 index 65dc5f1e..c31f1d98 --- a/Mozu.Api/Contracts/Location/Coordinates.cs +++ b/Mozu.Api/Contracts/Location/Coordinates.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Location /// public class Coordinates { - /// - ///The latitude coordinate of the location. - /// public double Lat { get; set; } - /// - ///The longitude coordinate of the location. - /// public double Lng { get; set; } } diff --git a/Mozu.Api/Contracts/Location/FulfillmentType.cs b/Mozu.Api/Contracts/Location/FulfillmentType.cs old mode 100644 new mode 100755 index 0f9ff750..464ea88f --- a/Mozu.Api/Contracts/Location/FulfillmentType.cs +++ b/Mozu.Api/Contracts/Location/FulfillmentType.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Location /// public class FulfillmentType { - /// - ///The system-supplied code that identifies the fulfillment type, which is "DS" for direct ship or "SP" for in-store pickup. - /// public string Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/Location/Hours.cs b/Mozu.Api/Contracts/Location/Hours.cs old mode 100644 new mode 100755 index 494674e6..4599cb2c --- a/Mozu.Api/Contracts/Location/Hours.cs +++ b/Mozu.Api/Contracts/Location/Hours.cs @@ -18,9 +18,6 @@ namespace Mozu.Api.Contracts.Location /// public class Hours { - /// - ///Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. - /// public string Label { get; set; } } diff --git a/Mozu.Api/Contracts/Location/Location.cs b/Mozu.Api/Contracts/Location/Location.cs old mode 100644 new mode 100755 index 0668debd..da8da7e0 --- a/Mozu.Api/Contracts/Location/Location.cs +++ b/Mozu.Api/Contracts/Location/Location.cs @@ -20,71 +20,34 @@ namespace Mozu.Api.Contracts.Location /// public class Location { - /// - ///Address information to supply for a contact. - /// public Address Address { get; set; } - /// - ///Allow fullfillment with no (or less) stock - /// public bool AllowFulfillmentWithNoStock { get; set; } + public List Attributes { get; set; } + public AuditInfo AuditInfo { get; set; } - /// - ///User-defined code to assign to this location. - /// public string Code { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///The fax number associated with this location. - /// public string Fax { get; set; } - /// - ///List of order fulfillment types associated with this location. The location can have fulfillment types of direct ship (DS), in-store pickup (SP), or both. - /// public List FulfillmentTypes { get; set; } - /// - ///The geographical coordinates associated with this location. - /// public Coordinates Geo { get; set; } - /// - ///Locations is disabled (soft delete) - /// public bool IsDisabled { get; set; } - /// - ///List of location types associated with this location. You can associate individual locations with any number of location types. - /// public List LocationTypes { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///User-entered notation content for an object, used to save information such as payment, return, account, and order notes. - /// public string Note { get; set; } - /// - ///The phone number associated with this location. - /// public string Phone { get; set; } - /// - ///List of standard operating hours for each day of the week this location is open for shopper business. - /// public RegularHours RegularHours { get; set; } /// @@ -92,14 +55,8 @@ public class Location /// public ShippingOriginContact ShippingOriginContact { get; set; } - /// - ///If true, this location maintains its own product inventory. If the location uses the direct ship fulfillment type, it must also support inventory. - /// public bool SupportsInventory { get; set; } - /// - ///List of tenant-defined tags associated with this location. - /// public List Tags { get; set; } } diff --git a/Mozu.Api/Contracts/Location/LocationAttribute.cs b/Mozu.Api/Contracts/Location/LocationAttribute.cs new file mode 100755 index 00000000..1d51cfef --- /dev/null +++ b/Mozu.Api/Contracts/Location/LocationAttribute.cs @@ -0,0 +1,33 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +using Mozu.Api.Contracts.Core; +using Mozu.Api.Contracts.Core.Extensible; + +namespace Mozu.Api.Contracts.Location +{ + public class LocationAttribute + { + public Attribute AttributeDefinition { get; set; } + + public int? AttributeDefinitionId { get; set; } + + public AuditInfo AuditInfo { get; set; } + + public string FullyQualifiedName { get; set; } + + public List Values { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/Location/LocationCollection.cs b/Mozu.Api/Contracts/Location/LocationCollection.cs old mode 100644 new mode 100755 index ab612ce7..eb0e5229 --- a/Mozu.Api/Contracts/Location/LocationCollection.cs +++ b/Mozu.Api/Contracts/Location/LocationCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Location /// public class LocationCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Location/LocationType.cs b/Mozu.Api/Contracts/Location/LocationType.cs old mode 100644 new mode 100755 index 0af26ad8..776de4e4 --- a/Mozu.Api/Contracts/Location/LocationType.cs +++ b/Mozu.Api/Contracts/Location/LocationType.cs @@ -21,14 +21,8 @@ public class LocationType { public AuditInfo AuditInfo { get; set; } - /// - ///User-defined identifying code for the location type. - /// public string Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/Location/LocationUsage.cs b/Mozu.Api/Contracts/Location/LocationUsage.cs old mode 100644 new mode 100755 index 74d834f6..67c80ee2 --- a/Mozu.Api/Contracts/Location/LocationUsage.cs +++ b/Mozu.Api/Contracts/Location/LocationUsage.cs @@ -22,19 +22,10 @@ public class LocationUsage { public AuditInfo AuditInfo { get; set; } - /// - ///List of location codes to associate with the location usage. At this time, you can only specify one location code in the request for the direct ship location usage type. - /// public List LocationCodes { get; set; } - /// - ///List of location type codes associated with the location usage. The location service identifies the locations of the designated type. The in-store pickup (SP) and store finder (storeFinder) location usage types allow specification or multiple location type codes. - /// public List LocationTypeCodes { get; set; } - /// - ///The system-defined code used to identify the location usage type, which is "DS" for direct ship, "SP" for in-store pickup, or "storeFinder". - /// public string LocationUsageTypeCode { get; set; } } diff --git a/Mozu.Api/Contracts/Location/LocationUsageCollection.cs b/Mozu.Api/Contracts/Location/LocationUsageCollection.cs old mode 100644 new mode 100755 index 8b81d404..2a49536a --- a/Mozu.Api/Contracts/Location/LocationUsageCollection.cs +++ b/Mozu.Api/Contracts/Location/LocationUsageCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Location /// public class LocationUsageCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Location/RegularHours.cs b/Mozu.Api/Contracts/Location/RegularHours.cs old mode 100644 new mode 100755 index f33e5138..64b79083 --- a/Mozu.Api/Contracts/Location/RegularHours.cs +++ b/Mozu.Api/Contracts/Location/RegularHours.cs @@ -18,39 +18,18 @@ namespace Mozu.Api.Contracts.Location /// public class RegularHours { - /// - ///The Friday label array describes the range of hours this location is normally open on Fridays. For example: {"Label": "10:00 AM - 6:00 PM"}. - /// public Hours Friday { get; set; } - /// - ///The Monday label array describes the range of hours this location is normally open on Mondays. For example: {"Label": "10:00 AM - 6:00 PM"}. - /// public Hours Monday { get; set; } - /// - ///The Saturday label array describes the range of hours this location is normally open on Saturdays. For example: {"Label": "10:00 AM - 6:00 PM"}. - /// public Hours Saturday { get; set; } - /// - ///The Sunday label array describes the range of hours this location is normally open on Sundays. For example: {"Label": "10:00 AM - 6:00 PM"}. - /// public Hours Sunday { get; set; } - /// - ///The Thursday label array describes the range of hours this location is normally open on Thursdays. For example: {"Label": "10:00 AM - 6:00 PM"}. - /// public Hours Thursday { get; set; } - /// - ///The Tuesday label array describes the range of hours this location is normally open on Tuesdays. For example: {"Label": "10:00 AM - 6:00 PM"}. - /// public Hours Tuesday { get; set; } - /// - ///The Wednesday label array describes the range of hours this location is normally open on Wednesdays. For example: {"Label": "10:00 AM - 6:00 PM"}. - /// public Hours Wednesday { get; set; } } diff --git a/Mozu.Api/Contracts/Location/ShippingOriginContact.cs b/Mozu.Api/Contracts/Location/ShippingOriginContact.cs old mode 100644 new mode 100755 index 31aaa46a..cda3e02a --- a/Mozu.Api/Contracts/Location/ShippingOriginContact.cs +++ b/Mozu.Api/Contracts/Location/ShippingOriginContact.cs @@ -29,17 +29,17 @@ public class ShippingOriginContact public string Email { get; set; } /// - ///The full first name of a customer or contact name. + ///The first name of the shipping origin contact. /// public string FirstName { get; set; } /// - ///The full last name or surname of a customer or contact name. + ///The last name of the shipping origin contact. /// public string LastNameOrSurname { get; set; } /// - ///Character string of the middle name or initial for the customer. + ///The middle name or middle initial of the shipping origin contact. /// public string MiddleNameOrInitial { get; set; } diff --git a/Mozu.Api/Contracts/MZDB/EntityCollection.cs b/Mozu.Api/Contracts/MZDB/EntityCollection.cs old mode 100644 new mode 100755 index e88912d2..24558007 --- a/Mozu.Api/Contracts/MZDB/EntityCollection.cs +++ b/Mozu.Api/Contracts/MZDB/EntityCollection.cs @@ -16,34 +16,16 @@ namespace Mozu.Api.Contracts.MZDB { - /// - /// Paged collection of entities. - /// public class EntityCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/MZDB/EntityContainer.cs b/Mozu.Api/Contracts/MZDB/EntityContainer.cs old mode 100644 new mode 100755 index 679f45fd..99b85962 --- a/Mozu.Api/Contracts/MZDB/EntityContainer.cs +++ b/Mozu.Api/Contracts/MZDB/EntityContainer.cs @@ -15,39 +15,18 @@ namespace Mozu.Api.Contracts.MZDB { - /// - /// Properties of the EntityContainer within a specific tenant and site. - /// public class EntityContainer { - /// - ///The unique identifier for the product catalog. Catalogs are part of a master catalog. - /// public int? CatalogId { get; set; } - /// - ///Identifier of the user that created the object. System created and read only. - /// public string CreateBy { get; set; } - /// - ///The date and time in UTC format set when the object was created. - /// public DateTime CreateDate { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The entity in JSON format. - /// public JObject Item { get; set; } - /// - ///The nameSpace and name for the EntityList in the format name@nameSpace. - /// public string ListFullName { get; set; } /// @@ -55,14 +34,8 @@ public class EntityContainer /// public string LocaleCode { get; set; } - /// - ///Unique identifier for the master catalog. - /// public int? MasterCatalogId { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int? SiteId { get; set; } /// @@ -70,19 +43,10 @@ public class EntityContainer /// public int TenantId { get; set; } - /// - ///Identifier of the user that updated the entity most recently. - /// public string UpdateBy { get; set; } - /// - ///The date and time in UTC format the object was updated most recently. - /// public DateTime UpdateDate { get; set; } - /// - ///Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. - /// public string UserId { get; set; } } diff --git a/Mozu.Api/Contracts/MZDB/EntityContainerCollection.cs b/Mozu.Api/Contracts/MZDB/EntityContainerCollection.cs old mode 100644 new mode 100755 index 75f69edb..6d8c836d --- a/Mozu.Api/Contracts/MZDB/EntityContainerCollection.cs +++ b/Mozu.Api/Contracts/MZDB/EntityContainerCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.MZDB { - /// - /// Paged collection of EntityContainers within a specific tenant and site. - /// public class EntityContainerCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/MZDB/EntityList.cs b/Mozu.Api/Contracts/MZDB/EntityList.cs old mode 100644 new mode 100755 index 86916a66..2645319d --- a/Mozu.Api/Contracts/MZDB/EntityList.cs +++ b/Mozu.Api/Contracts/MZDB/EntityList.cs @@ -16,79 +16,34 @@ namespace Mozu.Api.Contracts.MZDB { - /// - /// The definition of an MZDB EntityList which describes the characteristics of the EntityList on a per tenant basis. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList. - /// public class EntityList { - /// - ///At which context level are entities stored in the list. Possible values are "tenant", "site", "masterCatalog" or "catalog". Each list instance will exist at this context level for the tenant. - /// public string ContextLevel { get; set; } - /// - ///The date and time in UTC format set when the object was created. - /// public DateTime CreateDate { get; set; } - /// - ///An IndexedProperty defintion which indicates the property on every entity provided should be used as the unique identifier for the document. Within an EntityList instance each entity must have a unique identifier. - /// public IndexedProperty IdProperty { get; set; } - /// - ///An IndexedProperty defintion which indicates a property on every entity provided that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query. - /// public IndexedProperty IndexA { get; set; } - /// - ///An IndexedProperty defintion which indicates a property on every entity provided that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query. - /// public IndexedProperty IndexB { get; set; } - /// - ///An IndexedProperty defintion which indicates a property on every entity provided that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query. - /// public IndexedProperty IndexC { get; set; } - /// - ///An IndexedProperty defintion which indicates a property on every entity provided that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query. - /// public IndexedProperty IndexD { get; set; } - /// - ///Indicates whether MZDB should store entities in the EntityList instance specific to the localeCode provided. If true, all operations on the EntityList will be filtered by the provided localeCode on the request or using the defautLocaleCode for the context. All entities created in the EntityList will be stored with the localeCode provided on the request or the defautLocaleCode for the context as an additional implicit key. The default value is false. - /// public bool IsLocaleSpecific { get; set; } - /// - ///Indicates whether MZDB should clone all of the Entities in the EntityList when cloning an existing sandbox for which this list is already defined. The default value is false. - /// public bool IsSandboxDataCloningSupported { get; set; } - /// - ///Indicates whether MZDB should store entities in the EntityList instance specific to the current shopper on the request. If true, all operations on the EntityList will be filtered by the id of the shopper from the shopper claims provided on the request. All entities created in the EntityList will be stored with the id of the shopper from the shopper claims provided on the request as an additional implicit key. The default value is false. - /// public bool IsShopperSpecific { get; set; } - /// - ///Indicates whether Enitities in the EntityList are allowed to be accessed from a storefront. - /// public bool IsVisibleInStorefront { get; set; } - /// - ///Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. - /// public JObject Metadata { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The namespace for the accessible APIs and source capabilities in the core of APIs. - /// public string NameSpace { get; set; } /// @@ -96,24 +51,12 @@ public class EntityList /// public int TenantId { get; set; } - /// - ///The date and time in UTC format the object was updated most recently. - /// public DateTime UpdateDate { get; set; } - /// - ///A string array that determines where the document or entity list displays. The options are , for displaying content in the Custom Schema page in , and , for displaying content in the site tree in Site Builder (applies only to document lists). The following example demonstrates how to display content across both options: - /// public List Usages { get; set; } - /// - ///Indicates whether or not should assign a generated identifier for each entity in the list or whether a unique identifier will be provided for each identity. If set to false, then a value must be provided for the IdProperty for the list. - /// public bool UseSystemAssignedId { get; set; } - /// - ///The view in the site used by associated entities or document lists/list types. - /// public List Views { get; set; } } diff --git a/Mozu.Api/Contracts/MZDB/EntityListCollection.cs b/Mozu.Api/Contracts/MZDB/EntityListCollection.cs old mode 100644 new mode 100755 index e8761eb1..a125c4a6 --- a/Mozu.Api/Contracts/MZDB/EntityListCollection.cs +++ b/Mozu.Api/Contracts/MZDB/EntityListCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.MZDB { - /// - /// Paged collection of EntityLists. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList. - /// public class EntityListCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/MZDB/IndexedProperty.cs b/Mozu.Api/Contracts/MZDB/IndexedProperty.cs old mode 100644 new mode 100755 index e04d5e9e..b6e7bf8d --- a/Mozu.Api/Contracts/MZDB/IndexedProperty.cs +++ b/Mozu.Api/Contracts/MZDB/IndexedProperty.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.MZDB { - /// - /// Data for indexed properties within the database. - /// public class IndexedProperty { - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///A JPath query indicating the property that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query. - /// public string PropertyName { get; set; } } diff --git a/Mozu.Api/Contracts/MZDB/ListView.cs b/Mozu.Api/Contracts/MZDB/ListView.cs old mode 100644 new mode 100755 index f213e5e6..96c74ed5 --- a/Mozu.Api/Contracts/MZDB/ListView.cs +++ b/Mozu.Api/Contracts/MZDB/ListView.cs @@ -16,19 +16,10 @@ namespace Mozu.Api.Contracts.MZDB { - /// - /// Properties for the list view that specifies what fields and content display per page load. All associated fields in the list view correspond with object data. - /// public class ListView { - /// - ///Sets the default sorting for content. Sort does not use AND in determining the order. - /// public string DefaultSort { get; set; } - /// - ///The list of fields to display for a view or an associated schema. For example, the address schema would display fields for postal addresses. - /// public List Fields { get; set; } /// @@ -36,24 +27,12 @@ public class ListView /// public string Filter { get; set; } - /// - ///Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. - /// public JObject MetaData { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Indicates the security level for the document content as public, administrator, or owner. - /// public string Security { get; set; } - /// - ///A string array that determines where the document or entity list displays. The options are , for displaying content in the Custom Schema page in , and , for displaying content in the site tree in Site Builder (applies only to document lists). The following example demonstrates how to display content across both options: - /// public List Usages { get; set; } } diff --git a/Mozu.Api/Contracts/MZDB/ListViewCollection.cs b/Mozu.Api/Contracts/MZDB/ListViewCollection.cs old mode 100644 new mode 100755 index a155b719..01f8f921 --- a/Mozu.Api/Contracts/MZDB/ListViewCollection.cs +++ b/Mozu.Api/Contracts/MZDB/ListViewCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.MZDB { - /// - /// Paged collection of ListViews. Properties for the list view specify what fields and content display per page load. All associated fields in the list view correspond with object data. - /// public class ListViewCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/MZDB/ListViewField.cs b/Mozu.Api/Contracts/MZDB/ListViewField.cs old mode 100644 new mode 100755 index 0b479afb..ed8ef6fe --- a/Mozu.Api/Contracts/MZDB/ListViewField.cs +++ b/Mozu.Api/Contracts/MZDB/ListViewField.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.MZDB { - /// - /// Properties for the field associated to a view. - /// public class ListViewField { - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property. - /// public string Target { get; set; } - /// - ///The datatype of the field. Valid values are "string", "integer", "decimal", "date", "bool". - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/Address.cs b/Mozu.Api/Contracts/PaymentService/Address.cs old mode 100644 new mode 100755 index 35adcec7..b8852333 --- a/Mozu.Api/Contracts/PaymentService/Address.cs +++ b/Mozu.Api/Contracts/PaymentService/Address.cs @@ -13,49 +13,22 @@ namespace Mozu.Api.Contracts.PaymentService { - /// - /// Address information to supply for a contact. - /// public class Address { - /// - ///The associated city. - /// public string City { get; set; } - /// - ///The company name associated to this address object. - /// public string CompanyName { get; set; } - /// - ///The associated country - /// public string Country { get; set; } - /// - ///Address 1 - /// public string Line1 { get; set; } - /// - ///Address 2 - /// public string Line2 { get; set; } - /// - ///Address 3 - /// public string Line3 { get; set; } - /// - ///The associated postal code. - /// public string PostalCode { get; set; } - /// - ///The associated state. - /// public string State { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/Contact.cs b/Mozu.Api/Contracts/PaymentService/Contact.cs old mode 100644 new mode 100755 index 6946dc8d..a4420910 --- a/Mozu.Api/Contracts/PaymentService/Contact.cs +++ b/Mozu.Api/Contracts/PaymentService/Contact.cs @@ -13,34 +13,16 @@ namespace Mozu.Api.Contracts.PaymentService { - /// - /// Contact information for an account. - /// public class Contact { - /// - ///Mozu.PaymentService.Contracts.Contact country ApiTypeMember DOCUMENT_HERE - /// public string Country { get; set; } - /// - ///The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists. - /// public string Email { get; set; } - /// - ///The full first name of a customer or contact name. - /// public string Firstname { get; set; } - /// - ///The full last name of a customer or contact name. - /// public string Lastname { get; set; } - /// - ///The associated contact's phone number. - /// public string Phone { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/CustomData.cs b/Mozu.Api/Contracts/PaymentService/CustomData.cs old mode 100644 new mode 100755 index 43523ae3..ef2d7101 --- a/Mozu.Api/Contracts/PaymentService/CustomData.cs +++ b/Mozu.Api/Contracts/PaymentService/CustomData.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.PaymentService { - /// - /// Mozu.PaymentService.Contracts.CustomData ApiType DOCUMENT_HERE - /// public class CustomData { - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/AdapterContext.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/AdapterContext.cs new file mode 100755 index 00000000..7262d335 --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/AdapterContext.cs @@ -0,0 +1,27 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class AdapterContext + { + public List Configuration { get; set; } + + public List Settings { get; set; } + + public Transaction Transaction { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/Address.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/Address.cs new file mode 100755 index 00000000..7cf8cbf1 --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/Address.cs @@ -0,0 +1,36 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class Address + { + public string City { get; set; } + + public string CompanyName { get; set; } + + public string Country { get; set; } + + public string Line1 { get; set; } + + public string Line2 { get; set; } + + public string Line3 { get; set; } + + public string PostalCode { get; set; } + + public string State { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/CaptureRequest.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/CaptureRequest.cs new file mode 100755 index 00000000..33966550 --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/CaptureRequest.cs @@ -0,0 +1,34 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class CaptureRequest + { + public object AdditionalData { get; set; } + + public decimal Amount { get; set; } + + public string ApiVersion { get; set; } + + public CardInformation Card { get; set; } + + public AdapterContext Context { get; set; } + + public string MethodName { get; set; } + + public CustomerInformation Shopper { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/CardInformation.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/CardInformation.cs new file mode 100755 index 00000000..d5f975b4 --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/CardInformation.cs @@ -0,0 +1,42 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class CardInformation + { + public string CardHolderName { get; set; } + + public int CardIssueMonth { get; set; } + + public string CardIssueNumber { get; set; } + + public int CardIssueYear { get; set; } + + public string Cvv { get; set; } + + public int ExpireMonth { get; set; } + + public int ExpireYear { get; set; } + + public string Id { get; set; } + + public string NumberPart { get; set; } + + public bool PersistCard { get; set; } + + public string Type { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/Contact.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/Contact.cs new file mode 100755 index 00000000..b73e691e --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/Contact.cs @@ -0,0 +1,30 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class Contact + { + public string Country { get; set; } + + public string Email { get; set; } + + public string Firstname { get; set; } + + public string Lastname { get; set; } + + public string Phone { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/CustomerInformation.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/CustomerInformation.cs new file mode 100755 index 00000000..b3f0176c --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/CustomerInformation.cs @@ -0,0 +1,39 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class CustomerInformation + { + public Address Address { get; set; } + + public Contact Contact { get; set; } + + public string CurrencyCode { get; set; } + + public string CustomerId { get; set; } + + public List ExtendedInfo { get; set; } + + public string PhoneNumber { get; set; } + + public string RequestorIp { get; set; } + + public string RequestorUrl { get; set; } + + public string RequestorUserAgent { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayAuthorizationRequest.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayAuthorizationRequest.cs new file mode 100755 index 00000000..1328cc02 --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayAuthorizationRequest.cs @@ -0,0 +1,38 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class GatewayAuthorizationRequest + { + public object AdditionalData { get; set; } + + public decimal Amount { get; set; } + + public string ApiVersion { get; set; } + + public CardInformation Card { get; set; } + + public AdapterContext Context { get; set; } + + public string MethodName { get; set; } + + public bool PreAuth { get; set; } + + public string RecurringType { get; set; } + + public CustomerInformation Shopper { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayAuthorizeResponse.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayAuthorizeResponse.cs new file mode 100755 index 00000000..c93f1480 --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayAuthorizeResponse.cs @@ -0,0 +1,39 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class GatewayAuthorizeResponse + { + public string AuthCode { get; set; } + + public string AvsCodes { get; set; } + + public string CvV2Codes { get; set; } + + public bool IsDeclined { get; set; } + + public ConnectionStatuses RemoteConnectionStatus { get; set; } + + public string ResponseCode { get; set; } + + public List ResponseData { get; set; } + + public string ResponseText { get; set; } + + public string TransactionId { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayCaptureResponse.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayCaptureResponse.cs new file mode 100755 index 00000000..2e4910f4 --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayCaptureResponse.cs @@ -0,0 +1,39 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class GatewayCaptureResponse + { + public string AuthCode { get; set; } + + public string AvsCodes { get; set; } + + public string CvV2Codes { get; set; } + + public bool IsDeclined { get; set; } + + public ConnectionStatuses RemoteConnectionStatus { get; set; } + + public string ResponseCode { get; set; } + + public List ResponseData { get; set; } + + public string ResponseText { get; set; } + + public string TransactionId { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayCreditResponse.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayCreditResponse.cs new file mode 100755 index 00000000..7c90b14a --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayCreditResponse.cs @@ -0,0 +1,33 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class GatewayCreditResponse + { + public bool IsDeclined { get; set; } + + public ConnectionStatuses RemoteConnectionStatus { get; set; } + + public string ResponseCode { get; set; } + + public List ResponseData { get; set; } + + public string ResponseText { get; set; } + + public string TransactionId { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayInteraction.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayInteraction.cs new file mode 100755 index 00000000..07a748eb --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayInteraction.cs @@ -0,0 +1,37 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class GatewayInteraction + { + public decimal Amount { get; set; } + + public string CardId { get; set; } + + public DateTime CreatedOn { get; set; } + + public int? Id { get; set; } + + public bool IsDeleted { get; set; } + + public bool IsSuccessful { get; set; } + + public List ResponseData { get; set; } + + public TransactionType TransactionType { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayVoidResponse.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayVoidResponse.cs new file mode 100755 index 00000000..984a87f0 --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/GatewayVoidResponse.cs @@ -0,0 +1,33 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class GatewayVoidResponse + { + public bool IsDeclined { get; set; } + + public ConnectionStatuses RemoteConnectionStatus { get; set; } + + public string ResponseCode { get; set; } + + public List ResponseData { get; set; } + + public string ResponseText { get; set; } + + public string TransactionId { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/KeyValueTuple.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/KeyValueTuple.cs new file mode 100755 index 00000000..36593566 --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/KeyValueTuple.cs @@ -0,0 +1,24 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class KeyValueTuple + { + public string Key { get; set; } + + public object Value { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/Extensibility/V1/Transaction.cs b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/Transaction.cs new file mode 100755 index 00000000..0e527bcc --- /dev/null +++ b/Mozu.Api/Contracts/PaymentService/Extensibility/V1/Transaction.cs @@ -0,0 +1,35 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PaymentService.Extensibility.V1 +{ + public class Transaction + { + public string ActiveCardId { get; set; } + + public DateTime CreatedOn { get; set; } + + public string CurrencyCode { get; set; } + + public List GatewayInteractions { get; set; } + + public string Id { get; set; } + + public bool IsRecurring { get; set; } + + public string KiboTransactionId { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/FraudScreenResponseData.cs b/Mozu.Api/Contracts/PaymentService/FraudScreenResponseData.cs old mode 100644 new mode 100755 index 8f6d5c44..2a596b7e --- a/Mozu.Api/Contracts/PaymentService/FraudScreenResponseData.cs +++ b/Mozu.Api/Contracts/PaymentService/FraudScreenResponseData.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.PaymentService { - /// - /// Mozu.PaymentService.Contracts.FraudScreenResponseData ApiType DOCUMENT_HERE - /// public class FraudScreenResponseData { - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/GatewayAccount.cs b/Mozu.Api/Contracts/PaymentService/GatewayAccount.cs old mode 100644 new mode 100755 index 1b5af95c..d75bd283 --- a/Mozu.Api/Contracts/PaymentService/GatewayAccount.cs +++ b/Mozu.Api/Contracts/PaymentService/GatewayAccount.cs @@ -19,31 +19,20 @@ namespace Mozu.Api.Contracts.PaymentService /// public class GatewayAccount { - /// - ///The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// + public List BinPatterns { get; set; } + public string CountryCode { get; set; } - /// - ///List of credential fields for the payment gateway account. - /// public List CredentialFields { get; set; } - /// - ///Identifier of the payment gateway. - /// public string GatewayDefinitionId { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Indicates if the object or feature is active. - /// public bool IsActive { get; set; } + public string Name { get; set; } + } } \ No newline at end of file diff --git a/Mozu.Api/Contracts/PaymentService/GatewayCredentialFieldDefinition.cs b/Mozu.Api/Contracts/PaymentService/GatewayCredentialFieldDefinition.cs old mode 100644 new mode 100755 index 910951aa..3d4421bc --- a/Mozu.Api/Contracts/PaymentService/GatewayCredentialFieldDefinition.cs +++ b/Mozu.Api/Contracts/PaymentService/GatewayCredentialFieldDefinition.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.PaymentService /// public class GatewayCredentialFieldDefinition { - /// - ///The sequential display order of the gateway in . - /// public int AdminDisplayOrder { get; set; } - /// - ///The name that displays for the payment gateway or third-party credentials field. - /// public string DisplayName { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The name of the Volusion store. - /// public string VolusionStoreName { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/GatewayCredentialFieldValue.cs b/Mozu.Api/Contracts/PaymentService/GatewayCredentialFieldValue.cs old mode 100644 new mode 100755 index ab81ced4..8af8ef30 --- a/Mozu.Api/Contracts/PaymentService/GatewayCredentialFieldValue.cs +++ b/Mozu.Api/Contracts/PaymentService/GatewayCredentialFieldValue.cs @@ -18,14 +18,10 @@ namespace Mozu.Api.Contracts.PaymentService /// public class GatewayCredentialFieldValue { - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// + public bool IsValueSet { get; set; } + public string Name { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/GatewayDefinition.cs b/Mozu.Api/Contracts/PaymentService/GatewayDefinition.cs old mode 100644 new mode 100755 index e81c6a65..4e5aba5e --- a/Mozu.Api/Contracts/PaymentService/GatewayDefinition.cs +++ b/Mozu.Api/Contracts/PaymentService/GatewayDefinition.cs @@ -10,7 +10,9 @@ using System; using System.Collections.Generic; +using Newtonsoft.Json.Linq; +using Mozu.Api.Contracts.Core; namespace Mozu.Api.Contracts.PaymentService { @@ -19,49 +21,24 @@ namespace Mozu.Api.Contracts.PaymentService /// public class GatewayDefinition { - /// - ///The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// + public JObject AdministationUi { get; set; } + public string CountryCode { get; set; } - /// - ///Credential fields for the payment gateway. For security purposes, does not return these credential fields. - /// public List CredentialDefinitions { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The implementing type name of the integration with the payment gateway. - /// public string IntegrationImplTypeName { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Definition of the preauthorization gateway. - /// public PreAuthorizeDefinition PreAuthorizeDefinition { get; set; } - /// - ///URL of the production payment service. - /// public string ProdServiceURL { get; set; } - /// - ///The types of credit cards supported by the payment gateway. - /// public List SupportedCards { get; set; } - /// - ///URL of the test payment service environment. - /// public string TestServiceURL { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/OrderItem.cs b/Mozu.Api/Contracts/PaymentService/OrderItem.cs old mode 100644 new mode 100755 index f349161f..cd2308f5 --- a/Mozu.Api/Contracts/PaymentService/OrderItem.cs +++ b/Mozu.Api/Contracts/PaymentService/OrderItem.cs @@ -14,44 +14,20 @@ namespace Mozu.Api.Contracts.PaymentService { - /// - /// Mozu.PaymentService.Contracts.OrderItem ApiType DOCUMENT_HERE - /// public class OrderItem { - /// - ///customData ApiType DOCUMENT_HERE - /// public List CustomData { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The properties of a product, referenced and used by carts, orders, wish lists, and returns. - /// public Product Product { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int Quantity { get; set; } - /// - ///Mozu.PaymentService.Contracts.OrderItem taxAmount ApiTypeMember DOCUMENT_HERE - /// public decimal? TaxAmount { get; set; } - /// - ///Mozu.PaymentService.Contracts.OrderItem totalAmount ApiTypeMember DOCUMENT_HERE - /// public decimal? TotalAmount { get; set; } - /// - ///Properties of the price per unit of a product, associated with cart and order items. This price is not used for wish lists at this time. - /// public decimal? UnitPrice { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/PreAuthorizeDefinition.cs b/Mozu.Api/Contracts/PaymentService/PreAuthorizeDefinition.cs old mode 100644 new mode 100755 index 11d54917..6e8b2675 --- a/Mozu.Api/Contracts/PaymentService/PreAuthorizeDefinition.cs +++ b/Mozu.Api/Contracts/PaymentService/PreAuthorizeDefinition.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.PaymentService /// public class PreAuthorizeDefinition { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///The product environment URL associated with the preauthorization gateway. - /// public string PreAuthorizeProdUrl { get; set; } - /// - ///The test environment URL associated with the preauthorization gateway. - /// public string PreAuthorizeTestUrl { get; set; } - /// - ///The type of preauthorization gateway. - /// public PreAuthorizeTransactionTypeDataContract Type { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/PreAuthorizeTransactionTypeDataContract.cs b/Mozu.Api/Contracts/PaymentService/PreAuthorizeTransactionTypeDataContract.cs old mode 100644 new mode 100755 index 68250bd4..abcca42a --- a/Mozu.Api/Contracts/PaymentService/PreAuthorizeTransactionTypeDataContract.cs +++ b/Mozu.Api/Contracts/PaymentService/PreAuthorizeTransactionTypeDataContract.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.PaymentService /// public class PreAuthorizeTransactionTypeDataContract { - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///The type of preauthorization transaction. - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/Product.cs b/Mozu.Api/Contracts/PaymentService/Product.cs old mode 100644 new mode 100755 index 85d5dfb6..b4524d51 --- a/Mozu.Api/Contracts/PaymentService/Product.cs +++ b/Mozu.Api/Contracts/PaymentService/Product.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.PaymentService { - /// - /// The properties of a product, referenced and used by carts, orders, wish lists, and returns. - /// public class Product { - /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// public string ProductCode { get; set; } - /// - ///The name of the product that represents a line item in a taxable order or product bundle. - /// public string ProductName { get; set; } - /// - ///Mozu.PaymentService.Contracts.Product variantProductCode ApiTypeMember DOCUMENT_HERE - /// public string VariantProductCode { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/PublicCard.cs b/Mozu.Api/Contracts/PaymentService/PublicCard.cs old mode 100644 new mode 100755 index 84a0df64..c775b966 --- a/Mozu.Api/Contracts/PaymentService/PublicCard.cs +++ b/Mozu.Api/Contracts/PaymentService/PublicCard.cs @@ -13,54 +13,24 @@ namespace Mozu.Api.Contracts.PaymentService { - /// - /// Mozu.PaymentService.Contracts.PublicCard ApiType DOCUMENT_HERE - /// public class PublicCard { - /// - ///Mozu.PaymentService.Contracts.PublicCard cardHolderName ApiTypeMember DOCUMENT_HERE - /// public string CardHolderName { get; set; } - /// - ///Mozu.PaymentService.Contracts.PublicCard cardIssueMonth ApiTypeMember DOCUMENT_HERE - /// public int CardIssueMonth { get; set; } - /// - ///For Amex Cards, this is an additional field for verification that is used in conjunction with a CVV - /// public string CardIssueNumber { get; set; } - /// - ///Mozu.PaymentService.Contracts.PublicCard cardIssueYear ApiTypeMember DOCUMENT_HERE - /// public int CardIssueYear { get; set; } - /// - ///This is the full number of the card. - /// public string CardNumber { get; set; } - /// - ///Mozu.PaymentService.Contracts.PublicCard cardType ApiTypeMember DOCUMENT_HERE - /// public string CardType { get; set; } - /// - ///Mozu.PaymentService.Contracts.PublicCard cvv ApiTypeMember DOCUMENT_HERE - /// public string Cvv { get; set; } - /// - ///The two-digit month a credit card expires for a payment method. - /// public int ExpireMonth { get; set; } - /// - ///The four-digit year the credit card expires for a payment method. - /// public int ExpireYear { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/Request/FraudScreenRequest.cs b/Mozu.Api/Contracts/PaymentService/Request/FraudScreenRequest.cs old mode 100644 new mode 100755 index 149a9b27..1aa41526 --- a/Mozu.Api/Contracts/PaymentService/Request/FraudScreenRequest.cs +++ b/Mozu.Api/Contracts/PaymentService/Request/FraudScreenRequest.cs @@ -15,139 +15,58 @@ namespace Mozu.Api.Contracts.PaymentService.Request { - /// - /// Mozu.PaymentService.Contracts.Request.FraudScreenRequest ApiType DOCUMENT_HERE - /// public class FraudScreenRequest { - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest avsCodes ApiTypeMember DOCUMENT_HERE - /// public string AvsCodes { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest billingAddress ApiTypeMember DOCUMENT_HERE - /// public Address BillingAddress { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest billingContact ApiTypeMember DOCUMENT_HERE - /// public Contact BillingContact { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest cardId ApiTypeMember DOCUMENT_HERE - /// public string CardId { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest cardNumberPart ApiTypeMember DOCUMENT_HERE - /// public string CardNumberPart { get; set; } - /// - ///The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// public string CountryCode { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest credentialFieldsOverride ApiTypeMember DOCUMENT_HERE - /// public List CredentialFieldsOverride { get; set; } - /// - ///The localized currency code for the monetary amount. - /// public string CurrencyCode { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest customData ApiTypeMember DOCUMENT_HERE - /// public List CustomData { get; set; } - /// - ///Unique identifier of the customer in , used to associate customers with data, orders, returns, and in-store credit. - /// public string CustomerId { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest cvV2Codes ApiTypeMember DOCUMENT_HERE - /// public string CvV2Codes { get; set; } - /// - ///The two-digit month a credit card expires for a payment method. - /// public int ExpireMonth { get; set; } - /// - ///The four-digit year the credit card expires for a payment method. - /// public int ExpireYear { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest gatewayAccountId ApiTypeMember DOCUMENT_HERE - /// public string GatewayAccountId { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest merchantTransactionId ApiTypeMember DOCUMENT_HERE - /// public string MerchantTransactionId { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest orderItems ApiTypeMember DOCUMENT_HERE - /// public List OrderItems { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest orderNumber ApiTypeMember DOCUMENT_HERE - /// public int OrderNumber { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest paymentTransactionId ApiTypeMember DOCUMENT_HERE - /// public string PaymentTransactionId { get; set; } - /// - ///The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases. - /// public string PaymentType { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest requestorIp ApiTypeMember DOCUMENT_HERE - /// public string RequestorIp { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest requestorUrl ApiTypeMember DOCUMENT_HERE - /// public string RequestorUrl { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest requestorUserAgent ApiTypeMember DOCUMENT_HERE - /// public string RequestorUserAgent { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest shippingAddress ApiTypeMember DOCUMENT_HERE - /// public Address ShippingAddress { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest shippingContact ApiTypeMember DOCUMENT_HERE - /// public Contact ShippingContact { get; set; } - /// - ///Mozu.PaymentService.Contracts.Request.FraudScreenRequest shipType ApiTypeMember DOCUMENT_HERE - /// public string ShipType { get; set; } - /// - ///Total is used to indicate the monetary, estimated total amount of the cart or order, including items, sales tax, shipping costs, and other fees. Totals are not estimated for wish lists at this time. - /// public decimal Total { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/Response/FraudScreen.cs b/Mozu.Api/Contracts/PaymentService/Response/FraudScreen.cs old mode 100644 new mode 100755 index 004da273..b0828253 --- a/Mozu.Api/Contracts/PaymentService/Response/FraudScreen.cs +++ b/Mozu.Api/Contracts/PaymentService/Response/FraudScreen.cs @@ -15,29 +15,14 @@ namespace Mozu.Api.Contracts.PaymentService.Response { - /// - /// Mozu.PaymentService.Contracts.Response.FraudScreen ApiType DOCUMENT_HERE - /// public class FraudScreen { - /// - ///Mozu.PaymentService.Contracts.Response.FraudScreen fraudScreenResponseData ApiTypeMember DOCUMENT_HERE - /// public List FraudScreenResponseData { get; set; } - /// - ///Unique identifier of the payment interaction from the payment gateway. - /// public int? GatewayInteractionId { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// public string Status { get; set; } - /// - ///Mozu.PaymentService.Contracts.Response.FraudScreen transactionId ApiTypeMember DOCUMENT_HERE - /// public string TransactionId { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/Response/SyncResponse.cs b/Mozu.Api/Contracts/PaymentService/Response/SyncResponse.cs old mode 100644 new mode 100755 index 07499ec5..db82fb9a --- a/Mozu.Api/Contracts/PaymentService/Response/SyncResponse.cs +++ b/Mozu.Api/Contracts/PaymentService/Response/SyncResponse.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.PaymentService.Response { - /// - /// Mozu.PaymentService.Contracts.Response.SyncResponse ApiType DOCUMENT_HERE - /// public class SyncResponse { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Mozu.PaymentService.Contracts.Response.SyncResponse isSuccessful ApiTypeMember DOCUMENT_HERE - /// public bool IsSuccessful { get; set; } - /// - ///Credit card Number Part - /// public string NumberPart { get; set; } } diff --git a/Mozu.Api/Contracts/PaymentService/SupportedCard.cs b/Mozu.Api/Contracts/PaymentService/SupportedCard.cs old mode 100644 new mode 100755 index e304f620..ebc69dac --- a/Mozu.Api/Contracts/PaymentService/SupportedCard.cs +++ b/Mozu.Api/Contracts/PaymentService/SupportedCard.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.PaymentService /// public class SupportedCard { - /// - ///Company-defined friendly name that identifies the supported card. - /// public string FriendlyName { get; set; } - /// - ///The card type of the supported payment card, such as Visa or Amex. - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/PricingRuntime/AppliedDiscount.cs b/Mozu.Api/Contracts/PricingRuntime/AppliedDiscount.cs new file mode 100755 index 00000000..8b639662 --- /dev/null +++ b/Mozu.Api/Contracts/PricingRuntime/AppliedDiscount.cs @@ -0,0 +1,28 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PricingRuntime +{ + public class AppliedDiscount + { + public string CouponCode { get; set; } + + public int? CouponSetId { get; set; } + + public Discount Discount { get; set; } + + public decimal Impact { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PricingRuntime/AppliedLineItemProductDiscount.cs b/Mozu.Api/Contracts/PricingRuntime/AppliedLineItemProductDiscount.cs new file mode 100755 index 00000000..8c13c0f0 --- /dev/null +++ b/Mozu.Api/Contracts/PricingRuntime/AppliedLineItemProductDiscount.cs @@ -0,0 +1,38 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PricingRuntime +{ + public class AppliedLineItemProductDiscount + { + public bool AppliesToSalePrice { get; set; } + + public string CouponCode { get; set; } + + public int? CouponSetId { get; set; } + + public Discount Discount { get; set; } + + public decimal Impact { get; set; } + + public decimal ImpactPerUnit { get; set; } + + public bool IsForced { get; set; } + + public decimal NormalizedImpact { get; set; } + + public int Quantity { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PricingRuntime/AppliedLineItemShippingDiscount.cs b/Mozu.Api/Contracts/PricingRuntime/AppliedLineItemShippingDiscount.cs new file mode 100755 index 00000000..27da5ffc --- /dev/null +++ b/Mozu.Api/Contracts/PricingRuntime/AppliedLineItemShippingDiscount.cs @@ -0,0 +1,38 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PricingRuntime +{ + public class AppliedLineItemShippingDiscount + { + public string CouponCode { get; set; } + + public int? CouponSetId { get; set; } + + public Discount Discount { get; set; } + + public decimal Impact { get; set; } + + public decimal ImpactPerUnit { get; set; } + + public bool IsForced { get; set; } + + public decimal NormalizedImpact { get; set; } + + public int Quantity { get; set; } + + public string ShippingMethodCode { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PricingRuntime/AppliedOrderShippingDiscount.cs b/Mozu.Api/Contracts/PricingRuntime/AppliedOrderShippingDiscount.cs new file mode 100755 index 00000000..f93d0b2c --- /dev/null +++ b/Mozu.Api/Contracts/PricingRuntime/AppliedOrderShippingDiscount.cs @@ -0,0 +1,30 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.PricingRuntime +{ + public class AppliedOrderShippingDiscount + { + public string CouponCode { get; set; } + + public int? CouponSetId { get; set; } + + public Discount Discount { get; set; } + + public decimal Impact { get; set; } + + public string ShippingMethodCode { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PricingRuntime/Discount.cs b/Mozu.Api/Contracts/PricingRuntime/Discount.cs new file mode 100755 index 00000000..57413c5e --- /dev/null +++ b/Mozu.Api/Contracts/PricingRuntime/Discount.cs @@ -0,0 +1,63 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PricingRuntime +{ + public class Discount + { + public decimal Amount { get; set; } + + public string AmountType { get; set; } + + public DiscountCondition Condition { get; set; } + + public int DiscountId { get; set; } + + public bool? DoesNotApplyToMultiShipToOrders { get; set; } + + public bool DoesNotApplyToProductsWithSalePrice { get; set; } + + public DateTime? ExpirationDate { get; set; } + + public string FriendlyDescription { get; set; } + + public List IncludedPriceLists { get; set; } + + public decimal? MaxDiscountValuePerRedemption { get; set; } + + public decimal? MaximumDiscountValuePerOrder { get; set; } + + public int? MaximumRedemptionsPerOrder { get; set; } + + public int? MaximumUsesPerUser { get; set; } + + public int? MaxRedemptions { get; set; } + + public string Name { get; set; } + + public int Redemptions { get; set; } + + public bool RequiresAuthenticatedUser { get; set; } + + public string Scope { get; set; } + + public int StackingLayer { get; set; } + + public DiscountTarget Target { get; set; } + + public string Type { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PricingRuntime/DiscountCondition.cs b/Mozu.Api/Contracts/PricingRuntime/DiscountCondition.cs new file mode 100755 index 00000000..4425d341 --- /dev/null +++ b/Mozu.Api/Contracts/PricingRuntime/DiscountCondition.cs @@ -0,0 +1,51 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PricingRuntime +{ + public class DiscountCondition + { + public string CouponCode { get; set; } + + public List CustomerSegmentIds { get; set; } + + public List ExcludedCategoryIds { get; set; } + + public List ExcludedProductCodes { get; set; } + + public DateTime? ExpirationDate { get; set; } + + public List IncludedCategoryIds { get; set; } + + public List IncludedProductCodes { get; set; } + + public decimal? MinimumCategorySubtotalBeforeDiscounts { get; set; } + + public decimal? MinimumLifetimeValueAmount { get; set; } + + public decimal? MinimumOrderAmount { get; set; } + + public int? MinimumQuantityProductsRequiredInCategories { get; set; } + + public int? MinimumQuantityRequiredProducts { get; set; } + + public List PaymentWorkflows { get; set; } + + public bool RequiresCoupon { get; set; } + + public DateTime? StartDate { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PricingRuntime/DiscountTarget.cs b/Mozu.Api/Contracts/PricingRuntime/DiscountTarget.cs new file mode 100755 index 00000000..9662725b --- /dev/null +++ b/Mozu.Api/Contracts/PricingRuntime/DiscountTarget.cs @@ -0,0 +1,41 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.PricingRuntime +{ + public class DiscountTarget + { + public string ExcludedCategoriesOperator { get; set; } + + public List ExcludedCategoryIds { get; set; } + + public List ExcludedProductCodes { get; set; } + + public bool IncludeAllProducts { get; set; } + + public string IncludedCategoriesOperator { get; set; } + + public List IncludedCategoryIds { get; set; } + + public List IncludedProductCodes { get; set; } + + public List ShippingMethods { get; set; } + + public List ShippingZones { get; set; } + + public string Type { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/PricingRuntime/ItemTaxContext.cs b/Mozu.Api/Contracts/PricingRuntime/ItemTaxContext.cs old mode 100644 new mode 100755 index 9f3fc5ea..49c38d05 --- a/Mozu.Api/Contracts/PricingRuntime/ItemTaxContext.cs +++ b/Mozu.Api/Contracts/PricingRuntime/ItemTaxContext.cs @@ -20,34 +20,16 @@ namespace Mozu.Api.Contracts.PricingRuntime /// public class ItemTaxContext { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// public string ProductCode { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int Quantity { get; set; } - /// - ///Amount of tax applied to shipping costs for line items in and entire orders. - /// public decimal ShippingTax { get; set; } - /// - ///The total tax amount applied to the line item in the order, minus any shipping taxes. - /// public decimal Tax { get; set; } - /// - ///Leverage this property within a [tax Arc.js action](https://www.mozu.com/docs/arcjs/commerce-catalog-storefront-tax/commerce-catalog-storefront-tax.htm) to supplement the tax information for this item or object with custom JSON data. - /// public JObject TaxData { get; set; } } diff --git a/Mozu.Api/Contracts/PricingRuntime/OrderTaxContext.cs b/Mozu.Api/Contracts/PricingRuntime/OrderTaxContext.cs old mode 100644 new mode 100755 index cd7d32c2..71db1a9d --- a/Mozu.Api/Contracts/PricingRuntime/OrderTaxContext.cs +++ b/Mozu.Api/Contracts/PricingRuntime/OrderTaxContext.cs @@ -21,29 +21,14 @@ namespace Mozu.Api.Contracts.PricingRuntime /// public class OrderTaxContext { - /// - ///Tax amount applied to the handling fee defined for orders on this site. - /// public decimal HandlingFeeTax { get; set; } - /// - ///Properties of the tax context applicable for line items in an order. - /// public List ItemTaxContexts { get; set; } - /// - ///Tax amount applied to the order. - /// public decimal OrderTax { get; set; } - /// - ///Amount of tax applied to shipping costs for line items in and entire orders. - /// public decimal ShippingTax { get; set; } - /// - ///Leverage this property within a [tax Arc.js action](https://www.mozu.com/docs/arcjs/commerce-catalog-storefront-tax/commerce-catalog-storefront-tax.htm) to supplement the tax information for this item or object with custom JSON data. - /// public JObject TaxData { get; set; } } diff --git a/Mozu.Api/Contracts/PricingRuntime/ProductAttribute.cs b/Mozu.Api/Contracts/PricingRuntime/ProductAttribute.cs old mode 100644 new mode 100755 index 0e8805fa..45577ed5 --- a/Mozu.Api/Contracts/PricingRuntime/ProductAttribute.cs +++ b/Mozu.Api/Contracts/PricingRuntime/ProductAttribute.cs @@ -18,29 +18,14 @@ namespace Mozu.Api.Contracts.PricingRuntime /// public class ProductAttribute { - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea. - /// public string InputType { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///An attribute value type is either predefined vocabulary by the admin during attribute set up or user-defined with an appropriate type (AdminEntered or ShopperEntered depending on the user). These types are used by products and attributes. The difference between predefined values versus manually entered values is such that the first choice is a set of options to choose from. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order. - /// public string ValueType { get; set; } } diff --git a/Mozu.Api/Contracts/PricingRuntime/ProductProperty.cs b/Mozu.Api/Contracts/PricingRuntime/ProductProperty.cs old mode 100644 new mode 100755 index ec80d833..aac20df1 --- a/Mozu.Api/Contracts/PricingRuntime/ProductProperty.cs +++ b/Mozu.Api/Contracts/PricingRuntime/ProductProperty.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.PricingRuntime /// public class ProductProperty { - /// - ///The product attribute details common between all attribute types - properties, options, and extras. - /// public ProductAttribute AttributeDetail { get; set; } - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///Indicates if the object is hidden or breaks inheritance, primarily used by facets, products, and attribute vocabulary values. For example, if true, the attribute vocabulary value does not appear in the list when defining a value for an attribute. - /// public bool? IsHidden { get; set; } - /// - ///Indicates if the object has or can have multiple properties or values. If true, the object can have more than one value, selectable by shoppers through the storefront or configurable through the catalogs. - /// public bool? IsMultiValue { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/PricingRuntime/ProductPropertyValue.cs b/Mozu.Api/Contracts/PricingRuntime/ProductPropertyValue.cs old mode 100644 new mode 100755 index edc7a5fd..3b510f0c --- a/Mozu.Api/Contracts/PricingRuntime/ProductPropertyValue.cs +++ b/Mozu.Api/Contracts/PricingRuntime/ProductPropertyValue.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.PricingRuntime /// public class ProductPropertyValue { - /// - ///If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options. - /// public string StringValue { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/PricingRuntime/TaxAttribute.cs b/Mozu.Api/Contracts/PricingRuntime/TaxAttribute.cs old mode 100644 new mode 100755 index 20992944..93439e82 --- a/Mozu.Api/Contracts/PricingRuntime/TaxAttribute.cs +++ b/Mozu.Api/Contracts/PricingRuntime/TaxAttribute.cs @@ -14,24 +14,12 @@ namespace Mozu.Api.Contracts.PricingRuntime { - /// - /// Mozu.PricingRuntime.Contracts.TaxAttribute ApiType DOCUMENT_HERE - /// public class TaxAttribute { - /// - ///Unique identifier of the attribute definition. - /// public int? AttributeDefinitionId { get; set; } - /// - ///Fully qualified name of the attribute for the order or customer. - /// public string FullyQualifiedName { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/PricingRuntime/TaxContext.cs b/Mozu.Api/Contracts/PricingRuntime/TaxContext.cs old mode 100644 new mode 100755 index 7762b5f5..0cb06c06 --- a/Mozu.Api/Contracts/PricingRuntime/TaxContext.cs +++ b/Mozu.Api/Contracts/PricingRuntime/TaxContext.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.PricingRuntime /// public class TaxContext { - /// - ///Unique identifier of the customer in , used to associate customers with data, orders, returns, and in-store credit. - /// public string CustomerId { get; set; } - /// - ///The physical address orders are sent to as a shipping destination. This address may contain multiple lines, city, state/province, country, and zip/postal code. The destination is used to calculate shipping costs. - /// public Address DestinationAddress { get; set; } - /// - ///The physical address from which the order or shipment will ship. - /// public Address OriginAddress { get; set; } - /// - ///Unique identifier of the tax context. - /// public string TaxContextId { get; set; } - /// - ///If the order is exempt from sales tax, the unique identifier of the tax exempt entity. - /// public string TaxExemptId { get; set; } } diff --git a/Mozu.Api/Contracts/PricingRuntime/TaxableLineItem.cs b/Mozu.Api/Contracts/PricingRuntime/TaxableLineItem.cs old mode 100644 new mode 100755 index 8ab72efc..4e543d77 --- a/Mozu.Api/Contracts/PricingRuntime/TaxableLineItem.cs +++ b/Mozu.Api/Contracts/PricingRuntime/TaxableLineItem.cs @@ -21,59 +21,52 @@ namespace Mozu.Api.Contracts.PricingRuntime /// public class TaxableLineItem { - /// - ///Custom data for a given vendor set within the commerce process. - /// public JObject Data { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// + public Address DestinationAddress { get; set; } + + public decimal? DiscountedTotal { get; set; } + + public decimal? DiscountTotal { get; set; } + + public decimal? FeeTotal { get; set; } + + public decimal? HandlingAmount { get; set; } + public string Id { get; set; } - /// - ///Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules. - /// public bool? IsTaxable { get; set; } - /// - ///The sale price of the line item in the order. - /// public decimal LineItemPrice { get; set; } - /// - ///Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// + public Address OriginAddress { get; set; } + public string ProductCode { get; set; } + public AppliedLineItemProductDiscount ProductDiscount { get; set; } + + public List ProductDiscounts { get; set; } + /// - ///The name of the product that represents a line item in a taxable order or product bundle. + ///The name of the product that represents a line item in a taxable order. /// public string ProductName { get; set; } - /// - ///Properties of the product that represents the line item in the order. - /// public List ProductProperties { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int Quantity { get; set; } /// - ///The reason description for an action, including item return, coupon not valid, and item is taxed. + ///The reason the item is either taxed or returned. /// public string Reason { get; set; } - /// - ///The calculated monetary amount of shipping for a line items within and an entire order. - /// public decimal ShippingAmount { get; set; } - /// - ///For configurable products, the unique identifier of the product variation that has been selected. - /// + public AppliedLineItemShippingDiscount ShippingDiscount { get; set; } + + public List ShippingDiscounts { get; set; } + public string VariantProductCode { get; set; } } diff --git a/Mozu.Api/Contracts/PricingRuntime/TaxableOrder.cs b/Mozu.Api/Contracts/PricingRuntime/TaxableOrder.cs old mode 100644 new mode 100755 index f7bdc574..b7a42604 --- a/Mozu.Api/Contracts/PricingRuntime/TaxableOrder.cs +++ b/Mozu.Api/Contracts/PricingRuntime/TaxableOrder.cs @@ -17,43 +17,32 @@ namespace Mozu.Api.Contracts.PricingRuntime { /// - /// Properties of an order to calculate tax against. When a tax capability is enabled for a tenant, sends the `TaxableOrder `properties to the capability as read-only, system-supplied information. + /// Properties of an order for which to calculate tax. When a tax capability is enabled for a tenant, Mozu sends the TaxableOrder properties to the capability as read-only, system-supplied information. /// public class TaxableOrder { - /// - ///Collection of attributes that may be paged list or a list, depending on the usage per object and API type. - /// public List Attributes { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///Custom data for a given vendor set within the commerce process. - /// public JObject Data { get; set; } - /// - ///The combined price for all handling costs calculated together for shipped orders, not for digital or in-store pickup. This includes all handling costs per the product line items and options, excluding taxes and discounts. - /// + public AppliedDiscount HandlingDiscount { get; set; } + + public List HandlingDiscounts { get; set; } + public decimal HandlingFee { get; set; } - /// - ///List of line items associated with the order. - /// public List LineItems { get; set; } - /// - ///The date and time the order was submitted for purchase. - /// public DateTime OrderDate { get; set; } - /// - ///The order number that the customer sees on the storefront when they place the order. - /// + public AppliedDiscount OrderDiscount { get; set; } + + public List OrderDiscounts { get; set; } + + public string OrderId { get; set; } + public int? OrderNumber { get; set; } /// @@ -62,22 +51,24 @@ public class TaxableOrder public string OriginalDocumentCode { get; set; } /// - ///The date and time the original order was placed. This date is set when the order is submitted with payment. + ///The date and time the original order was placed. /// public DateTime OriginalOrderDate { get; set; } - /// - ///The calculated monetary amount of shipping for a line items within and an entire order. - /// public decimal ShippingAmount { get; set; } - /// - ///The tax properties associated with the order. - /// + public AppliedOrderShippingDiscount ShippingDiscount { get; set; } + + public List ShippingDiscounts { get; set; } + + public string ShippingMethodCode { get; set; } + + public string ShippingMethodName { get; set; } + public TaxContext TaxContext { get; set; } /// - ///The type of request for which to tax this entity, which is Order or Return. + ///The type of request for which to tax this entity, which is "Order" or "Return." /// public string TaxRequestType { get; set; } diff --git a/Mozu.Api/Contracts/PricingRuntime/ThirdParty/ItemTaxContext.cs b/Mozu.Api/Contracts/PricingRuntime/ThirdParty/ItemTaxContext.cs old mode 100644 new mode 100755 index 28033ba8..526a53e6 --- a/Mozu.Api/Contracts/PricingRuntime/ThirdParty/ItemTaxContext.cs +++ b/Mozu.Api/Contracts/PricingRuntime/ThirdParty/ItemTaxContext.cs @@ -19,7 +19,7 @@ namespace Mozu.Api.Contracts.PricingRuntime.ThirdParty public class ItemTaxContext { /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: + ///Unique identifier of the line item in the order. /// public string Id { get; set; } @@ -29,12 +29,12 @@ public class ItemTaxContext public string ProductCode { get; set; } /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. + ///Quantity of the line item in the order. /// public int Quantity { get; set; } /// - ///Amount of tax applied to shipping costs for line items in and entire orders. + ///Amount of tax applied to shipping costs for the line item in the order. /// public decimal ShippingTax { get; set; } diff --git a/Mozu.Api/Contracts/PricingRuntime/ThirdParty/OrderTaxContext.cs b/Mozu.Api/Contracts/PricingRuntime/ThirdParty/OrderTaxContext.cs old mode 100644 new mode 100755 index 93916010..bd585ba5 --- a/Mozu.Api/Contracts/PricingRuntime/ThirdParty/OrderTaxContext.cs +++ b/Mozu.Api/Contracts/PricingRuntime/ThirdParty/OrderTaxContext.cs @@ -35,7 +35,7 @@ public class OrderTaxContext public decimal OrderTax { get; set; } /// - ///Amount of tax applied to shipping costs for line items in and entire orders. + ///Tax amount applied to the shipping costs on the order. /// public decimal ShippingTax { get; set; } diff --git a/Mozu.Api/Contracts/PricingRuntime/ThirdParty/TaxContext.cs b/Mozu.Api/Contracts/PricingRuntime/ThirdParty/TaxContext.cs old mode 100644 new mode 100755 index 9d40c7ae..62e4e623 --- a/Mozu.Api/Contracts/PricingRuntime/ThirdParty/TaxContext.cs +++ b/Mozu.Api/Contracts/PricingRuntime/ThirdParty/TaxContext.cs @@ -20,17 +20,17 @@ namespace Mozu.Api.Contracts.PricingRuntime.ThirdParty public class TaxContext { /// - ///Unique identifier of the customer in , used to associate customers with data, orders, returns, and in-store credit. + ///Unique identifier of the customer. /// public string CustomerId { get; set; } /// - ///The physical address orders are sent to as a shipping destination. This address may contain multiple lines, city, state/province, country, and zip/postal code. The destination is used to calculate shipping costs. + ///The address to which item in the order will ship. /// public Address DestinationAddress { get; set; } /// - ///The physical address from which the order or shipment will ship. + ///The address from which the item in the order will ship. /// public Address OriginAddress { get; set; } diff --git a/Mozu.Api/Contracts/PricingRuntime/ThirdParty/TaxableOrder.cs b/Mozu.Api/Contracts/PricingRuntime/ThirdParty/TaxableOrder.cs old mode 100644 new mode 100755 index 4d44f5e3..1ab9904a --- a/Mozu.Api/Contracts/PricingRuntime/ThirdParty/TaxableOrder.cs +++ b/Mozu.Api/Contracts/PricingRuntime/ThirdParty/TaxableOrder.cs @@ -16,13 +16,10 @@ namespace Mozu.Api.Contracts.PricingRuntime.ThirdParty { /// - /// Properties of an order for which to calculate tax. When a tax capability is enabled for a tenant, sends the `TaxableOrder `properties to the capability as read-only, system-supplied information. + /// Properties of an order for which to calculate tax. When a tax capability is enabled for a tenant, Mozu sends the TaxableOrder properties to the capability as read-only, system-supplied information. /// public class TaxableOrder { - /// - ///Collection of attributes that may be paged list or a list, depending on the usage per object and API type. - /// public List Attributes { get; set; } /// @@ -30,43 +27,63 @@ public class TaxableOrder /// public string CurrencyCode { get; set; } + public AppliedDiscount HandlingDiscount { get; set; } + + public List HandlingDiscounts { get; set; } + /// - ///The combined price for all handling costs calculated together for shipped orders, not for digital or in-store pickup. This includes all handling costs per the product line items and options, excluding taxes and discounts. + ///Handling fee associated with the order. /// public decimal HandlingFee { get; set; } /// - ///List of line items associated with the order. + ///List of line items in a taxable order object. /// public List LineItems { get; set; } /// - ///The date and time the order was submitted for purchase. + ///The date and time the order was submitted. /// public DateTime OrderDate { get; set; } + public AppliedDiscount OrderDiscount { get; set; } + + public List OrderDiscounts { get; set; } + + public string OrderId { get; set; } + + public int? OrderNumber { get; set; } + /// ///The unique identifier of the original order, used to track order changes for tax purposes. /// public string OriginalDocumentCode { get; set; } /// - ///The date and time the original order was placed. This date is set when the order is submitted with payment. + ///The date and time the original order was placed. /// public DateTime OriginalOrderDate { get; set; } /// - ///The calculated monetary amount of shipping for a line items within and an entire order. + ///The total shipping amount calculated for the order. /// public decimal ShippingAmount { get; set; } + public AppliedOrderShippingDiscount ShippingDiscount { get; set; } + + public List ShippingDiscounts { get; set; } + + public string ShippingMethodCode { get; set; } + + public string ShippingMethodName { get; set; } + /// ///The tax properties associated with the order. /// public TaxContext TaxContext { get; set; } /// - ///The type of request for which to tax this entity, which is Order or Return. + ///The type of request for which to tax this entity, which is "Order" or "Return." /// public string TaxRequestType { get; set; } diff --git a/Mozu.Api/Contracts/ProductAdmin/ActiveDateRange.cs b/Mozu.Api/Contracts/ProductAdmin/ActiveDateRange.cs old mode 100644 new mode 100755 index 87e5591a..4a098ae4 --- a/Mozu.Api/Contracts/ProductAdmin/ActiveDateRange.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ActiveDateRange.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Specifies a start date and end date for when associated object is on the live site, if is set to .If is set to ignores this property. - /// public class ActiveDateRange { - /// - ///The date that the product is no longer active on the site. - /// public DateTime? EndDate { get; set; } - /// - ///The date that the product starts being active on the site. - /// public DateTime? StartDate { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AssignedDiscount.cs b/Mozu.Api/Contracts/ProductAdmin/AssignedDiscount.cs old mode 100644 new mode 100755 index 67d103ec..dd5e3ff1 --- a/Mozu.Api/Contracts/ProductAdmin/AssignedDiscount.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AssignedDiscount.cs @@ -14,29 +14,14 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.AssignedDiscount ApiType DOCUMENT_HERE - /// public class AssignedDiscount { - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The unique identifier of the coupon set. - /// public string CouponSetCode { get; set; } - /// - ///The unique, system generated id. You can use this value to further identify the coupon set.This value is ready only. - /// public int CouponSetId { get; set; } - /// - ///The unique identifier of the discount. - /// public int DiscountId { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Attribute.cs b/Mozu.Api/Contracts/ProductAdmin/Attribute.cs old mode 100644 new mode 100755 index 35c682e1..37523298 --- a/Mozu.Api/Contracts/ProductAdmin/Attribute.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Attribute.cs @@ -16,88 +16,40 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Properties of an attribute used to describe customers or orders. + /// Details of an attribute used to describe individual aspects of a product. /// public class Attribute { - /// - ///The administrator name associated with the object/data. - /// public string AdminName { get; set; } - /// - ///Merchant-defined code for an extensible attribute. This code may be used to generate an object's fully qualified name, such as for products. - /// public string AttributeCode { get; set; } - /// - ///Generated sequence that increments for each attribute and data type combination created. This value is system-supplied and read-only. - /// public int? AttributeDataTypeSequence { get; set; } - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///List of metadata key-value pairs defined for an extensible attribute. - /// public List AttributeMetadata { get; set; } - /// - ///Generated sequence that increments for each product attribute created. This value is system-supplied and read-only. - /// public int? AttributeSequence { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Complex type that contains content for a language specified by LocaleCode. - /// public AttributeLocalizedContent Content { get; set; } - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea. - /// public string InputType { get; set; } - /// - ///If true, the product attribute is an add-on configuration made by the shopper that does not represent a product variation, such as a monogram. - /// public bool? IsExtra { get; set; } - /// - ///If true, the product attribute is a merchant- or shopper-configurable option, such as size or color, that represents a product variation. - /// public bool? IsOption { get; set; } - /// - ///If true, the product attribute describes aspects of the product that do not represent an option configurable by the shopper, such as screen resolution or brand. - /// public bool? IsProperty { get; set; } - /// - ///The localized content associated with the object. - /// public List LocalizedContent { get; set; } - /// - ///The unique identifier of the master catalog associated with the entity. - /// public int? MasterCatalogId { get; set; } - /// - ///The namespace for the accessible APIs and source capabilities in the core of APIs. - /// public string Namespace { get; set; } /// @@ -105,19 +57,10 @@ public class Attribute /// public AttributeSearchSettings SearchSettings { get; set; } - /// - ///Properties used when validating a value entered for an object, including extensible attributes, products attributes, and database entries. - /// public AttributeValidation Validation { get; set; } - /// - ///An attribute value type is either predefined vocabulary by the admin during attribute set up or user-defined with an appropriate type (AdminEntered or ShopperEntered depending on the user). These types are used by products and attributes. The difference between predefined values versus manually entered values is such that the first choice is a set of options to choose from. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order. - /// public string ValueType { get; set; } - /// - ///List of valid vocabulary values defined for an attribute. - /// public List VocabularyValues { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeCollection.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeCollection.cs old mode 100644 new mode 100755 index f0e258c2..94342503 --- a/Mozu.Api/Contracts/ProductAdmin/AttributeCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeCollection.cs @@ -15,30 +15,18 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Array list of customer or order attributes. + /// Paged list of defined product attributes. /// public class AttributeCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeInProductType.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeInProductType.cs old mode 100644 new mode 100755 index 0938bc20..6b366a52 --- a/Mozu.Api/Contracts/ProductAdmin/AttributeInProductType.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeInProductType.cs @@ -19,59 +19,26 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class AttributeInProductType { - /// - ///The product attribute details common between all attribute types - properties, options, and extras. - /// public Attribute AttributeDetail { get; set; } - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///Defines the intended display of this attribute in the storefront. Options include Drop Down, Image Picker, and Radio Buttons. - /// public AttributeInProductTypeDisplayInfo DisplayInfo { get; set; } - /// - ///If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API. - /// public bool? IsAdminOnlyProperty { get; set; } - /// - ///If true, this property is hidden on the storefront. If false, this property is not hidden from the storefront. - /// public bool? IsHiddenProperty { get; set; } - /// - ///If true, this entity is inherited from the base type. If false, this entity is not inherited from the base type. - /// public bool? IsInheritedFromBaseType { get; set; } - /// - ///If true, this attribute has more than one possible value. - /// public bool? IsMultiValueProperty { get; set; } - /// - ///If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...) - /// public bool? IsProductDetailsOnlyProperty { get; set; } - /// - ///If true, the entity is required by the admin. If false, the entity is not required by the admin. - /// public bool? IsRequiredByAdmin { get; set; } - /// - ///Integer that represents the sequence order of the attribute. - /// public int? Order { get; set; } - /// - ///List of valid vocabulary values defined for an attribute. - /// public List VocabularyValues { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeInProductTypeDisplayInfo.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeInProductTypeDisplayInfo.cs old mode 100644 new mode 100755 index 888bc569..618bba5e --- a/Mozu.Api/Contracts/ProductAdmin/AttributeInProductTypeDisplayInfo.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeInProductTypeDisplayInfo.cs @@ -13,14 +13,8 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Properties for the intended view of the product attribute in the storefront. - /// public class AttributeInProductTypeDisplayInfo { - /// - ///Defines the intended display of this attribute in the storefront. Options include Drop Down, Image Picker, and Radio Buttons. - /// public string DisplayIntention { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeLocalizedContent.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeLocalizedContent.cs old mode 100644 new mode 100755 index f783996d..cf61906a --- a/Mozu.Api/Contracts/ProductAdmin/AttributeLocalizedContent.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeLocalizedContent.cs @@ -14,23 +14,14 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. + /// Localized content displayed in the storefront for this attribute. /// public class AttributeLocalizedContent { - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeMetadataItem.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeMetadataItem.cs old mode 100644 new mode 100755 index 532879c0..4fdc7b95 --- a/Mozu.Api/Contracts/ProductAdmin/AttributeMetadataItem.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeMetadataItem.cs @@ -14,18 +14,12 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Properties of a metadata item defined for an attribute. + /// Item used to define additional key-value pairs of data associated with a product attribute. /// public class AttributeMetadataItem { - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeSearchSettings.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeSearchSettings.cs old mode 100644 new mode 100755 index 57c01ce7..2e1d4c16 --- a/Mozu.Api/Contracts/ProductAdmin/AttributeSearchSettings.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeSearchSettings.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class AttributeSearchSettings { - /// - ///Indicates whether the attribute should be able to be used in filters, facets, and sorting on the public storefront. - /// public bool? AllowFilteringAndSortingInStorefront { get; set; } - /// - ///Specifies whether to create a case-sensitive Solr search index. The default is . - /// public bool? IndexValueWithCase { get; set; } /// @@ -34,12 +28,12 @@ public class AttributeSearchSettings public bool SearchableInAdmin { get; set; } /// - ///Indicates if the attribute value is searchable on the public storefront. + ///Indicates whether the attribute value is searchable on the public storefront. /// public bool SearchableInStorefront { get; set; } /// - ///Indicates what kind of values search queries and returns. If true, the system indexes the display value of string attributes instead of the canonical value for searching. Always use the canonical value for filtering. This does not apply for non-string attributes. + ///If true, the system indexs the display value of string attributes instead of the canonical value for searching. Always use the canonical value for filtering. This does not apply for for non-string attributes. /// public bool SearchDisplayValue { get; set; } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeTypeRule.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeTypeRule.cs old mode 100644 new mode 100755 index 0c52b142..9a18468a --- a/Mozu.Api/Contracts/ProductAdmin/AttributeTypeRule.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeTypeRule.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class AttributeTypeRule { - /// - ///The data type of the attribute. There are four valid data types: "Bool", "DateTime", "Number", "String" - /// public string AttributeDataType { get; set; } - /// - ///An attribute's data type would be either "NotSpecified", "Textbox", "Textarea", "Date", "DateTime", "Dropdown", "Listbox", "Radio", "Currency", or "Checkbox" and will be a valid value defined in the type rules resource. - /// public string AttributeInputType { get; set; } - /// - ///Describes how an attribute will be used. Valid types are "Extra", "Option", and "Property". - /// public string AttributeUsageType { get; set; } - /// - ///An attribute value type is either predefined vocabulary by the admin during product attribute set up or it can be "AdminEntered" or "ShopperEntered". The difference between predefined values versus manually entered values is such that the first choice is a set of options to choose from. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order. - /// public string AttributeValueType { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeTypeRuleCollection.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeTypeRuleCollection.cs old mode 100644 new mode 100755 index b4772e32..a6acf1cd --- a/Mozu.Api/Contracts/ProductAdmin/AttributeTypeRuleCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeTypeRuleCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class AttributeTypeRuleCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeValidation.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeValidation.cs old mode 100644 new mode 100755 index b9f42205..f033ae92 --- a/Mozu.Api/Contracts/ProductAdmin/AttributeValidation.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeValidation.cs @@ -14,43 +14,22 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Validates the attribute configured for the customer in the storefront against the attribute configured in . + /// Validates the attribute configured for the product in the storefront against the attribute configured in product admin. /// public class AttributeValidation { - /// - ///The maximum date allowed including month, day, and year. System-supplied and read-only. - /// public DateTime? MaxDateValue { get; set; } - /// - ///The maximum number that can be entered as a value for an extensible attribute. - /// public decimal? MaxNumericValue { get; set; } - /// - ///The maximum character length possible for a string value entered for an extensible attribute. - /// public int? MaxStringLength { get; set; } - /// - ///The minimum date allowed including month, day, and year. System-supplied and read-only. - /// public DateTime? MinDateValue { get; set; } - /// - ///The minimum numeric value required to validate an extensible attribute. - /// public decimal? MinNumericValue { get; set; } - /// - ///The minimum character length possible for a string value entered for an extensible attribute. - /// public int? MinStringLength { get; set; } - /// - ///Regular expression used to process and validate an extensible attribute value that require special formatting, such as phone numbers. - /// public string RegularExpression { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValue.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValue.cs old mode 100644 new mode 100755 index 93da6729..5473802c --- a/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValue.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValue.cs @@ -15,38 +15,20 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Properties of a vocabulary value defined for an extensible attribute. + /// Properties of an individual vocabulary value for an attribute. For example, a "color" attribute might have the following vocabulary values: Red, Blue, Green. /// public class AttributeVocabularyValue { - /// - ///Complex type that contains content for a language specified by LocaleCode. - /// public AttributeVocabularyValueLocalizedContent Content { get; set; } - /// - ///The order in which the attribute value displays. If you omit a value for this property, infers the display order from the attribute value's position the list. - /// public int? DisplayOrder { get; set; } - /// - ///The localized content associated with the object. - /// public List LocalizedContent { get; set; } - /// - ///The name of the product that represents a line item in a taxable order or product bundle. - /// public string ProductName { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } - /// - ///The number that denotes the order of the entity value within a list of entity values. - /// public int? ValueSequence { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueDisplayInfo.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueDisplayInfo.cs old mode 100644 new mode 100755 index 932e907c..a127a7d6 --- a/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueDisplayInfo.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueDisplayInfo.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Provides the display information for attribute vocabulary values. - /// public class AttributeVocabularyValueDisplayInfo { - /// - ///The identifier of the image in the CMS. Supply a value for either the CMS ID or Image URL parameter. - /// public string CmsId { get; set; } - /// - ///Hex value for a color to display in a color picker. This is an HTML supported code for color. - /// public string ColorValue { get; set; } - /// - ///The URL link for the image file associated with a product or category. - /// public string ImageUrl { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueInProductType.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueInProductType.cs old mode 100644 new mode 100755 index 71f488cc..41dc9e93 --- a/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueInProductType.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueInProductType.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class AttributeVocabularyValueInProductType { - /// - ///Defines the intended display of this attribute in the storefront. Options include Drop Down, Image Picker, and Radio Buttons. - /// public AttributeVocabularyValueDisplayInfo DisplayInfo { get; set; } - /// - ///Integer that represents the sequence order of the attribute. - /// public int? Order { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } - /// - ///Navigates vocabulary value details for an attribute defined for a product type. - /// public AttributeVocabularyValue VocabularyValueDetail { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueLocalizedContent.cs b/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueLocalizedContent.cs old mode 100644 new mode 100755 index 80f7dc35..a07a2601 --- a/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueLocalizedContent.cs +++ b/Mozu.Api/Contracts/ProductAdmin/AttributeVocabularyValueLocalizedContent.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class AttributeVocabularyValueLocalizedContent { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options. - /// public string StringValue { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/BundledProduct.cs b/Mozu.Api/Contracts/ProductAdmin/BundledProduct.cs old mode 100644 new mode 100755 index dea32dd2..b0434c04 --- a/Mozu.Api/Contracts/ProductAdmin/BundledProduct.cs +++ b/Mozu.Api/Contracts/ProductAdmin/BundledProduct.cs @@ -21,27 +21,27 @@ namespace Mozu.Api.Contracts.ProductAdmin public class BundledProduct { /// - ///List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both. + ///Indicates the fulfillment types that the product supports. /// public List FulfillmentTypesSupported { get; set; } /// - ///Height of a package or bundle package in imperial units of feet and inches. + ///Height of the bundle package in imperial units of feet and inches. /// public Measurement PackageHeight { get; set; } /// - ///Length of a package or bundle package in imperial units of feet and inches. + ///Length of the bundle package in imperial units of feet and inches. /// public Measurement PackageLength { get; set; } /// - ///Weight of a package or bundle package in imperial units of pounds and ounces. + ///Weight of the bundle package in imperial units of pounds and ounces. /// public Measurement PackageWeight { get; set; } /// - ///Width of a package or bundle package in imperial units of feet and inches. + ///Width of the bundle package in imperial units of feet and inches. /// public Measurement PackageWidth { get; set; } @@ -56,12 +56,12 @@ public class BundledProduct public string ProductCode { get; set; } /// - ///The name of the product that represents a line item in a taxable order or product bundle. + ///The read-only name of the component in a bundled product. /// public string ProductName { get; set; } /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. + ///The quantity of an individual component product in a bundle. For example, if a product bundle represents a 10-pack of socks, the quantity value for the bundled product would be 10. /// public int Quantity { get; set; } diff --git a/Mozu.Api/Contracts/ProductAdmin/Category.cs b/Mozu.Api/Contracts/ProductAdmin/Category.cs old mode 100644 new mode 100755 index 535130e9..168de684 --- a/Mozu.Api/Contracts/ProductAdmin/Category.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Category.cs @@ -15,85 +15,40 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// A descriptive container that groups products. A category is merchant defined with associated products and discounts as configured. GThe storefront displays products in a hierarchy of categories. As such, categories can include a nesting of sub-categories to organize products and product options per set guidelines such as color, brand, material, and size. + /// A descriptive container in a storefront hierarchy to organize collections of products. /// public class Category { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } public int? CatalogId { get; set; } - /// - ///External unique identifier of the category. - /// public string CategoryCode { get; set; } - /// - ///Specifies the type of category. The following are the valid values:* * * - /// public string CategoryType { get; set; } - /// - ///The number of children (subcategories, for example) that stem from a parent (top-level category). - /// public int? ChildCount { get; set; } - /// - ///Complex type that contains content for a language specified by LocaleCode. - /// public CategoryLocalizedContent Content { get; set; } - /// - ///Mozu.ProductAdmin.Contracts.Category dynamicExpression ApiTypeMember DOCUMENT_HERE - /// public DynamicExpression DynamicExpression { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///Indicates if the object or feature is active. - /// public bool? IsActive { get; set; } - /// - ///Indicates if the object is displayed on the storefront. If true, the admin product category is displayed in the store. If false, the category is not displayed. - /// public bool? IsDisplayed { get; set; } - /// - ///The code of the current category's parent category. - /// public string ParentCategoryCode { get; set; } - /// - ///If the current category has a parent, the identifier of the category's parent category. - /// public int? ParentCategoryId { get; set; } - /// - ///If the current category has a parent, the name of the category's parent category. - /// public string ParentCategoryName { get; set; } - /// - ///Indicates whether the parent category is active. - /// public bool? ParentIsActive { get; set; } - /// - ///The total number of products. This total may indicate the total products associate with a product type or number of products in a list. - /// public int? ProductCount { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int? Sequence { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/CategoryCollection.cs b/Mozu.Api/Contracts/ProductAdmin/CategoryCollection.cs old mode 100644 new mode 100755 index b73f06e9..c441641d --- a/Mozu.Api/Contracts/ProductAdmin/CategoryCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/CategoryCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class CategoryCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/CategoryDiscountCondition.cs b/Mozu.Api/Contracts/ProductAdmin/CategoryDiscountCondition.cs old mode 100644 new mode 100755 index bb270b7b..df3f413c --- a/Mozu.Api/Contracts/ProductAdmin/CategoryDiscountCondition.cs +++ b/Mozu.Api/Contracts/ProductAdmin/CategoryDiscountCondition.cs @@ -19,7 +19,7 @@ namespace Mozu.Api.Contracts.ProductAdmin public class CategoryDiscountCondition { /// - ///Unique identifier of a category. + ///The unique identifier of the product category associated with the discount. /// public int CategoryId { get; set; } diff --git a/Mozu.Api/Contracts/ProductAdmin/CategoryLocalizedContent.cs b/Mozu.Api/Contracts/ProductAdmin/CategoryLocalizedContent.cs old mode 100644 new mode 100755 index d01ce9f2..c99f5c44 --- a/Mozu.Api/Contracts/ProductAdmin/CategoryLocalizedContent.cs +++ b/Mozu.Api/Contracts/ProductAdmin/CategoryLocalizedContent.cs @@ -19,49 +19,22 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class CategoryLocalizedContent { - /// - ///Array list of media images associated to a product category. These images may be localized in the language specified by the LocaleCode. Images display with the category on the storefront according to the code and formatting of your site theme. Each image includes the name, alt text, and URL location. - /// public List CategoryImages { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///Description defined for metadata, used to interally manage data, in the language specified by the `localeCode`. This content is used by categories, products, localized content, and SEO content. - /// public string MetaTagDescription { get; set; } - /// - ///Keywords defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Keywords are used by content for categories, products, localized content, and SEO content. - /// public string MetaTagKeywords { get; set; } - /// - ///Title defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Titles are used by content for categories, products, localized content, and SEO content. - /// public string MetaTagTitle { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Title that appears on new product category pages, in the language specified by the `localeCode`. - /// public string PageTitle { get; set; } - /// - ///Slug is used in place of a name, code, or ID to give an SEO, human-friendly URL link for an object, used by categories. - /// public string Slug { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/CategoryLocalizedImage.cs b/Mozu.Api/Contracts/ProductAdmin/CategoryLocalizedImage.cs old mode 100644 new mode 100755 index ea571743..58fd9030 --- a/Mozu.Api/Contracts/ProductAdmin/CategoryLocalizedImage.cs +++ b/Mozu.Api/Contracts/ProductAdmin/CategoryLocalizedImage.cs @@ -18,49 +18,25 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class CategoryLocalizedImage { - /// - ///Descriptive text associated with the image or video that appears on the web storefront. This text displays on a hover-over in the browser, providing further information on the content displayed. The alternate text should be plain alphanumeric text without special characters or HTML coding. - /// public string AltText { get; set; } /// - ///The identifier of the image in the CMS. Supply a value for either the CMS ID or Image URL parameter. + ///The identifier of the category image in the Mozu CMS. Supply a value for either the CMS ID or Image URL parameter. /// public string CmsId { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///The localized title for an image that displays on the storefront. If localized, the displayed content is set per the locale code for the site. - /// public string ImageLabel { get; set; } - /// - ///The URL link for the image file associated with a product or category. - /// public string ImageUrl { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///Type of media specification required to successfully render the image, video, or other media content for products and categories. - /// public string MediaType { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int? Sequence { get; set; } - /// - ///The URL of a video files for a product or category. The path name is set in the language specified by the LocaleCode. - /// public string VideoUrl { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/CategoryPagedCollection.cs b/Mozu.Api/Contracts/ProductAdmin/CategoryPagedCollection.cs old mode 100644 new mode 100755 index f451ec5d..64527dee --- a/Mozu.Api/Contracts/ProductAdmin/CategoryPagedCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/CategoryPagedCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class CategoryPagedCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Coupon.cs b/Mozu.Api/Contracts/ProductAdmin/Coupon.cs old mode 100644 new mode 100755 index c2b43421..eb9cdfa7 --- a/Mozu.Api/Contracts/ProductAdmin/Coupon.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Coupon.cs @@ -14,39 +14,18 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.Coupon ApiType DOCUMENT_HERE - /// public class Coupon { - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Specifies whether the coupon can be deleted and removed from a coupon set. - /// public bool CanBeDeleted { get; set; } - /// - ///The coupon code that a shopper uses to redeem an associated discount on a purchase. This is also the unique identifier of the coupon itself. - /// public string CouponCode { get; set; } - /// - ///The unique identifier of the coupon set that the coupon belongs to. - /// public string CouponSetCode { get; set; } - /// - ///The unique, system generated id of the coupon set that contains the coupon.This value is read only. - /// public int CouponSetId { get; set; } - /// - ///The total number of times the coupon has been redeemed. When you perform a GetCoupon or GetCoupons operation, set the includeCounts operation parameter to true to view this field.This field is read only. - /// public int? RedemptionCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/CouponCollection.cs b/Mozu.Api/Contracts/ProductAdmin/CouponCollection.cs old mode 100644 new mode 100755 index bef19863..60ec9867 --- a/Mozu.Api/Contracts/ProductAdmin/CouponCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/CouponCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.CouponCollection ApiType DOCUMENT_HERE - /// public class CouponCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/CouponSet.cs b/Mozu.Api/Contracts/ProductAdmin/CouponSet.cs old mode 100644 new mode 100755 index ca345c22..01a1d28e --- a/Mozu.Api/Contracts/ProductAdmin/CouponSet.cs +++ b/Mozu.Api/Contracts/ProductAdmin/CouponSet.cs @@ -14,84 +14,36 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.CouponSet ApiType DOCUMENT_HERE - /// public class CouponSet { - /// - ///The total number of discounts assigned to or associated with this coupon set. When you perform a GetCouponSet or GetCouponSets operation, set the includeCounts operation parameter to true to view this field. This field is read only. - /// public int? AssignedDiscountCount { get; set; } - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Specifies whether the coupon set can be deleted. You cannot delete a coupon set if any of the coupons within the coupon set have been redeemed. This value is read only. - /// public bool CanBeDeleted { get; set; } - /// - ///The total number of coupon codes within the coupon set. When you perform a GetCouponSet or GetCouponSets operation, set the includeCounts operation parameter to true to view this field. This field is read only. - /// public int? CouponCodeCount { get; set; } - /// - ///Determines whether the coupon set is a manual coupon set or a generated coupon set.Valid values for this field are: "Generated" and "Manual". - /// public string CouponCodeType { get; set; } - /// - ///The unique identifier of the coupon set. This value is also used as the coupon code prefix in generated coupon sets. If you specify a value, it must be unique to the catalog. If you leave this field empty or null, generates one. Use the GetUniqueCouponSetCode operation to retrieve a unique, random four character code.This value has a maximum length of 32. This value is required. - /// public string CouponSetCode { get; set; } - /// - ///The date and time in UTC format that the coupon set and the coupon codes in the coupon set expire. - /// public DateTime? EndDate { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///The maximum number of times any coupon code in the coupon set can be used. This value must be either null, greater than or equal to 1, or -1. A value of -1 indicates unlimited.If you leave this value null, defaults this value to 1 when you create the coupon set. - /// public int? MaxRedemptionsPerCouponCode { get; set; } - /// - ///The maximum number of times any single shopper can redeem any coupon code in the coupon set. This value must be either null, greater than or equal to 1, or -1. A value of -1 indicates unlimited.If you leave this value null, defaults this value to 1 when you create the coupon set. - /// public int? MaxRedemptionsPerUser { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The total number of all redeemed coupons within the coupon set. When you perform a GetCouponSet or GetCouponSets operation, set the includeCounts operation parameter to true to view this field.This field is read only. - /// public int? RedemptionCount { get; set; } - /// - ///The number of coupon codes within the coupon set.This value is required when couponCodeType is "Generated". - /// public int? SetSize { get; set; } - /// - ///The date and time in UTC format that the coupon codes in the coupon set become active. - /// public DateTime? StartDate { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// public string Status { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/CouponSetCollection.cs b/Mozu.Api/Contracts/ProductAdmin/CouponSetCollection.cs old mode 100644 new mode 100755 index 4324d234..1fb44f67 --- a/Mozu.Api/Contracts/ProductAdmin/CouponSetCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/CouponSetCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.CouponSetCollection ApiType DOCUMENT_HERE - /// public class CouponSetCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/CustomerSegment.cs b/Mozu.Api/Contracts/ProductAdmin/CustomerSegment.cs old mode 100644 new mode 100755 index 8821de3d..dfce50b5 --- a/Mozu.Api/Contracts/ProductAdmin/CustomerSegment.cs +++ b/Mozu.Api/Contracts/ProductAdmin/CustomerSegment.cs @@ -14,12 +14,12 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// The Customer Segment object includes properties of a defined customer segment used to group customer accounts. + /// Properties of a customer segment used to group sets of customers for targeted reporting and discounts. /// public class CustomerSegment { /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: + ///Unique identifier of the customer segment. /// public int Id { get; set; } diff --git a/Mozu.Api/Contracts/ProductAdmin/Discount.cs b/Mozu.Api/Contracts/ProductAdmin/Discount.cs old mode 100644 new mode 100755 index 0a3a37d3..7a908cf8 --- a/Mozu.Api/Contracts/ProductAdmin/Discount.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Discount.cs @@ -16,48 +16,31 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Name of the discount added and applied to a shopping cart and order for a shopper's purchase. + /// Discount used to calculate SalePrice. Includes coupon code if applicable, amount of the discount, and discount savings. Discounts can be either an absolute price or a percentage off. The sale price beats any discounts. /// public class Discount { - /// - ///The integer amount of the discount. For example, an entry of "10" could represent a discount of $10.00 or a discount of 10%, depending on the type. - /// public decimal? Amount { get; set; } - /// - ///The type of discount amount, such as an amount or a percentage. - /// public string AmountType { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Signifies that the discount is not referenced and can be hard deleted - /// public bool CanBeDeleted { get; set; } + public bool? CanBeStackedUpon { get; set; } + /// ///List of conditions that must be met for the discount to apply. /// public DiscountCondition Conditions { get; set; } - /// - ///Complex type that contains content for a language specified by LocaleCode. - /// public DiscountLocalizedContent Content { get; set; } - /// - ///The number of times this discount has been redeemed. - /// public int? CurrentRedemptionCount { get; set; } - /// - ///Determines whether or not a discount applies to a items with a sale price. Applicable on order and line item discounts. For line items, when this is true, the discount will be disqualified. For order level discounts, when true, the discount will not be applied to those items have a sale price. - /// + public bool? DoesNotApplyToMultiShipToOrders { get; set; } + public bool? DoesNotApplyToProductsWithSalePrice { get; set; } /// @@ -65,29 +48,16 @@ public class Discount /// public bool? DoesNotApplyToSalePrice { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///Products receiving a price from a price list specified here or a child of a specified price list can be discounted. - /// public List IncludedPriceLists { get; set; } - /// - ///Maximum impact this discount can apply on a single order. Must be either null or greater than zero. - /// + public bool? IsBxGx { get; set; } + public decimal? MaximumDiscountImpactPerOrder { get; set; } - /// - ///Maximum impact this discount can apply on a single line item. Must be either null or greater than zero. - /// public decimal? MaximumDiscountImpactPerRedemption { get; set; } - /// - ///Maximum number of redemptions allowed per order. If null, defaults to unlimited. - /// public int? MaximumRedemptionsPerOrder { get; set; } /// @@ -95,19 +65,12 @@ public class Discount /// public int? MaximumUsesPerUser { get; set; } - /// - ///The scope to which the discount applies, which is "Order" for order discounts or "LineItem" for individual product discounts. - /// public string Scope { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// + public int? StackingLayer { get; set; } + public string Status { get; set; } - /// - ///Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property. - /// public DiscountTarget Target { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/DiscountCollection.cs b/Mozu.Api/Contracts/ProductAdmin/DiscountCollection.cs old mode 100644 new mode 100755 index bcc849b1..06961f8c --- a/Mozu.Api/Contracts/ProductAdmin/DiscountCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/DiscountCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class DiscountCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/DiscountCondition.cs b/Mozu.Api/Contracts/ProductAdmin/DiscountCondition.cs old mode 100644 new mode 100755 index 100b642c..fd8f55ac --- a/Mozu.Api/Contracts/ProductAdmin/DiscountCondition.cs +++ b/Mozu.Api/Contracts/ProductAdmin/DiscountCondition.cs @@ -20,7 +20,7 @@ namespace Mozu.Api.Contracts.ProductAdmin public class DiscountCondition { /// - ///The coupon code that a shopper uses to redeem an associated discount on a purchase. This is also the unique identifier of the coupon itself. + ///If the discount is a coupon, the code required to redeem the coupon. /// public string CouponCode { get; set; } @@ -35,12 +35,12 @@ public class DiscountCondition public List ExcludedCategories { get; set; } /// - ///List of products that are not eligible for the discount. + ///List of the products that are not eligible for the discount. /// public List ExcludedProducts { get; set; } /// - ///Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only. + ///The date and time on which the discount expires and cannot be redeemed. /// public DateTime? ExpirationDate { get; set; } @@ -49,9 +49,6 @@ public class DiscountCondition /// public List IncludedCategories { get; set; } - /// - ///List of payment types that trigger this discount to be valid. - /// public List IncludedPaymentWorkflows { get; set; } /// @@ -65,7 +62,7 @@ public class DiscountCondition public int? MaxRedemptionCount { get; set; } /// - ///This specifies the minimum amount that must be purchased in the combined categories defined in IncludedCategories. This amount is calculated before discounting and it is not used if IncludedCategories is empty. + ///This pecifies the minimum amount that must be purchased in the combined categories defined in IncludedCategories. This amount is calculated before discounting and it is not used if IncludedCategories is empty. /// public decimal? MinimumCategorySubtotalBeforeDiscounts { get; set; } @@ -80,12 +77,12 @@ public class DiscountCondition public decimal? MinimumOrderAmount { get; set; } /// - ///This specifies the minimum quantity of products in the categories specified in IncludedCategories, which must be purchased to qualify for the associated discount. This defaults to 1 if null, and IncludedCategories has values. + ///This specifies the minimum quantity of products in the categories specified in IncludedCategories, which must be purchased to qualify for the associated discount. This defaults to 1 if null, and IncludedCategories has values. /// public int? MinimumQuantityProductsRequiredInCategories { get; set; } /// - ///This specifies the minimum quantity of products in the specified IncludedProducts that must be purchased to qualify for the associated discount. This defaults to 1 if null, and IncludedProducts has values. + ///This specifies the minimum quantity of products in the specified IncludedProducts that must be purchased to qualify for the associated discount. This defaults to 1 if null, and IncludedProducts has values. /// public int? MinimumQuantityRequiredProducts { get; set; } diff --git a/Mozu.Api/Contracts/ProductAdmin/DiscountLocalizedContent.cs b/Mozu.Api/Contracts/ProductAdmin/DiscountLocalizedContent.cs old mode 100644 new mode 100755 index ebd71cee..69010f5f --- a/Mozu.Api/Contracts/ProductAdmin/DiscountLocalizedContent.cs +++ b/Mozu.Api/Contracts/ProductAdmin/DiscountLocalizedContent.cs @@ -19,24 +19,15 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class DiscountLocalizedContent { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } /// - ///The localizable, shopper-facing description defined for a discount or a storefront message. + ///The localizable, shopper-facing description defined for the discount. /// public string FriendlyDescription { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/DiscountSettings.cs b/Mozu.Api/Contracts/ProductAdmin/DiscountSettings.cs new file mode 100755 index 00000000..d1c6db9b --- /dev/null +++ b/Mozu.Api/Contracts/ProductAdmin/DiscountSettings.cs @@ -0,0 +1,22 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.ProductAdmin +{ + public class DiscountSettings + { + public StackingConfiguration StackingConfiguration { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/ProductAdmin/DiscountTarget.cs b/Mozu.Api/Contracts/ProductAdmin/DiscountTarget.cs old mode 100644 new mode 100755 index 036190e2..7b42fa25 --- a/Mozu.Api/Contracts/ProductAdmin/DiscountTarget.cs +++ b/Mozu.Api/Contracts/ProductAdmin/DiscountTarget.cs @@ -19,49 +19,24 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class DiscountTarget { - /// - ///Determines which way the discount is optimized. Consumers favor(default - false/null) or tenants favor (when this is set to true) Applies to discounts where target is not a specific product or list of products. May also impact behavior of Buy X Get Y so that X is the most expensive items and Y the least expensive. - /// public bool? AppliesToLeastExpensiveProductsFirst { get; set; } - /// - ///The list of all categories associated with the product. These categories contain products, can have discounts associated, and define the grouping of products to display on the storefront. - /// + public bool? AppliesToPurchaseConditionItems { get; set; } + public List Categories { get; set; } - /// - ///List of the product categories that are not eligible for the discount. - /// public List ExcludedCategories { get; set; } - /// - ///The operator to use on the excludedCategories field. Valid values are: "All" and "Any". - /// public string ExcludedCategoriesOperator { get; set; } - /// - ///List of products that are not eligible for the discount. - /// public List ExcludedProducts { get; set; } - /// - ///Prevents order scoped discounts from layering over items that already have a product discount with the same type. - /// public bool? ExcludeItemsWithExistingProductDiscounts { get; set; } - /// - ///Prevents order scoped discounts from layering over items that already have a shipping discount with the same type. - /// public bool? ExcludeItemsWithExistingShippingDiscounts { get; set; } - /// - ///If true, the target discount applies to all products sold on the site, regardless of product category. - /// public bool? IncludeAllProducts { get; set; } - /// - ///The operator of the includedCategories field.Valid values are: "All" and "Any". - /// public string IncludedCategoriesOperator { get; set; } /// @@ -69,24 +44,12 @@ public class DiscountTarget /// public int? MaximumQuantityPerRedemption { get; set; } - /// - ///List of product codes that represent the products to which the discount can apply. - /// public List Products { get; set; } - /// - ///The list of shipping method codes that represents the shipping service types to which the discount can apply. - /// public List ShippingMethods { get; set; } - /// - ///The list of shipping zones that are applicable for this discount. - /// public List ShippingZones { get; set; } - /// - ///Properties of the object to which this discount is targeted, which can be Product or Shipping. If the discount type is Product, the target properties describe the product or product categories to which the discount applies. If the discount type is Shipping, the target properties describe the shipping methods eligible for the discount. - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/DynamicExpression.cs b/Mozu.Api/Contracts/ProductAdmin/DynamicExpression.cs old mode 100644 new mode 100755 index 1cf5ecac..a2d72b12 --- a/Mozu.Api/Contracts/ProductAdmin/DynamicExpression.cs +++ b/Mozu.Api/Contracts/ProductAdmin/DynamicExpression.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// The expression that controls the product membership of the dynamic category. This field is only applicable when the categoryType is set to either "DynamicPreComputed" or "DynamicRealTime".Refer to [Dynamic Category Expressions](../../../developer/api-guides/dynamic-category-exp.htm) for more information about writing dynamic expressions using the API. - /// public class DynamicExpression { - /// - ///The text view of the dynamic expression. For example, instead of writing a structure JSON object, you can write a simple string as the dynamic expression. - /// public string Text { get; set; } - /// - ///The tree view of the dynamic expression. This is a structure JSON object that gives you greater control and flexibility over the text view when writing the dynamic expression. - /// public Expression Tree { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Expression.cs b/Mozu.Api/Contracts/ProductAdmin/Expression.cs old mode 100644 new mode 100755 index e9d7238d..aa0b7a27 --- a/Mozu.Api/Contracts/ProductAdmin/Expression.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Expression.cs @@ -14,45 +14,18 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// The expression you want for the target rule. Refer to [Product Rules](https://www.mozu.com/docs/Guides/settings/shipping.htm#product_rules) in the Shipping Settings guides topic for more information. - /// public class Expression { - /// - ///The expression field you wish to target. For example, if you wish to target the productCode field, this value would be productCode.Refer to [Dynamic Category Expressions](../../../developer/api-guides/dynamic-category-exp.htm) for more information about the supported expression fields. - /// public string Left { get; set; } - /// - ///The logical operator you wish to perform on the nodes within the dynamic expression. Valid values are: "And", and "Or". - /// public string LogicalOperator { get; set; } - /// - ///The node or container of the self-contained dynamic expression. The node contains the following expression fields in order: "type", "left", "operator", and "right".For example, a dynamic expression that specifies to include all products that are in the apparel category would have the following node:`"type": "predicate", - ///"left": "Categories.CategoryCode", - ///"operator": "eq", - ///"right": "apparel".` - /// public List Nodes { get; set; } - /// - ///The operator you wish to perform on the left field. The valid values of this field are dependent on the left expression field. Refer to [Dynamic Category Expressions](../../../developer/api-guides/dynamic-category-exp.htm) for more information about the supported expression field operators. - /// public string Operator { get; set; } - /// - ///The literal values of the predicate that is validated against the combined values of the left and operator fields. For example, you wish to validate on products that have a product code of "shoe". You would write the following expression:`"type": "predicate", - ///"left": "productCode", - ///"operator": "eq", - ///"right": "shoe".` - /// public object Right { get; set; } - /// - ///Specifies either the container of the dynamic expression, or the predicate of the node. Depending on where this is specified in the dynamic expression, the valid values are "container", and "predicate".Refer to [Dynamic Category Expressions](../../../../developer/api-guides/dynamic-category-exp.htm) for more information about using the type field. - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Facet.cs b/Mozu.Api/Contracts/ProductAdmin/Facet.cs old mode 100644 new mode 100755 index 7be5bd4e..b60166d5 --- a/Mozu.Api/Contracts/ProductAdmin/Facet.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Facet.cs @@ -16,63 +16,30 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Properties of the facet used to retrieve documents. + /// Properties of the category, price, or attribute facet shoppers use to filter product display results on a storefront. /// public class Facet { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Unique identifier for the storefront container used to organize products. - /// public int CategoryId { get; set; } - /// - ///Unique identifier of the facet. - /// public int? FacetId { get; set; } - /// - ///The type of facet. Valid values are "range" (enables creation of a range of values) or "value" (populates the facet values based on the associated attribute or category). - /// public string FacetType { get; set; } - /// - ///Indicates if the object is hidden or breaks inheritance, primarily used by facets, products, and attribute vocabulary values. For example, if true, the attribute vocabulary value does not appear in the list when defining a value for an attribute. - /// public bool IsHidden { get; set; } - /// - ///Integer that represents the sequence order of the attribute. - /// public int Order { get; set; } - /// - ///Indicates the specific facet inherited from a parent category that is overridden by this facet. System-supplied and read only. - /// public int? OverrideFacetId { get; set; } - /// - ///For range type facets, an array of ranges to use for the facet values. For example, a price facet might have range queries for $0-$25, $25-$50, and $50-$100. - /// public List RangeQueries { get; set; } - /// - ///Source for an action or container for originating content. Source is used as an origin for validation and notification messages based on successful or failed actions. For originating content, source is used for the facet source information, including the category, price, or attribute properties. - /// public FacetSource Source { get; set; } - /// - ///System-supplied and read only indicator of whether a facet is currently valid and if not indicates the reason why. A facet may become invalid if the source data is changed in some ways (for example if the category tree structure is changed). - /// public FacetValidity Validity { get; set; } - /// - ///Determines how the facet values will be sorted in the store. Must be a valid value for DataType defined in FacetValueSortTypeConst. Allowable values are:* * * * * * The default is . - /// public string ValueSortType { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/FacetRangeQuery.cs b/Mozu.Api/Contracts/ProductAdmin/FacetRangeQuery.cs old mode 100644 new mode 100755 index f818b3a4..6c8670ea --- a/Mozu.Api/Contracts/ProductAdmin/FacetRangeQuery.cs +++ b/Mozu.Api/Contracts/ProductAdmin/FacetRangeQuery.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class FacetRangeQuery { - /// - ///The maximum value to use for the facet range query. - /// public object RangeValueEnd { get; set; } - /// - ///The minimum value to use for the facet range query. - /// public object RangeValueStart { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/FacetSet.cs b/Mozu.Api/Contracts/ProductAdmin/FacetSet.cs old mode 100644 new mode 100755 index f8f600a9..74000db8 --- a/Mozu.Api/Contracts/ProductAdmin/FacetSet.cs +++ b/Mozu.Api/Contracts/ProductAdmin/FacetSet.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class FacetSet { - /// - ///The list of subcategories and attributes that have not been defined as facets for the category. - /// public List Available { get; set; } - /// - ///The list of category, price, and attribute facets defined for the category. - /// public List Configured { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/FacetSource.cs b/Mozu.Api/Contracts/ProductAdmin/FacetSource.cs old mode 100644 new mode 100755 index edb6cd9b..b3f081a3 --- a/Mozu.Api/Contracts/ProductAdmin/FacetSource.cs +++ b/Mozu.Api/Contracts/ProductAdmin/FacetSource.cs @@ -14,33 +14,18 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Describes the source of the facet data. It can be a product field (such as price and category) or a product attribute. All fields are System-supplied and read only. + /// Container for the facet source information, which includes the category, price, or attribute properties. /// public class FacetSource { - /// - ///If true, the facet allows for values that consist of one or more ranges, such as 0-100, 100-200, and 200-300. This is only allowed for numeric and date fields. - /// public bool AllowsRangeQuery { get; set; } - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The source type for the facet, either "Attribute" or "Element". Elements are direct properties of the product and include category and price. - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/FacetValidity.cs b/Mozu.Api/Contracts/ProductAdmin/FacetValidity.cs old mode 100644 new mode 100755 index b93233ec..85f312f7 --- a/Mozu.Api/Contracts/ProductAdmin/FacetValidity.cs +++ b/Mozu.Api/Contracts/ProductAdmin/FacetValidity.cs @@ -14,18 +14,12 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Describes whether a facet is currently valid and the reason. A facet may become invalid if the source data is changed in some ways (for example if the category tree structure is changed). + /// System-supplied and read only parameter that validates a facet for its associated category. /// public class FacetValidity { - /// - ///Indicates if the facet is currently valid. - /// public bool IsValid { get; set; } - /// - ///A code indicating the reason why a facet is invalid. - /// public string ReasonCode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/LocationInventory.cs b/Mozu.Api/Contracts/ProductAdmin/LocationInventory.cs old mode 100644 new mode 100755 index 3e87025e..6f7aae4e --- a/Mozu.Api/Contracts/ProductAdmin/LocationInventory.cs +++ b/Mozu.Api/Contracts/ProductAdmin/LocationInventory.cs @@ -24,39 +24,18 @@ public class LocationInventory /// public AuditInfo AuditInfo { get; set; } - /// - ///Product code defined by the tenant administrator to use as a base prefix when generating product codes for any variations of this product. - /// public string BaseProductCode { get; set; } - /// - ///The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. - /// public string LocationCode { get; set; } - /// - ///Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// public string ProductCode { get; set; } - /// - ///The name of the product that represents a line item in a taxable order or product bundle. - /// public string ProductName { get; set; } - /// - ///The stock level for the associated product currently available, at specified locations, and based on the number of pending product reservations as applicable. System-supplied and read only. - /// public int? StockAvailable { get; set; } - /// - ///The stock level for the associated product currently on back order for this location, based on the number of pending product reservations. System-supplied and read only. - /// public int? StockOnBackOrder { get; set; } - /// - ///The current physical stock level for the associated product, which does not account for pending product reservations. - /// public int? StockOnHand { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/LocationInventoryAdjustment.cs b/Mozu.Api/Contracts/ProductAdmin/LocationInventoryAdjustment.cs old mode 100644 new mode 100755 index 984b429c..2113cf6f --- a/Mozu.Api/Contracts/ProductAdmin/LocationInventoryAdjustment.cs +++ b/Mozu.Api/Contracts/ProductAdmin/LocationInventoryAdjustment.cs @@ -19,7 +19,7 @@ namespace Mozu.Api.Contracts.ProductAdmin public class LocationInventoryAdjustment { /// - ///The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. + ///User-defined code that identifies the location. /// public string LocationCode { get; set; } @@ -34,7 +34,7 @@ public class LocationInventoryAdjustment public string Type { get; set; } /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. + ///Value of the location inventory adjustment, which is an absolute integer or delta. For example, to decrease the current inventory level by 2, set the Type parameter to "Delta" and the Value parameter to "-2". To adjust the inventory to a current level of 12, set the Type parameter to "Absolute" and the Value parameter to "12". /// public int Value { get; set; } diff --git a/Mozu.Api/Contracts/ProductAdmin/LocationInventoryCollection.cs b/Mozu.Api/Contracts/ProductAdmin/LocationInventoryCollection.cs old mode 100644 new mode 100755 index 55e0df95..02ea34f9 --- a/Mozu.Api/Contracts/ProductAdmin/LocationInventoryCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/LocationInventoryCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class LocationInventoryCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/MasterCatalog.cs b/Mozu.Api/Contracts/ProductAdmin/MasterCatalog.cs old mode 100644 new mode 100755 index 0e5bec57..b6c159aa --- a/Mozu.Api/Contracts/ProductAdmin/MasterCatalog.cs +++ b/Mozu.Api/Contracts/ProductAdmin/MasterCatalog.cs @@ -14,33 +14,18 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Properties of a master product catalog defined for a tenant. All catalogs and sites associated with a master catalog share product definitions. + /// Properties of a master catalog associated with a tenant. /// public class MasterCatalog { - /// - ///Enables the live editing of products feature. If you set the productPublishingMode field to Pending, set this field to true, and set the DataViewMode in the context header to live, you can edit the live version of products instead of the pending draft.This should only be enabled for immediate changes to the live version of products. Any edits made to the live version are not applied to the pending draft version, so when you publish the pending draft version, your edits to the live version are overwritten. - /// public bool? EnableLiveEdit { get; set; } - /// - ///The unique identifier of the master catalog associated with the entity. - /// public int Id { get; set; } - /// - ///Indicates if the object is deleted. If true, the object has been deleted. This may affect associated child members and objects. For example, a deleted master catalog affects all associated catalogs. - /// public bool IsDeleted { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The mode this master catalog uses for product updates. Possible values are "Pending" which saves product updates as a draft until they are published, and "Live" which publishes all product updates immediately. - /// public string ProductPublishingMode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/MasterCatalogCollection.cs b/Mozu.Api/Contracts/ProductAdmin/MasterCatalogCollection.cs old mode 100644 new mode 100755 index 7f33e423..faf59ef0 --- a/Mozu.Api/Contracts/ProductAdmin/MasterCatalogCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/MasterCatalogCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class MasterCatalogCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/PriceList.cs b/Mozu.Api/Contracts/ProductAdmin/PriceList.cs old mode 100644 new mode 100755 index 10a8e074..dcfa4368 --- a/Mozu.Api/Contracts/ProductAdmin/PriceList.cs +++ b/Mozu.Api/Contracts/ProductAdmin/PriceList.cs @@ -15,89 +15,38 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// The details of the price list. - /// public class PriceList { - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///A list of sites for which you want the price list the default. The default price list will be in effect on a site if the resolution logic does not return any applicable price lists for the shopper, for example, if the shopper does not belong to any applicable customer segments. Refer to [Default](https://www.mozu.com/docs/guides/catalog/price-lists.htm#default) in the Price Lists guides topic for more information. - /// public List DefaultForSites { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists. - /// public bool? Enabled { get; set; } - /// - ///Indicates whether the price list is exclusive. When a price list is exclusive, shoppers that resolve to the exclusive price list can only view and purchase products that have price entries in the price list and any of its parents. The default is . Refer to [Exclusivity](https://www.mozu.com/docs/guides/catalog/price-lists.htm#exclusivity) for more information. - /// public bool? FilteredInStorefront { get; set; } - /// - ///A list of site identifiers for which the price list pricing is indexed. Refer to [Indexing](https://www.mozu.com/docs/guides/catalog/price-lists.htm#indexing) in the Price Lists guides topic for more information. - /// public List IndexedSites { get; set; } - /// - ///A list of customer segment codes that uses to determine the shoppers to whom the price list applies. Refer to [Resolution](https://www.mozu.com/docs/guides/catalog/price-lists.htm#resolution) in the Price Lists guides topic for more information. - /// public List MappedCustomerSegments { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The code of the price list's parent price list. You can assign each price list a parent price list, which allows each child price list to inherit the parent price list's overridden product pricing. Refer to [Inheritance](https://www.mozu.com/docs/guides/catalog/price-lists.htm#inheritance) in the Price Lists guides topic for more information. - /// public string ParentPriceListCode { get; set; } - /// - ///The user-defined name of the parent price list, if applicable. This value is read-only. - /// public string ParentPriceListName { get; set; } - /// - ///The unique, user-defined code of the price list. - /// public string PriceListCode { get; set; } - /// - ///A unique, internal ID of the price list. This property is read-only. - /// public int PriceListSequence { get; set; } - /// - ///The resolution rank of the price list that is used to break ties when a customer is applicable for multiple price lists. A lower number represents a higher priority. In order avoid conflicts, recommends setting this property to a unique value. Refer to [Resolution Rank](https://www.mozu.com/docs/guides/catalog/price-lists.htm#resolution_rank) in the Price List guides topic for more information. - /// public int? Rank { get; set; } - /// - ///Specifies whether the price list is resolvable. When , is able to apply the price list and its product pricing directly to a shopper. When , is unable to apply the price list and its product pricing directly to a shopper; however can still apply the price list to a shopper if it is a parent of a resolvable price list. Refer to [Resolution](https://www.mozu.com/docs/guides/catalog/price-lists.htm#resolution) in the Price List guides topic for more information. - /// public bool? Resolvable { get; set; } - /// - ///Specifies whether the price list is valid for all sites associated with the master catalog to which the price list belongs. If this property is , the property is empty. - /// public bool? ValidForAllSites { get; set; } - /// - ///A list of sites for which the price list is valid. If this property contains any entries, the property is . - /// public List ValidSites { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/PriceListCollection.cs b/Mozu.Api/Contracts/ProductAdmin/PriceListCollection.cs old mode 100644 new mode 100755 index 6ebf7cd7..242a5e80 --- a/Mozu.Api/Contracts/ProductAdmin/PriceListCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/PriceListCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.PriceListCollection ApiType DOCUMENT_HERE - /// public class PriceListCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/PriceListEntry.cs b/Mozu.Api/Contracts/ProductAdmin/PriceListEntry.cs old mode 100644 new mode 100755 index d3e2e081..7937b090 --- a/Mozu.Api/Contracts/ProductAdmin/PriceListEntry.cs +++ b/Mozu.Api/Contracts/ProductAdmin/PriceListEntry.cs @@ -15,134 +15,58 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// The details of the price list entry. - /// public class PriceListEntry { - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Mozu.ProductAdmin.Contracts.PriceListEntry cost ApiTypeMember DOCUMENT_HERE - /// public decimal? Cost { get; set; } - /// - ///Specifies whether the product's cost is the default catalog cost or is overridden. If this property is set to , cannot not be null.This property has the following valid values:* * - /// public string CostMode { get; set; } - /// - ///The localized currency code for the monetary amount. - /// public string CurrencyCode { get; set; } - /// - ///Indicates if the discount is restricted. If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval.For price list entries, specifies whether discounts are restricted for the specific entry if is set to .Refer to [Discount Restriction](../../../guides/catalog/price-lists.htm#discountrestriction) in the Price Lists guides topic for more information. - /// public bool? DiscountsRestricted { get; set; } - /// - ///The date and time on which the discount restriction period ends. - /// public DateTime? DiscountsRestrictedEndDate { get; set; } - /// - ///Specifies whether to use the default catalog setting for discount restriction, or to override the default catalog setting.Refer to [Discount Restriction](https://www.mozu.com/docs/guides/catalog/price-lists.htm#discountrestriction) in the Price Lists guides topic for more information.This property has the following valid values:* * - /// public string DiscountsRestrictedMode { get; set; } - /// - ///The date and time on which the discount restriction period starts. - /// public DateTime? DiscountsRestrictedStartDate { get; set; } - /// - ///Specifies the date in UTC format when the price list entry is no longer in effect. This property is optional. - /// public DateTime? EndDate { get; set; } - /// - ///A list of product extras associated with the price list entry.Refer to [Extras](https://www.mozu.com/docs/guides/catalog/price-lists.htm#extras) in the Price Lists guides topic for more information. - /// public List ExtraEntries { get; set; } - /// - ///Specifies whether the product in the price list entry is a product variant.Refer to [Configurable Products with Options](https://www.mozu.com/docs/guides/catalog/price-lists.htm#product_variants) in the Price Lists guides topic for more information. - /// public bool IsVariation { get; set; } - /// - ///The minimum advertised price (MAP) of the product, if is set to . - /// public decimal? Map { get; set; } - /// - ///The date the price list entry's map is no longer in effect. - /// public DateTime? MapEndDate { get; set; } - /// - ///Specifies whether to use the product's default catalog map, or to override the product's default catalog map.This property has the following valid values:* * - /// public string MapMode { get; set; } - /// - ///The date the price list entry's map takes effect. - /// public DateTime? MapStartDate { get; set; } - /// - ///The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier. - /// public decimal? Msrp { get; set; } - /// - ///Specifies whether to use the product's default catalog msrp, or to override the product's default catalog msrp. - /// public string MsrpMode { get; set; } - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } - /// - ///A list of product pricing information associated with the price list entry. - /// public List PriceEntries { get; set; } - /// - ///External unique identifier of the Price List. Must be unique an only contain url sanitized characters. The max length is 50. - /// public string PriceListCode { get; set; } - /// - ///This property is for future price list functionality and currently should always be . - /// public string PriceListEntryMode { get; set; } - /// - ///This property is used for referencing the price list entry. Read-only. - /// public int PriceListEntrySequence { get; set; } - /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// + public string PriceListEntryTypeCode { get; set; } + public string ProductCode { get; set; } - /// - ///The name of the product that represents a line item in a taxable order or product bundle. - /// public string ProductName { get; set; } - /// - ///Specifies the date and time in UTC format when the price list entry is in effect. - /// public DateTime? StartDate { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/PriceListEntryCollection.cs b/Mozu.Api/Contracts/ProductAdmin/PriceListEntryCollection.cs old mode 100644 new mode 100755 index f12421cc..e46ba45f --- a/Mozu.Api/Contracts/ProductAdmin/PriceListEntryCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/PriceListEntryCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// A collection of price list entries and their details. - /// public class PriceListEntryCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/PriceListEntryExtra.cs b/Mozu.Api/Contracts/ProductAdmin/PriceListEntryExtra.cs old mode 100644 new mode 100755 index a5a5c4cf..d26e9f80 --- a/Mozu.Api/Contracts/ProductAdmin/PriceListEntryExtra.cs +++ b/Mozu.Api/Contracts/ProductAdmin/PriceListEntryExtra.cs @@ -13,39 +13,18 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.PriceListEntryExtra ApiType DOCUMENT_HERE - /// public class PriceListEntryExtra { - /// - ///Merchant-defined code for an extensible attribute. This code may be used to generate an object's fully qualified name, such as for products. - /// public string AttributeCode { get; set; } - /// - ///The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name. - /// public string AttributeFQN { get; set; } - /// - ///Name of attribute that this extra is based on. ReadOnly - /// public string AttributeName { get; set; } - /// - ///Value to display. Currently only vaild when Value is a string type. ReadOnly - /// public string DisplayValue { get; set; } - /// - ///PriceList price for the extra - /// public decimal Price { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/PriceListEntryPrice.cs b/Mozu.Api/Contracts/ProductAdmin/PriceListEntryPrice.cs old mode 100644 new mode 100755 index ecf39643..ed2f35b9 --- a/Mozu.Api/Contracts/ProductAdmin/PriceListEntryPrice.cs +++ b/Mozu.Api/Contracts/ProductAdmin/PriceListEntryPrice.cs @@ -13,34 +13,16 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.PriceListEntryPrice ApiType DOCUMENT_HERE - /// public class PriceListEntryPrice { - /// - ///The product's list price if is set to . - /// public decimal? ListPrice { get; set; } - /// - ///Specifies whether to use the product's default catalog list price, or to override the product's default catalog list price.This property has the following valid values:* * - /// public string ListPriceMode { get; set; } - /// - ///This property is for future price list entry functionality and currently should always be 1. - /// public int MinQty { get; set; } - /// - ///The set sale price for a product consisting of a price with a discount already applied.For price list entries, this property is the product's sale price if the is set to . - /// public decimal? SalePrice { get; set; } - /// - ///Specifies whether to use the product's default catalog sale price, or to override the product's default catalog sale price.This property has the following valid values:* * - /// public string SalePriceMode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Product.cs b/Mozu.Api/Contracts/ProductAdmin/Product.cs old mode 100644 new mode 100755 index 28b9f562..3928b5e2 --- a/Mozu.Api/Contracts/ProductAdmin/Product.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Product.cs @@ -16,23 +16,14 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// The properties of a product, referenced and used by carts, orders, wish lists, and returns. + /// Properties of a product in a master catalog. Product properties include discounts, localizable content, inventory information, attribute configurations, price data, and the catalogs associated with a product. /// public class Product { - /// - ///List of discounts available per configured conditions and criteria. These discounts are associated with products, orders, and shipping costs. Shoppers can view these discounts per order, per product in an order, or for their shipping depending on the configuration. - /// public List ApplicableDiscounts { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Product code defined by the tenant administrator to use as a base prefix when generating product codes for any variations of this product. - /// public string BaseProductCode { get; set; } /// @@ -42,114 +33,54 @@ public class Product public ProductLocalizedContent Content { get; set; } - /// - ///List of extra product attributes defined for this product. For example, monogram could be a possible extra for a shirt product. - /// public List Extras { get; set; } /// - ///List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both. + ///Describes the types of fulfillment that are supported for this product. A product can support direct ship, in-store pickup, or both. Supported fulfillment types are defined at the master catalog level. Client administrators cannot override the supported fulfillment types at the catalog level. /// public List FulfillmentTypesSupported { get; set; } - /// - ///If true, the product has configurable options. This option means that a product is not purchasable until the shopper selects options that resolve into a product variation. Configurable options for a product are the choices a shopper makes when ordering a product. Size and color are configurable options. System-supplied and read-only. - /// public bool HasConfigurableOptions { get; set; } - /// - ///If true, this product has standalone options that a shopper can select without configuring a defined product variations. System-supplied and read only. - /// public bool HasStandAloneOptions { get; set; } - /// - ///Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior. - /// public ProductInventoryInfo InventoryInfo { get; set; } - /// - ///Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself. - /// public bool? IsPackagedStandAlone { get; set; } - /// - ///Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. - /// public bool? IsRecurring { get; set; } - /// - ///Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules. - /// public bool? IsTaxable { get; set; } - /// - ///If true, this product is valid for the assigned product type. - /// public bool? IsValidForProductType { get; set; } - /// - ///If true, this configured product represents a product variation defined with configurable options. System-supplied and read only. - /// public bool IsVariation { get; set; } - /// - ///The unique identifier of the master catalog associated with the entity. - /// public int? MasterCatalogId { get; set; } - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } - /// - ///Height of a package or bundle package in imperial units of feet and inches. - /// public Measurement PackageHeight { get; set; } - /// - ///Length of a package or bundle package in imperial units of feet and inches. - /// public Measurement PackageLength { get; set; } - /// - ///Weight of a package or bundle package in imperial units of pounds and ounces. - /// public Measurement PackageWeight { get; set; } - /// - ///Width of a package or bundle package in imperial units of feet and inches. - /// public Measurement PackageWidth { get; set; } - /// - ///Unit price that the client intends to sell the product if no sale price is set. - /// public ProductPrice Price { get; set; } /// - ///Properties that describe the behavior the system uses when determining the price of products. + ///Describes the behavior the system uses when determining the price of the product. /// public ProductPricingBehaviorInfo PricingBehavior { get; set; } - /// - ///Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// public string ProductCode { get; set; } - /// - ///Properties defined for a product as they appear in its associated catalogs. - /// public List ProductInCatalogs { get; set; } - /// - ///Integer that represents the sequential order of the product. - /// public int? ProductSequence { get; set; } - /// - ///Unique identifier of the product type assigned for this product. Tenant administrators can only define one product type per product. - /// public int? ProductTypeId { get; set; } /// @@ -157,29 +88,14 @@ public class Product /// public string ProductUsage { get; set; } - /// - ///Collection of property attributes defined for the object. Properties are associated to all objects within , including documents, products, and product types. - /// public List Properties { get; set; } - /// - ///Properties of the product publishing settings for the associated product. - /// public ProductPublishingInfo PublishingInfo { get; set; } - /// - ///The search engine optimized content defined for products or products associated with a catalog. If no SEO content is specified in the request for products associated with a catalog, this catalog uses the SEO content defined in the master catalog. To override the SEO content for this catalog, the `IsSEOContentOverridden `flag must be set to "true". - /// public ProductLocalizedSEOContent SeoContent { get; set; } - /// - ///Identifier of the shipping class. - /// public int? ShippingClassId { get; set; } - /// - ///If the product must be packaged separately, the type of standalone package to use. - /// public string StandAlonePackageType { get; set; } /// @@ -187,19 +103,10 @@ public class Product /// public ProductSupplierInfo SupplierInfo { get; set; } - /// - ///The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels. - /// public string Upc { get; set; } - /// - ///System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// public string VariationKey { get; set; } - /// - ///The list of product variation configurations defined for this product based on its available product option attributes. - /// public List VariationOptions { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductCategory.cs b/Mozu.Api/Contracts/ProductAdmin/ProductCategory.cs old mode 100644 new mode 100755 index 06079c91..b6ddd569 --- a/Mozu.Api/Contracts/ProductAdmin/ProductCategory.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductCategory.cs @@ -18,9 +18,6 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductCategory { - /// - ///Unique identifier for the storefront container used to organize products. - /// public int CategoryId { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductCodeRename.cs b/Mozu.Api/Contracts/ProductAdmin/ProductCodeRename.cs old mode 100644 new mode 100755 index df5b98fb..a08c298b --- a/Mozu.Api/Contracts/ProductAdmin/ProductCodeRename.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductCodeRename.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Properties for a product code current and changed content. - /// public class ProductCodeRename { - /// - ///The existing product code to be changed. - /// public string ExistingProductCode { get; set; } - /// - ///The new product code for the product. This code must be unique across all catalogs. - /// public string NewProductCode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductCollection.cs b/Mozu.Api/Contracts/ProductAdmin/ProductCollection.cs old mode 100644 new mode 100755 index cc2e0f06..34a8b12b --- a/Mozu.Api/Contracts/ProductAdmin/ProductCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductCost.cs b/Mozu.Api/Contracts/ProductAdmin/ProductCost.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductDiscountCondition.cs b/Mozu.Api/Contracts/ProductAdmin/ProductDiscountCondition.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductExtra.cs b/Mozu.Api/Contracts/ProductAdmin/ProductExtra.cs old mode 100644 new mode 100755 index 616b74db..c2de1e22 --- a/Mozu.Api/Contracts/ProductAdmin/ProductExtra.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductExtra.cs @@ -19,24 +19,12 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductExtra { - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///If true, the shopper can select more than one value from a predefined list for this extra. - /// public bool? IsMultiSelect { get; set; } - /// - ///Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value. - /// public bool? IsRequired { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductExtraValue.cs b/Mozu.Api/Contracts/ProductAdmin/ProductExtraValue.cs old mode 100644 new mode 100755 index b523def3..e6a97066 --- a/Mozu.Api/Contracts/ProductAdmin/ProductExtraValue.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductExtraValue.cs @@ -19,39 +19,21 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductExtraValue { - /// - ///Properties of an individual vocabulary value for an attribute. For example, a "color" attribute might have the following vocabulary values: Red, Blue, Green. - /// public AttributeVocabularyValue AttributeVocabularyValueDetail { get; set; } - /// - ///If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".Refer to [Product Variant Pricing and Weight](../../../guides/catalog/products.htm#product_variant_pricing_and_weight) in the Products guides topic for more information. - /// public ProductExtraValueDeltaPrice DeltaPrice { get; set; } - /// - ///The difference between the weight associated with this product, variation option, or extra and the base product. For example, if a product with a monogram weighs an extra 1/4 lb, the DeltaWeight value is "0.25". The amount of the delta is set by the weight type for the storefront. - /// public decimal? DeltaWeight { get; set; } - /// - ///If true, the value for the product extra is selected by default. Shopper entered extras cannot be defaulted. - /// public bool? IsDefaulted { get; set; } - /// - ///The difference between associated prices for a product, variation option, or extra that is localized per the `localeCode`. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. Depending on the localeCode, the price may be converted such as from USD (US Dollar) to EUR (euro). - /// public List LocalizedDeltaPrice { get; set; } /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. + ///When setting up the extra on a parent product, you can specify a quantity. You can have an extra that is a quantity > 1 of another product. /// public int? Quantity { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductExtraValueDeltaPrice.cs b/Mozu.Api/Contracts/ProductAdmin/ProductExtraValueDeltaPrice.cs old mode 100644 new mode 100755 index b69c1a5c..db915f42 --- a/Mozu.Api/Contracts/ProductAdmin/ProductExtraValueDeltaPrice.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductExtraValueDeltaPrice.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductExtraValueDeltaPrice { - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".Refer to [Product Variant Pricing and Weight](../../../guides/catalog/products.htm#product_variant_pricing_and_weight) in the Products guides topic for more information. - /// public decimal DeltaPrice { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductInCatalogInfo.cs b/Mozu.Api/Contracts/ProductAdmin/ProductInCatalogInfo.cs old mode 100644 new mode 100755 index 9cacb853..8b0ccff7 --- a/Mozu.Api/Contracts/ProductAdmin/ProductInCatalogInfo.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductInCatalogInfo.cs @@ -20,69 +20,30 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductInCatalogInfo { - /// - ///If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront. - /// public ActiveDateRange ActiveDateRange { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The unique identifier of the catalog of products used by a site. - /// public int CatalogId { get; set; } - /// - ///Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes. - /// public ProductLocalizedContent Content { get; set; } - /// - ///Date this product was first Available for sale in the catalog. This is utilized in expressions that refrence DaysInCatloag. - /// public DateTime? DateFirstAvailableInCatalog { get; set; } - /// - ///Indicates if the object or feature is active. - /// public bool? IsActive { get; set; } - /// - ///If true, the content defined for this product in the master catalog in overridden in the catalog with the content specified in the request body. If false, this catalog uses the content defined in the master catalog for the product. - /// public bool? IsContentOverridden { get; set; } - /// - ///If true, the price defined for this product in the master catalog in overridden in the catalog with the price specified in the request body. If false, this catalog uses the price defined in the master catalog for the product. - /// public bool? IsPriceOverridden { get; set; } - /// - ///If true, the SEO content defined for this product in the master catalog in overridden in the catalog with the SEO content specified in the request body. If false, this catalog uses the SEO content defined in the master catalog for the product. - /// public bool? IsseoContentOverridden { get; set; } - /// - ///The price of the product associated with the specified catalog. If no price is specified in the request, this catalog uses the price defined in the master catalog. To override the product price for this catalog, the IsPriceOverridden flag must be set to "true". - /// public ProductPrice Price { get; set; } - /// - ///Specifies which static category to use in the navigation breadcrumb, regardless of how shoppers navigate to the product. If not set, or if the product belongs only to dynamic categories, the default is to use the category with the smallest ID. - /// public ProductCategory PrimaryProductCategory { get; set; } - /// - ///The product categories to define for the product associated with the specified catalog. - /// public List ProductCategories { get; set; } - /// - ///The search engine optimized content defined for products or products associated with a catalog. If no SEO content is specified in the request for products associated with a catalog, this catalog uses the SEO content defined in the master catalog. To override the SEO content for this catalog, the `IsSEOContentOverridden `flag must be set to "true". - /// public ProductLocalizedSEOContent SeoContent { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductInventoryInfo.cs b/Mozu.Api/Contracts/ProductAdmin/ProductInventoryInfo.cs old mode 100644 new mode 100755 index 6cdf4121..ede61900 --- a/Mozu.Api/Contracts/ProductAdmin/ProductInventoryInfo.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductInventoryInfo.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductInventoryInfo { - /// - ///Indicates is the item's stock is managed. If true, manages inventory levels for this product. - /// public bool? ManageStock { get; set; } - /// - ///Determines the method this product uses when active stock is depeleted. Options include "DisplayMessage" to display an out of stock message to the shopper, "HideProduct" to disable the product on the storefront, or "AllowBackOrder" to allow the shopper to back order the product. This property is required only if manages inventory for this product. - /// public string OutOfStockBehavior { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedContent.cs b/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedContent.cs old mode 100644 new mode 100755 index fe17560a..9572ce49 --- a/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedContent.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedContent.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductLocalizedContent { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///Lengthy full description for a product description, displayed on product detail pages within the storefront. - /// public string ProductFullDescription { get; set; } - /// - ///List of image files associated with a product. This content may include the image file URL, name, and other information as available. - /// public List ProductImages { get; set; } - /// - ///The name of the product that represents a line item in a taxable order or product bundle. - /// public string ProductName { get; set; } - /// - ///Brief text description of the product or component in a product bundle, typically used when the product is displayed in a list or in search results. - /// public string ProductShortDescription { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedImage.cs b/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedImage.cs old mode 100644 new mode 100755 index bccc6c55..6fd662f0 --- a/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedImage.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedImage.cs @@ -18,49 +18,25 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductLocalizedImage { - /// - ///Descriptive text associated with the image or video that appears on the web storefront. This text displays on a hover-over in the browser, providing further information on the content displayed. The alternate text should be plain alphanumeric text without special characters or HTML coding. - /// public string AltText { get; set; } /// - ///The identifier of the image in the CMS. Supply a value for either the CMS ID or Image URL parameter. + ///The identifier of the product image in the Mozu CMS. Supply a value for either the CMS ID or the Image URL parameter. /// public string CmsId { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///The localized title for an image that displays on the storefront. If localized, the displayed content is set per the locale code for the site. - /// public string ImageLabel { get; set; } - /// - ///The URL link for the image file associated with a product or category. - /// public string ImageUrl { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///Type of media specification required to successfully render the image, video, or other media content for products and categories. - /// public string MediaType { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int? Sequence { get; set; } - /// - ///The URL of a video files for a product or category. The path name is set in the language specified by the LocaleCode. - /// public string VideoUrl { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedSEOContent.cs b/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedSEOContent.cs old mode 100644 new mode 100755 index 8f789a22..aa027ddc --- a/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedSEOContent.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductLocalizedSEOContent.cs @@ -18,34 +18,16 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductLocalizedSEOContent { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///Description defined for metadata, used to interally manage data, in the language specified by the `localeCode`. This content is used by categories, products, localized content, and SEO content. - /// public string MetaTagDescription { get; set; } - /// - ///Keywords defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Keywords are used by content for categories, products, localized content, and SEO content. - /// public string MetaTagKeywords { get; set; } - /// - ///Title defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Titles are used by content for categories, products, localized content, and SEO content. - /// public string MetaTagTitle { get; set; } - /// - ///The search engine optimized, human-readable portion of the URL. The content is localized according to the product's `localeCode`. - /// public string SeoFriendlyUrl { get; set; } - /// - ///Customizes the HTML title tag within the header section of the product details page for the specified product. - /// public string TitleTagTitle { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductOption.cs b/Mozu.Api/Contracts/ProductAdmin/ProductOption.cs old mode 100644 new mode 100755 index 644b9e84..cf6e7419 --- a/Mozu.Api/Contracts/ProductAdmin/ProductOption.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductOption.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductOption { - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductOptionValue.cs b/Mozu.Api/Contracts/ProductAdmin/ProductOptionValue.cs old mode 100644 new mode 100755 index c04949ef..fe5f3500 --- a/Mozu.Api/Contracts/ProductAdmin/ProductOptionValue.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductOptionValue.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductOptionValue { - /// - ///Properties of an individual vocabulary value for an attribute. For example, a "color" attribute might have the following vocabulary values: Red, Blue, Green. - /// public AttributeVocabularyValue AttributeVocabularyValueDetail { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductPrice.cs b/Mozu.Api/Contracts/ProductAdmin/ProductPrice.cs old mode 100644 new mode 100755 index 61b43277..4cf9fdcf --- a/Mozu.Api/Contracts/ProductAdmin/ProductPrice.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductPrice.cs @@ -19,13 +19,10 @@ namespace Mozu.Api.Contracts.ProductAdmin public class ProductPrice { /// - ///The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. + ///The credit amount of the product. /// public decimal? CreditValue { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string IsoCurrencyCode { get; set; } /// @@ -44,18 +41,12 @@ public class ProductPrice public DateTime? MapStartDate { get; set; } /// - ///The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier. + ///The manufacturer's suggested retail price, as defined by the supplier. /// public decimal? Msrp { get; set; } - /// - ///Price that the merchant intends to sell the product which is not necessarily the list price. This is the price the merchant intends to sell the product if no sale price is present. - /// public decimal? Price { get; set; } - /// - ///The set sale price for a product consisting of a price with a discount already applied.For price list entries, this property is the product's sale price if the is set to . - /// public decimal? SalePrice { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductPricingBehaviorInfo.cs b/Mozu.Api/Contracts/ProductAdmin/ProductPricingBehaviorInfo.cs old mode 100644 new mode 100755 index 0b76e439..9a56208c --- a/Mozu.Api/Contracts/ProductAdmin/ProductPricingBehaviorInfo.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductPricingBehaviorInfo.cs @@ -19,23 +19,20 @@ namespace Mozu.Api.Contracts.ProductAdmin public class ProductPricingBehaviorInfo { /// - ///Indicates if the discount is restricted. If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval.For price list entries, specifies whether discounts are restricted for the specific entry if is set to .Refer to [Discount Restriction](../../../guides/catalog/price-lists.htm#discountrestriction) in the Price Lists guides topic for more information. + ///If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval. /// public bool? DiscountsRestricted { get; set; } /// - ///The date and time on which the discount restriction period ends. + ///If discounts are restricted for this product, the date and time the discount restriction ends, in UTC datetime. /// public DateTime? DiscountsRestrictedEndDate { get; set; } /// - ///The date and time on which the discount restriction period starts. + ///If discounts are restricted for this product, the date and time the discount restriction begins, in UTC datetime. /// public DateTime? DiscountsRestrictedStartDate { get; set; } - /// - ///Specifies the pricing method for variations associated with the product.This property has the following valid values:* * - /// public string VariationPricingMethod { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductProperty.cs b/Mozu.Api/Contracts/ProductAdmin/ProductProperty.cs old mode 100644 new mode 100755 index ea12c6ac..446749e4 --- a/Mozu.Api/Contracts/ProductAdmin/ProductProperty.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductProperty.cs @@ -15,18 +15,12 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Details of a property defined for a product. + /// Properties of the product property to create such as attribute detail, fully qualified name, and list of product property values. /// public class ProductProperty { - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductPropertyValue.cs b/Mozu.Api/Contracts/ProductAdmin/ProductPropertyValue.cs old mode 100644 new mode 100755 index e57085fe..86ba2fb4 --- a/Mozu.Api/Contracts/ProductAdmin/ProductPropertyValue.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductPropertyValue.cs @@ -15,28 +15,16 @@ namespace Mozu.Api.Contracts.ProductAdmin { /// - /// Properties of a value for a product property. + /// Value details for a product property attribute. /// public class ProductPropertyValue { - /// - ///Properties of an individual vocabulary value for an attribute. For example, a "color" attribute might have the following vocabulary values: Red, Blue, Green. - /// public AttributeVocabularyValue AttributeVocabularyValueDetail { get; set; } - /// - ///Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes. - /// public ProductPropertyValueLocalizedContent Content { get; set; } - /// - ///The localized content associated with the object. - /// public List LocalizedContent { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductPropertyValueLocalizedContent.cs b/Mozu.Api/Contracts/ProductAdmin/ProductPropertyValueLocalizedContent.cs old mode 100644 new mode 100755 index f1c385ef..043ecd12 --- a/Mozu.Api/Contracts/ProductAdmin/ProductPropertyValueLocalizedContent.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductPropertyValueLocalizedContent.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductPropertyValueLocalizedContent { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options. - /// public string StringValue { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductPublishingInfo.cs b/Mozu.Api/Contracts/ProductAdmin/ProductPublishingInfo.cs old mode 100644 new mode 100755 index fe990591..9caadd6c --- a/Mozu.Api/Contracts/ProductAdmin/ProductPublishingInfo.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductPublishingInfo.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductPublishingInfo { - /// - ///The user ID of the user who last published changes for this product in the catalog. - /// public string LastPublishedBy { get; set; } - /// - ///The date and time a draft change for this product was published to the catalog. - /// public DateTime? LastPublishedDate { get; set; } - /// - ///The current publishing state of this product in the catalog, which is Live, New, or Draft. Live products appear on the storefront and have no pending changes. New products have been created but do not yet appear on the storefront. Draft products appear on the storefront but have pending changes that have not yet been published. - /// public string PublishedState { get; set; } - /// - ///The unique identifier of the publish set the pending product draft is assigned to. This field is not valid if the product is live. - /// public string PublishSetCode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductReservation.cs b/Mozu.Api/Contracts/ProductAdmin/ProductReservation.cs old mode 100644 new mode 100755 index 89d0baee..c0510af4 --- a/Mozu.Api/Contracts/ProductAdmin/ProductReservation.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductReservation.cs @@ -19,39 +19,18 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductReservation { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. - /// public string LocationCode { get; set; } - /// - ///Unique identifier of the order associated with the payment. - /// public string OrderId { get; set; } - /// - ///Unique identifier of the order item associated with a validation message, order, or return. - /// public string OrderItemId { get; set; } - /// - ///Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// public string ProductCode { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int Quantity { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductReservationCollection.cs b/Mozu.Api/Contracts/ProductAdmin/ProductReservationCollection.cs old mode 100644 new mode 100755 index 5d3d97a5..d4cff80b --- a/Mozu.Api/Contracts/ProductAdmin/ProductReservationCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductReservationCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductReservationCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductSupplierInfo.cs b/Mozu.Api/Contracts/ProductAdmin/ProductSupplierInfo.cs old mode 100644 new mode 100755 index 3b07cf64..64754594 --- a/Mozu.Api/Contracts/ProductAdmin/ProductSupplierInfo.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductSupplierInfo.cs @@ -29,7 +29,7 @@ public class ProductSupplierInfo public string DistPartNumber { get; set; } /// - ///The manufacturer's part number for the product. + ///The manufacturer part number associated with this product, defined by the product manufacturer. /// public string MfgPartNumber { get; set; } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductType.cs b/Mozu.Api/Contracts/ProductAdmin/ProductType.cs old mode 100644 new mode 100755 index 8576884f..5347d527 --- a/Mozu.Api/Contracts/ProductAdmin/ProductType.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductType.cs @@ -20,59 +20,32 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductType { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///List of extra product attributes defined for this product. For example, monogram could be a possible extra for a shirt product. - /// public List Extras { get; set; } /// - ///The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit. + ///The type of goods for this product. /// public string GoodsType { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///If true, this product is associated with the overall product type. There is only one BaseProductType per site group. System-supplied and read-only. - /// public bool IsBaseProductType { get; set; } - /// - ///The unique identifier of the master catalog associated with the entity. - /// public int? MasterCatalogId { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } - /// - ///The total number of products. This total may indicate the total products associate with a product type or number of products in a list. - /// public int? ProductCount { get; set; } /// - ///List of product usages that describe how products of this type are used. Products of this type can be Standard (a single product without configurable options), Configurable (a product that includes configurable option attributes), Bundle (a collection of products sold as a single entity), or Component (an invididual product that represents a component in a bundle). + ///List of product usages that describe how products of this type are used. Products of this type can be Standard (a single product without configurable options), Configurable (a product that includes configurable option attributes), Bundle (a collection of products sold as a single entity), or Component (an invididual product that represents a component in a bundle). Product type usages cannot be both Bundle and Configurable. /// public List ProductUsages { get; set; } - /// - ///Collection of property attributes defined for the object. Properties are associated to all objects within , including documents, products, and product types. - /// public List Properties { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductTypeCollection.cs b/Mozu.Api/Contracts/ProductAdmin/ProductTypeCollection.cs old mode 100644 new mode 100755 index c2c84c6a..38222599 --- a/Mozu.Api/Contracts/ProductAdmin/ProductTypeCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductTypeCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductTypeCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductVariation.cs b/Mozu.Api/Contracts/ProductAdmin/ProductVariation.cs old mode 100644 new mode 100755 index 11f2d94d..0bea6f49 --- a/Mozu.Api/Contracts/ProductAdmin/ProductVariation.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductVariation.cs @@ -19,79 +19,43 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductVariation { - /// - ///If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".Refer to [Product Variant Pricing and Weight](../../../guides/catalog/products.htm#product_variant_pricing_and_weight) in the Products guides topic for more information. - /// public ProductVariationDeltaPrice DeltaPrice { get; set; } - /// - ///The difference between the weight associated with this product, variation option, or extra and the base product. For example, if a product with a monogram weighs an extra 1/4 lb, the DeltaWeight value is "0.25". The amount of the delta is set by the weight type for the storefront. - /// public decimal? DeltaWeight { get; set; } - /// - ///If the product is in Explicit pricing mode, this is the price of the variation.Refer to [Product Variant Pricing and Weight](../../../guides/catalog/products.htm#product_variant_pricing_and_weight) in the Products guides topic for more information. - /// public ProductVariationFixedPrice FixedPrice { get; set; } - /// - ///If the product is in explicit pricing mode, this is the fixed weight of the variation. - /// public decimal? FixedWeight { get; set; } /// - ///List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both. + ///Describes the types of fulfillment that are supported for this product variation. A variation can support direct ship, in-store pickup, or both. Supported fulfillment types are defined at the master catalog level. Client administrators cannot override the supported fulfillment types at the catalog level. /// public List FulfillmentTypesSupported { get; set; } - /// - ///Indicates if the object or feature is active. - /// public bool? IsActive { get; set; } - /// - ///If true, the production variation is no longer available for sale. For example, if a client stops selling all "small" shirts, all product variations with the "small" option are set to IsOrphan. System-supplied and read only. - /// public bool? IsOrphan { get; set; } - /// - ///The difference between associated prices for a product, variation option, or extra that is localized per the `localeCode`. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. Depending on the localeCode, the price may be converted such as from USD (US Dollar) to EUR (euro). - /// public List LocalizedDeltaPrice { get; set; } - /// - ///Price of the variation using fixed per currency This collection allows for multiple currencies. - /// public List LocalizedFixedPrice { get; set; } - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } /// - ///Supplier-defined properties assigned for the product. + ///Supplier-defined properties assigned for the product variation. /// public ProductSupplierInfo SupplierInfo { get; set; } /// - ///The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels. + ///The universal product code associated with the product variation. The UPC of a product is unique across all sales channels. /// public string Upc { get; set; } - /// - ///If true, one or more product variations are configured for the specified product code. - /// public bool? VariationExists { get; set; } - /// - ///System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// public string Variationkey { get; set; } - /// - ///Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// public string VariationProductCode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductVariationCollection.cs b/Mozu.Api/Contracts/ProductAdmin/ProductVariationCollection.cs old mode 100644 new mode 100755 index 8c2c4b5e..b661f4bb --- a/Mozu.Api/Contracts/ProductAdmin/ProductVariationCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductVariationCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductVariationCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductVariationDeltaPrice.cs b/Mozu.Api/Contracts/ProductAdmin/ProductVariationDeltaPrice.cs old mode 100644 new mode 100755 index e0e2d3ae..4dd784db --- a/Mozu.Api/Contracts/ProductAdmin/ProductVariationDeltaPrice.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductVariationDeltaPrice.cs @@ -19,23 +19,17 @@ namespace Mozu.Api.Contracts.ProductAdmin public class ProductVariationDeltaPrice { /// - ///The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. + ///The credit amount for the product. /// public decimal? CreditValue { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } /// - ///The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier. + ///The manufacturer's suggested retail price, as defined by the supplier. /// public decimal? Msrp { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public decimal? Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductVariationFixedPrice.cs b/Mozu.Api/Contracts/ProductAdmin/ProductVariationFixedPrice.cs old mode 100644 new mode 100755 index 121ef898..ac5d083f --- a/Mozu.Api/Contracts/ProductAdmin/ProductVariationFixedPrice.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductVariationFixedPrice.cs @@ -13,34 +13,16 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// The details of the product variation localized price. - /// public class ProductVariationFixedPrice { - /// - ///The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. - /// public decimal? CreditValue { get; set; } - /// - ///The localized currency code for the monetary amount. - /// public string CurrencyCode { get; set; } - /// - ///If the product is in explicit pricing mode, this is the list price of the variation. - /// public decimal? ListPrice { get; set; } - /// - ///The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier. - /// public decimal? Msrp { get; set; } - /// - ///The set sale price for a product consisting of a price with a discount already applied.For price list entries, this property is the product's sale price if the is set to . - /// public decimal? SalePrice { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductVariationOption.cs b/Mozu.Api/Contracts/ProductAdmin/ProductVariationOption.cs old mode 100644 new mode 100755 index 440ea785..34758da2 --- a/Mozu.Api/Contracts/ProductAdmin/ProductVariationOption.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductVariationOption.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductVariationOption { - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///Complex type that contains content for a language specified by LocaleCode. - /// public AttributeVocabularyValueLocalizedContent Content { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/ProductVariationPagedCollection.cs b/Mozu.Api/Contracts/ProductAdmin/ProductVariationPagedCollection.cs old mode 100644 new mode 100755 index c74f970a..dbcb7543 --- a/Mozu.Api/Contracts/ProductAdmin/ProductVariationPagedCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/ProductVariationPagedCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class ProductVariationPagedCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/PublishSet.cs b/Mozu.Api/Contracts/ProductAdmin/PublishSet.cs old mode 100644 new mode 100755 index 0b768ff0..bd76b1e0 --- a/Mozu.Api/Contracts/ProductAdmin/PublishSet.cs +++ b/Mozu.Api/Contracts/ProductAdmin/PublishSet.cs @@ -14,24 +14,12 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.PublishSet ApiType DOCUMENT_HERE - /// public class PublishSet { - /// - ///The unique identifier of the product publish set. - /// public string Code { get; set; } - /// - ///A list of product codes of associated products. When this field is in the Product Publishing resource, you can use this field to publish or delete individual pending product changes, or assign individual pending product changes to a publish set. - /// public List ProductCodes { get; set; } - /// - ///The total number of products. This total may indicate the total products associate with a product type or number of products in a list. - /// public int ProductCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/PublishSetCollection.cs b/Mozu.Api/Contracts/ProductAdmin/PublishSetCollection.cs old mode 100644 new mode 100755 index 6a633bb7..7187b5dd --- a/Mozu.Api/Contracts/ProductAdmin/PublishSetCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/PublishSetCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.PublishSetCollection ApiType DOCUMENT_HERE - /// public class PublishSetCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/PublishingScope.cs b/Mozu.Api/Contracts/ProductAdmin/PublishingScope.cs old mode 100644 new mode 100755 index 3d414eb9..e6ecd8de --- a/Mozu.Api/Contracts/ProductAdmin/PublishingScope.cs +++ b/Mozu.Api/Contracts/ProductAdmin/PublishingScope.cs @@ -19,19 +19,10 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class PublishingScope { - /// - ///Specifies whether all the pending product drafts are affected by the operation performed. For example, when you perform the PublishDrafts operation and you set this field to true, all pending product changes in the master catalog or in a publish set are published. - /// public bool? AllPending { get; set; } - /// - ///A list of product codes of associated products. When this field is in the Product Publishing resource, you can use this field to publish or delete individual pending product changes, or assign individual pending product changes to a publish set. - /// public List ProductCodes { get; set; } - /// - ///The unique identifier of the product publish set.You can use this field to perform operations on all the pending product changes assigned to a publish set. For example, when you perform the PublishDrafts operation, you can specify the publish set that the pending product changes are assigned to in order to publish all of the pending changes. If you specify a publishSetCode, the respecting operation is performed on all pending product changes assigned to the publish set, even if you specify individual productCodes. - /// public string PublishSetCode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Search/SearchSynonymSettings.cs b/Mozu.Api/Contracts/ProductAdmin/Search/SearchSynonymSettings.cs old mode 100644 new mode 100755 index 1bc7542c..9da3e080 --- a/Mozu.Api/Contracts/ProductAdmin/Search/SearchSynonymSettings.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Search/SearchSynonymSettings.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.ProductAdmin.Search { - /// - /// Settings for search synonyms for search results. - /// public class SearchSynonymSettings { - /// - ///Indicates if synonyms should be expanded. - /// public bool ExpandSynonyms { get; set; } - /// - ///Sets the boost for the words actually sent in the query. - /// public decimal MainPartBoost { get; set; } - /// - ///Boosts the synonyms to affect rankings for search results. - /// public decimal SynonymPartBoost { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRule.cs b/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRule.cs old mode 100644 new mode 100755 index ede0aa5c..b4f10eeb --- a/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRule.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRule.cs @@ -15,74 +15,32 @@ namespace Mozu.Api.Contracts.ProductAdmin.Search { - /// - /// Mozu.ProductAdmin.Contracts.Search.SearchTuningRule ApiType DOCUMENT_HERE - /// public class SearchTuningRule { - /// - ///Specifies whether the search results tuning rule is active. - /// public bool Active { get; set; } - /// - ///The date that the search tuning rule is no longer active. - /// public DateTime? ActiveEndDate { get; set; } - /// - ///The date the search tuning rule starts being active. - /// public DateTime? ActiveStartDate { get; set; } - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///A list of product codes that you wish to block from appearing on a search result, or on a specific category page. Use the filters field to specify a category page. - /// public List BlockedProductCodes { get; set; } - /// - ///A list of product codes that you wish to explicitly boost using the search tuning rule. The order that you list products in defines the order that they appear in a search result, or category page. - /// public List BoostedProductCodes { get; set; } - /// - ///The filters that limit what the search tuning rule is applied to. Currently, the only supported filters are category pages.For example, you can limit the search tuning rule to only apply when a shopper either navigates to or searches for a specific keyword on a category page. - /// public List Filters { get; set; } - /// - ///Indicates if the object is default. This indicator is used for product variations and site search settings. If true, the value/object is the default option. - /// public bool IsDefault { get; set; } - /// - ///The keywords that trigger the search tuning rule. These are specific keywords that shoppers search for. - /// public List Keywords { get; set; } - /// - ///The unique identifier of the search tuning rule. - /// public string SearchTuningRuleCode { get; set; } - /// - ///The description of the search tuning rule. Use this field for further identification purposes. - /// public string SearchTuningRuleDescription { get; set; } - /// - ///The name of the search tuning rule. Use this field for further identification purposes. - /// public string SearchTuningRuleName { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int SiteId { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleCollection.cs b/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleCollection.cs old mode 100644 new mode 100755 index 14ca642e..339f2f5c --- a/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.ProductAdmin.Search { - /// - /// Mozu.ProductAdmin.Contracts.Search.SearchTuningRuleCollection ApiType DOCUMENT_HERE - /// public class SearchTuningRuleCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleFilter.cs b/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleFilter.cs old mode 100644 new mode 100755 index dfbb3d65..2b42b99d --- a/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleFilter.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleFilter.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.ProductAdmin.Search { - /// - /// Mozu.ProductAdmin.Contracts.Search.SearchTuningRuleFilter ApiType DOCUMENT_HERE - /// public class SearchTuningRuleFilter { - /// - ///Mozu.ProductAdmin.Contracts.Search.SearchTuningRuleFilter field ApiTypeMember DOCUMENT_HERE - /// public string Field { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleSortFields.cs b/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleSortFields.cs old mode 100644 new mode 100755 index 91ddf2e9..42dddfdb --- a/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleSortFields.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Search/SearchTuningRuleSortFields.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ProductAdmin.Search { - /// - /// Mozu.ProductAdmin.Contracts.Search.SearchTuningRuleSortFields ApiType DOCUMENT_HERE - /// public class SearchTuningRuleSortFields { - /// - ///Specifies whether you want the product properties in sortFields to be white listed or black listed. When you white list a product property, any search tuning rules that affect that product property will be in effect whenever a shopper sorts by that product property. When you black list a product product, any search tuning rules that affect that product property will never be in effect whenever a shopper sorts by that product property.Valid values are: "WhiteList" or "BlackList".For more information about search tuning rule sort fields, refer to [Search Tuning Rules](../../../../developer/api-guides/search-tuning-rules.htm). - /// public string InclusionExclusionType { get; set; } - /// - ///A list of product properties that you want to apply the search tuning rule sort fields to. For example, you can set this field to "popularity" in order to make all search tuning rules that affect product popularity to always be in effect whenever a shopper sorts by popularity. - /// public List SortFields { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinition.cs b/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinition.cs old mode 100644 new mode 100755 index b699107a..e6a0715e --- a/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinition.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinition.cs @@ -14,24 +14,12 @@ namespace Mozu.Api.Contracts.ProductAdmin.Search { - /// - /// Properties of synonyms and their relations via keys and lists to determine search results. - /// public class SynonymDefinition { - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///The unique identifier of the synonym. - /// public int? SynonymId { get; set; } - /// - ///A list of comma seperated synonyms. If you do not specify a , uses a two way expansion. Refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information. - /// public List Synonyms { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinitionCollection.cs b/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinitionCollection.cs old mode 100644 new mode 100755 index 8cf64979..bd304f06 --- a/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinitionCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinitionCollection.cs @@ -14,9 +14,6 @@ namespace Mozu.Api.Contracts.ProductAdmin.Search { - /// - /// A collection of synonym definitions. - /// public class SynonymDefinitionCollection { /// @@ -24,14 +21,8 @@ public class SynonymDefinitionCollection /// public string LocaleCode { get; set; } - /// - ///Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. - /// public int SiteId { get; set; } - /// - ///List of mappings for this definition. - /// public List SynonymDefinitions { get; set; } /// diff --git a/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinitionPagedCollection.cs b/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinitionPagedCollection.cs old mode 100644 new mode 100755 index f50219df..f78bc163 --- a/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinitionPagedCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/Search/SynonymDefinitionPagedCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.ProductAdmin.Search { - /// - /// A paged collection of synonym definitions. - /// public class SynonymDefinitionPagedCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/SearchSettings.cs b/Mozu.Api/Contracts/ProductAdmin/SearchSettings.cs old mode 100644 new mode 100755 index f9fc4a5d..68d69bfd --- a/Mozu.Api/Contracts/ProductAdmin/SearchSettings.cs +++ b/Mozu.Api/Contracts/ProductAdmin/SearchSettings.cs @@ -20,14 +20,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class SearchSettings { - /// - ///Settings of keys and values for synonyms in search results. - /// public SearchSynonymSettings SearchSynonymSettings { get; set; } - /// - ///Settings for searches performed at the site level. - /// public List SiteSearchSettings { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/SiteSearchKeywordRelevancySettings.cs b/Mozu.Api/Contracts/ProductAdmin/SiteSearchKeywordRelevancySettings.cs old mode 100644 new mode 100755 index d387f80b..77aec6b2 --- a/Mozu.Api/Contracts/ProductAdmin/SiteSearchKeywordRelevancySettings.cs +++ b/Mozu.Api/Contracts/ProductAdmin/SiteSearchKeywordRelevancySettings.cs @@ -13,54 +13,24 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Properties for the site search keyword relevancy settings. Relevancy determines the calculated matched of entered search strings against keywords. The relevancy weight can determine the order of importance for matching a search term such as categories before or after product names. - /// public class SiteSearchKeywordRelevancySettings { - /// - ///The considered relevancy weight for the attributes. - /// public int AttributesWeight { get; set; } - /// - ///The considered relevancy weight for category names. - /// public int CategoryNamesWeight { get; set; } - /// - ///The considered relevancy weight for descriptions. - /// public int DescriptionWeight { get; set; } - /// - ///The considered relevancy weight for keywords. - /// public int KeywordsWeight { get; set; } - /// - ///The considered relevancy weight for mpn provider. - /// public int MpnWeight { get; set; } - /// - ///The weight for the name used in ranking search results. - /// public int NameWeight { get; set; } - /// - ///The considered relevancy weight for product code, as loose. - /// public int ProductCodeLooseWeight { get; set; } - /// - ///The considered relevancy weight for product code. - /// public int ProductCodeWeight { get; set; } - /// - ///The considered relevancy weight for UPCs. - /// public int UpcWeight { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/SiteSearchPhraseRelevancySettings.cs b/Mozu.Api/Contracts/ProductAdmin/SiteSearchPhraseRelevancySettings.cs old mode 100644 new mode 100755 index 19d4cc19..14285cac --- a/Mozu.Api/Contracts/ProductAdmin/SiteSearchPhraseRelevancySettings.cs +++ b/Mozu.Api/Contracts/ProductAdmin/SiteSearchPhraseRelevancySettings.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Properties for the site search phrase relevancy settings. Relevancy determines the calculated matched of entered search phrase strings against keywords. The relevancy weight can determine the order of importance for matching a search term such as categories before or after product names. - /// public class SiteSearchPhraseRelevancySettings { - /// - ///The considered relevancy weight for the attributes phrase. - /// public int AttributeWeight { get; set; } - /// - ///The considered relevancy weight for descriptions. - /// public int DescriptionWeight { get; set; } - /// - ///The weight for the name used in ranking search results. - /// public int NameWeight { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/SiteSearchRelevancyCustomField.cs b/Mozu.Api/Contracts/ProductAdmin/SiteSearchRelevancyCustomField.cs old mode 100644 new mode 100755 index bff1a5b9..7e51330c --- a/Mozu.Api/Contracts/ProductAdmin/SiteSearchRelevancyCustomField.cs +++ b/Mozu.Api/Contracts/ProductAdmin/SiteSearchRelevancyCustomField.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Properties for setting custom field site search keyword relevancy settings. Relevancy determines the calculated matched of entered search strings against keywords. The relevancy weight can determine the order of importance for matching a search term such as categories before or after product names. - /// public class SiteSearchRelevancyCustomField { - /// - ///Name of the field. - /// public string FieldName { get; set; } - /// - ///Relative weight of the field for relevancy purposes. - /// public int FieldWeight { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/SiteSearchSettings.cs b/Mozu.Api/Contracts/ProductAdmin/SiteSearchSettings.cs old mode 100644 new mode 100755 index 33af2d74..f5438557 --- a/Mozu.Api/Contracts/ProductAdmin/SiteSearchSettings.cs +++ b/Mozu.Api/Contracts/ProductAdmin/SiteSearchSettings.cs @@ -14,44 +14,20 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Properties for the site search settings. - /// public class SiteSearchSettings { - /// - ///Custom boost value for searches. - /// public List CustomBoosts { get; set; } - /// - ///Custom field for searches. - /// public List CustomFields { get; set; } - /// - ///Indicates if the object is default. This indicator is used for product variations and site search settings. If true, the value/object is the default option. - /// public bool IsDefault { get; set; } - /// - ///Specifies the minimum match percentage setting. The minimum match percentage is a percentage of the number of terms that must match a search request, rounded down. 's default minimum match percentage is 75%. To require all search terms match, set this value to 100%. - /// public int? MinimumMatchPercent { get; set; } - /// - ///The name for the search settings. - /// public string SettingsName { get; set; } - /// - ///The site keyword relevancy settings. - /// public SiteSearchKeywordRelevancySettings SiteKeywordRelevancy { get; set; } - /// - ///The site phrase relevancy settings. - /// public SiteSearchPhraseRelevancySettings SitePhraseRelevancy { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/SoftAllocation.cs b/Mozu.Api/Contracts/ProductAdmin/SoftAllocation.cs old mode 100644 new mode 100755 index 571bc348..4fdc2bb0 --- a/Mozu.Api/Contracts/ProductAdmin/SoftAllocation.cs +++ b/Mozu.Api/Contracts/ProductAdmin/SoftAllocation.cs @@ -14,49 +14,22 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.SoftAllocation ApiType DOCUMENT_HERE - /// public class SoftAllocation { - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The date and time in UTC format that the soft allocation expires. - /// public DateTime? ExpiresAt { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } - /// - ///The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. - /// public string LocationCode { get; set; } - /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// public string ProductCode { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int? Quantity { get; set; } - /// - ///Entity RefrenceID this allocation is linked to. - /// public string ReferenceId { get; set; } - /// - ///item Id of the RefrenceID. - /// public string ReferenceItemId { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/SoftAllocationCollection.cs b/Mozu.Api/Contracts/ProductAdmin/SoftAllocationCollection.cs old mode 100644 new mode 100755 index f78257ae..379c5f95 --- a/Mozu.Api/Contracts/ProductAdmin/SoftAllocationCollection.cs +++ b/Mozu.Api/Contracts/ProductAdmin/SoftAllocationCollection.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.SoftAllocationCollection ApiType DOCUMENT_HERE - /// public class SoftAllocationCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of pages of the results divided per the `pageSize`. - /// public int PageCount { get; set; } - /// - ///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. - /// public int PageSize { get; set; } - /// - ///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=50`. - /// public int StartIndex { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/SoftAllocationRenew.cs b/Mozu.Api/Contracts/ProductAdmin/SoftAllocationRenew.cs old mode 100644 new mode 100755 index 1f66ef53..05030067 --- a/Mozu.Api/Contracts/ProductAdmin/SoftAllocationRenew.cs +++ b/Mozu.Api/Contracts/ProductAdmin/SoftAllocationRenew.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// Mozu.ProductAdmin.Contracts.SoftAllocationRenew ApiType DOCUMENT_HERE - /// public class SoftAllocationRenew { - /// - ///The updated date and time in UTC format that you wish the soft allocations to expire on. - /// public DateTime? ExpiresAt { get; set; } - /// - ///A comma-separate list of unique identifiers of the soft allocations to renew. - /// public List Ids { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/StackingConfiguration.cs b/Mozu.Api/Contracts/ProductAdmin/StackingConfiguration.cs new file mode 100755 index 00000000..1626b21b --- /dev/null +++ b/Mozu.Api/Contracts/ProductAdmin/StackingConfiguration.cs @@ -0,0 +1,26 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.ProductAdmin +{ + public class StackingConfiguration + { + public int ProductLineItemLayers { get; set; } + + public int ProductOrderLayers { get; set; } + + public bool StackingEnabled { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/ProductAdmin/TargetedCategory.cs b/Mozu.Api/Contracts/ProductAdmin/TargetedCategory.cs old mode 100644 new mode 100755 index 9721d485..9222f8ef --- a/Mozu.Api/Contracts/ProductAdmin/TargetedCategory.cs +++ b/Mozu.Api/Contracts/ProductAdmin/TargetedCategory.cs @@ -18,9 +18,6 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class TargetedCategory { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int? Id { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/TargetedProduct.cs b/Mozu.Api/Contracts/ProductAdmin/TargetedProduct.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/ProductAdmin/TargetedShippingMethod.cs b/Mozu.Api/Contracts/ProductAdmin/TargetedShippingMethod.cs old mode 100644 new mode 100755 index d38b2ba7..3c17fd95 --- a/Mozu.Api/Contracts/ProductAdmin/TargetedShippingMethod.cs +++ b/Mozu.Api/Contracts/ProductAdmin/TargetedShippingMethod.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductAdmin /// public class TargetedShippingMethod { - /// - ///The code associated with the carrier's shipping method service type. Service type codes include a prefix that indicates the carrier. For example: FEDEX_INTERNATIONAL_STANDARD - /// public string Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/ProductAdmin/TargetedShippingZone.cs b/Mozu.Api/Contracts/ProductAdmin/TargetedShippingZone.cs old mode 100644 new mode 100755 index 5132f08d..538d6a1f --- a/Mozu.Api/Contracts/ProductAdmin/TargetedShippingZone.cs +++ b/Mozu.Api/Contracts/ProductAdmin/TargetedShippingZone.cs @@ -13,14 +13,8 @@ namespace Mozu.Api.Contracts.ProductAdmin { - /// - /// The targeted shipping zone for the product. - /// public class TargetedShippingZone { - /// - ///The zone string for the tenant domain. - /// public string Zone { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/AppliedDiscount.cs b/Mozu.Api/Contracts/ProductRuntime/AppliedDiscount.cs old mode 100644 new mode 100755 index 6b2c4f69..814072cb --- a/Mozu.Api/Contracts/ProductRuntime/AppliedDiscount.cs +++ b/Mozu.Api/Contracts/ProductRuntime/AppliedDiscount.cs @@ -9,6 +9,7 @@ //------------------------------------------------------------------------------ using System; +using System.Collections.Generic; namespace Mozu.Api.Contracts.ProductRuntime @@ -18,19 +19,12 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class AppliedDiscount { - /// - ///Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// public string CouponCode { get; set; } - /// - ///Name of the discount added and applied to a shopping cart and order for a shopper's purchase. - /// public Discount Discount { get; set; } - /// - ///The value of the discount applied to the cart or order, represented as a negative currency amount to apply to the original price. - /// + public List Discounts { get; set; } + public decimal Impact { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/AttributeDetail.cs b/Mozu.Api/Contracts/ProductRuntime/AttributeDetail.cs old mode 100644 new mode 100755 index b6de2c6e..2ab28b42 --- a/Mozu.Api/Contracts/ProductRuntime/AttributeDetail.cs +++ b/Mozu.Api/Contracts/ProductRuntime/AttributeDetail.cs @@ -18,69 +18,36 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class AttributeDetail { - /// - ///Indicates whether the attribute should be able to be used in filters, facets, and sorting on the public storefront. - /// public bool AllowFilteringAndSortingInStorefront { get; set; } - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///Unique sequence of the attribute for its data type. - /// public int DataTypeSequence { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Defines the intended display of this attribute in the storefront. Options include Drop Down, Image Picker, and Radio Buttons. - /// public string DisplayIntention { get; set; } - /// - ///Specifies whether to create a case-sensitive Solr search index. The default is . - /// public bool? IndexValueWithCase { get; set; } - /// - ///The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea. - /// public string InputType { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } /// - ///Indicates if the attribute value is searchable on the public storefront. + ///Indicates whether the attribute value is searchable in the storefont by a shopper. /// public bool SearchableInStorefront { get; set; } /// - ///Indicates what kind of values search queries and returns. If true, the system indexes the display value of string attributes instead of the canonical value for searching. Always use the canonical value for filtering. This does not apply for non-string attributes. + ///If true, the system indexes the display value of string attributes instead of the canonical value for searching. The canonical value is always used for filtering. This does not apply for for non-string attributes. /// public bool SearchDisplayValue { get; set; } - /// - ///The usage type of the product attribute, which is property, option, or extra. - /// public string UsageType { get; set; } - /// - ///Properties used when validating a value entered for an object, including extensible attributes, products attributes, and database entries. - /// public AttributeValidation Validation { get; set; } - /// - ///An attribute value type is either predefined vocabulary by the admin during attribute set up or user-defined with an appropriate type (AdminEntered or ShopperEntered depending on the user). These types are used by products and attributes. The difference between predefined values versus manually entered values is such that the first choice is a set of options to choose from. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order. - /// public string ValueType { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/AttributeValidation.cs b/Mozu.Api/Contracts/ProductRuntime/AttributeValidation.cs old mode 100644 new mode 100755 index 9c235ade..b8fc4ad4 --- a/Mozu.Api/Contracts/ProductRuntime/AttributeValidation.cs +++ b/Mozu.Api/Contracts/ProductRuntime/AttributeValidation.cs @@ -14,43 +14,22 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Validates the attribute configured for the customer in the storefront against the attribute configured in . + /// Validates the attribute configured for the product in the storefront against the attribute configured in product admin. /// public class AttributeValidation { - /// - ///The maximum date allowed including month, day, and year. System-supplied and read-only. - /// public DateTime? MaxDateValue { get; set; } - /// - ///The maximum number that can be entered as a value for an extensible attribute. - /// public double MaxNumericValue { get; set; } - /// - ///The maximum character length possible for a string value entered for an extensible attribute. - /// public int? MaxStringLength { get; set; } - /// - ///The minimum date allowed including month, day, and year. System-supplied and read-only. - /// public DateTime? MinDateValue { get; set; } - /// - ///The minimum numeric value required to validate an extensible attribute. - /// public double MinNumericValue { get; set; } - /// - ///The minimum character length possible for a string value entered for an extensible attribute. - /// public int? MinStringLength { get; set; } - /// - ///Regular expression used to process and validate an extensible attribute value that require special formatting, such as phone numbers. - /// public string RegularExpression { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/AttributeVocabularyValueDisplayInfo.cs b/Mozu.Api/Contracts/ProductRuntime/AttributeVocabularyValueDisplayInfo.cs old mode 100644 new mode 100755 index ad359b7a..3e3a4ecc --- a/Mozu.Api/Contracts/ProductRuntime/AttributeVocabularyValueDisplayInfo.cs +++ b/Mozu.Api/Contracts/ProductRuntime/AttributeVocabularyValueDisplayInfo.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// Provides the display information for attribute vocabulary values. - /// public class AttributeVocabularyValueDisplayInfo { - /// - ///The identifier of the image in the CMS. Supply a value for either the CMS ID or Image URL parameter. - /// public string CmsId { get; set; } - /// - ///Hex value for a color to display in a color picker. This is an HTML supported code for color. - /// public string ColorValue { get; set; } - /// - ///The URL link for the image file associated with a product or category. - /// public string ImageUrl { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/BundledProduct.cs b/Mozu.Api/Contracts/ProductRuntime/BundledProduct.cs old mode 100644 new mode 100755 index 4df90487..15750053 --- a/Mozu.Api/Contracts/ProductRuntime/BundledProduct.cs +++ b/Mozu.Api/Contracts/ProductRuntime/BundledProduct.cs @@ -19,27 +19,27 @@ namespace Mozu.Api.Contracts.ProductRuntime public class BundledProduct { /// - ///Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes. + ///Localizable product content defined for the product bundle. System-supplied and read only. /// public ProductContent Content { get; set; } /// - ///The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. + ///When the goodsType is DigitalCredit this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. /// public decimal? CreditValue { get; set; } /// - ///The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit. + ///This is the goods type of the product. Possible values are “Physical,” and “DigitalCredit”. This comes from the productType of the product. Products are defaulted to a Physical goodsType. Gift cards have a goodsType of DigitalCredit. /// public string GoodsType { get; set; } /// - ///Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior. + ///This contains the inventory information about bundled products. If it manages stock, it specifies what the out of stock behavior is. /// public ProductInventoryInfo InventoryInfo { get; set; } /// - ///Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself. + ///If true, the component product of the bundle should not ship in a package with the rest of the product bundle, and should ship in a package by itself. System-supplied and read only. /// public bool? IsPackagedStandAlone { get; set; } @@ -49,12 +49,12 @@ public class BundledProduct public PackageMeasurements Measurements { get; set; } /// - ///Fully qualified name of the selected option's attribute. Bundledproducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When `optionAttributeFQN `is null, the bundled item was statically defined. When not null, the item came from an extra selection. + ///BundledProducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When optionAttributeFQN is null, the bundled item was statically defined, when not null, the item came from an extra selection. /// public string OptionAttributeFQN { get; set; } /// - ///The value of the option attribute. These values are associated and used by product bundles and options. + ///Properties of a value associated with a product option attribute. /// public object OptionValue { get; set; } @@ -63,13 +63,10 @@ public class BundledProduct /// public string ProductCode { get; set; } - /// - ///A product type is like a product template. - /// public string ProductType { get; set; } /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. + ///The quantity of the component product in the product bundle. System-supplied and read only. /// public int Quantity { get; set; } diff --git a/Mozu.Api/Contracts/ProductRuntime/BundledProductSummary.cs b/Mozu.Api/Contracts/ProductRuntime/BundledProductSummary.cs old mode 100644 new mode 100755 index 83ccc328..5e4356c5 --- a/Mozu.Api/Contracts/ProductRuntime/BundledProductSummary.cs +++ b/Mozu.Api/Contracts/ProductRuntime/BundledProductSummary.cs @@ -19,22 +19,22 @@ namespace Mozu.Api.Contracts.ProductRuntime public class BundledProductSummary { /// - ///The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. + ///When the goodsType is DigitalCredit this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. /// public decimal? CreditValue { get; set; } /// - ///The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit. + ///This is the goods type of the product. Possible values are “Physical,” and “DigitalCredit”. This comes from the productType of the product. Products are defaulted to a Physical goodsType. Gift cards have a goodsType of DigitalCredit. /// public string GoodsType { get; set; } /// - ///Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior. + ///This contains the inventory information about bundled products. If it manages stock, it specifies what the out of stock behavior is. /// public ProductInventoryInfo InventoryInfo { get; set; } /// - ///Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself. + ///If true, the component product of the bundle should not ship in a package with the rest of the product bundle, and should ship in a package by itself. System-supplied and read only. /// public bool? IsPackagedStandAlone { get; set; } @@ -44,12 +44,12 @@ public class BundledProductSummary public PackageMeasurements Measurements { get; set; } /// - ///Fully qualified name of the selected option's attribute. Bundledproducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When `optionAttributeFQN `is null, the bundled item was statically defined. When not null, the item came from an extra selection. + ///BundledProducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When optionAttributeFQN is null, the bundled item was statically defined, when not null, the item came from an extra selection. /// public string OptionAttributeFQN { get; set; } /// - ///The value of the option attribute. These values are associated and used by product bundles and options. + ///Properties of a value associated with a product option attribute. /// public object OptionValue { get; set; } @@ -59,22 +59,19 @@ public class BundledProductSummary public string ProductCode { get; set; } /// - ///The name of the product that represents a line item in a taxable order or product bundle. + ///The read-only name of the component in the bundled product. /// public string ProductName { get; set; } /// - ///Brief text description of the product or component in a product bundle, typically used when the product is displayed in a list or in search results. + ///The short description defined for the component in a bundled product. System-supplied and read only. /// public string ProductShortDescription { get; set; } - /// - ///A product type is like a product template. - /// public string ProductType { get; set; } /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. + ///The quantity of a component product in its product bundle. /// public int Quantity { get; set; } diff --git a/Mozu.Api/Contracts/ProductRuntime/Category.cs b/Mozu.Api/Contracts/ProductRuntime/Category.cs old mode 100644 new mode 100755 index 19684acc..5189091d --- a/Mozu.Api/Contracts/ProductRuntime/Category.cs +++ b/Mozu.Api/Contracts/ProductRuntime/Category.cs @@ -15,48 +15,27 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// A descriptive container that groups products. A category is merchant defined with associated products and discounts as configured. GThe storefront displays products in a hierarchy of categories. As such, categories can include a nesting of sub-categories to organize products and product options per set guidelines such as color, brand, material, and size. + /// Properties of the product category that appears on the storefront. /// public class Category { - /// - ///External unique identifier of the category. - /// public string CategoryCode { get; set; } - /// - ///Unique identifier for the storefront container used to organize products. - /// public int CategoryId { get; set; } - /// - ///List of the subcategories in the hierarchy for the specified categories. - /// public List ChildrenCategories { get; set; } - /// - ///Complex type that contains content for a language specified by LocaleCode. - /// public CategoryContent Content { get; set; } - /// - ///The total number of associated items. - /// public int? Count { get; set; } /// - ///Indicates if the object is displayed on the storefront. If true, the admin product category is displayed in the store. If false, the category is not displayed. + ///If true, the category is displayed on the website storefront. /// public bool IsDisplayed { get; set; } - /// - ///If applicable, the parent category in the hierarchy for the specified category. - /// public Category ParentCategory { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int? Sequence { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/CategoryCollection.cs b/Mozu.Api/Contracts/ProductRuntime/CategoryCollection.cs old mode 100644 new mode 100755 index 67122808..080a5052 --- a/Mozu.Api/Contracts/ProductRuntime/CategoryCollection.cs +++ b/Mozu.Api/Contracts/ProductRuntime/CategoryCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class CategoryCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/CategoryContent.cs b/Mozu.Api/Contracts/ProductRuntime/CategoryContent.cs old mode 100644 new mode 100755 index bfeb24fa..7dd60049 --- a/Mozu.Api/Contracts/ProductRuntime/CategoryContent.cs +++ b/Mozu.Api/Contracts/ProductRuntime/CategoryContent.cs @@ -19,44 +19,20 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class CategoryContent { - /// - ///Array list of media images associated to a product category. These images may be localized in the language specified by the LocaleCode. Images display with the category on the storefront according to the code and formatting of your site theme. Each image includes the name, alt text, and URL location. - /// public List CategoryImages { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Description defined for metadata, used to interally manage data, in the language specified by the `localeCode`. This content is used by categories, products, localized content, and SEO content. - /// public string MetaTagDescription { get; set; } - /// - ///Keywords defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Keywords are used by content for categories, products, localized content, and SEO content. - /// public string MetaTagKeywords { get; set; } - /// - ///Title defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Titles are used by content for categories, products, localized content, and SEO content. - /// public string MetaTagTitle { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Title that appears on new product category pages, in the language specified by the `localeCode`. - /// public string PageTitle { get; set; } - /// - ///Slug is used in place of a name, code, or ID to give an SEO, human-friendly URL link for an object, used by categories. - /// public string Slug { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/CategoryImage.cs b/Mozu.Api/Contracts/ProductRuntime/CategoryImage.cs old mode 100644 new mode 100755 index a2849efe..010fd68b --- a/Mozu.Api/Contracts/ProductRuntime/CategoryImage.cs +++ b/Mozu.Api/Contracts/ProductRuntime/CategoryImage.cs @@ -18,39 +18,21 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class CategoryImage { - /// - ///Descriptive text associated with the image or video that appears on the web storefront. This text displays on a hover-over in the browser, providing further information on the content displayed. The alternate text should be plain alphanumeric text without special characters or HTML coding. - /// public string AltText { get; set; } /// - ///The identifier of the image in the CMS. Supply a value for either the CMS ID or Image URL parameter. + ///The identifier of the category image in the Mozu CMS. Supply a value for either the CMS ID or Image URL parameter. /// public string CmsId { get; set; } - /// - ///The localized title for an image that displays on the storefront. If localized, the displayed content is set per the locale code for the site. - /// public string ImageLabel { get; set; } - /// - ///The URL link for the image file associated with a product or category. - /// public string ImageUrl { get; set; } - /// - ///Type of media specification required to successfully render the image, video, or other media content for products and categories. - /// public string MediaType { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int? Sequence { get; set; } - /// - ///The URL of a video files for a product or category. The path name is set in the language specified by the LocaleCode. - /// public string VideoUrl { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/CategoryPagedCollection.cs b/Mozu.Api/Contracts/ProductRuntime/CategoryPagedCollection.cs old mode 100644 new mode 100755 index ea8a0ca0..8a5aa037 --- a/Mozu.Api/Contracts/ProductRuntime/CategoryPagedCollection.cs +++ b/Mozu.Api/Contracts/ProductRuntime/CategoryPagedCollection.cs @@ -15,30 +15,18 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// The container for paged lists of related site-specific product category properties. + /// Paged collection of categories and related properties. /// public class CategoryPagedCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ConfiguredProduct.cs b/Mozu.Api/Contracts/ProductRuntime/ConfiguredProduct.cs old mode 100644 new mode 100755 index e197279c..927d6dd9 --- a/Mozu.Api/Contracts/ProductRuntime/ConfiguredProduct.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ConfiguredProduct.cs @@ -19,74 +19,45 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class ConfiguredProduct { - /// - ///List of shipping discounts that can be applied to the configured product. These discounts are calculated and updated as shoppers add content to their cart and continue checkout steps to order submission. - /// public List AvailableShippingDiscounts { get; set; } /// - ///List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both. + ///The list of fulfillment types the product supports. /// public List FulfillmentTypesSupported { get; set; } - /// - ///Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior. - /// public ProductInventoryInfo InventoryInfo { get; set; } - /// - ///Dimensions of the packaged product. - /// public PackageMeasurements Measurements { get; set; } /// - ///The manufacturer's part number for the product. + ///The manufacturer part number supplied for the product. /// public string MfgPartNumber { get; set; } - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } - /// - ///Unit price that the tenant intends to sell the product if no sale price is set. - /// public ProductPrice Price { get; set; } - /// - ///For products with options that vary the cost of the product, the range between lowest and highest possible price of the product based on the current selection of options. - /// + public ProductProperty PriceListEntryTypeProperty { get; set; } + public ProductPriceRange PriceRange { get; set; } - /// - ///Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// public string ProductCode { get; set; } - /// - ///The current state of the configured product determines whether or not the product is eligible for purchase. Products with options are only purchasable if the shopper has selected all required options. If the product is not ready for purchase, a message lists missing options that are required. - /// public ProductPurchasableState PurchasableState { get; set; } + public string PurchaseLocation { get; set; } + /// - ///The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels. + ///The universal product code defined for the product. /// public string Upc { get; set; } - /// - ///Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// public string VariationProductCode { get; set; } - /// - ///The details of any volume price bands associated with the product.Refer to [Volume Pricing](https://www.mozu.com/docs/guides/catalog/price-lists.htm#volume_pricing) for more information. - /// public List VolumePriceBands { get; set; } - /// - ///The details of the volume price range associated with the product. Volume price ranges consist of a lower price and an upper price, and either lower or upper prices can be affected by discounts.You can display the volume price range on product listing pages, such as category and search result pages, and product detail pages.Refer to [Volume Pricing Storefront Behavior](https://www.mozu.com/docs/guides/catalog/price-lists.htm#volume_pricing_storefront_behavior) for more information. - /// public ProductPriceRange VolumePriceRange { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/Discount.cs b/Mozu.Api/Contracts/ProductRuntime/Discount.cs old mode 100644 new mode 100755 index 3c912678..010f6e98 --- a/Mozu.Api/Contracts/ProductRuntime/Discount.cs +++ b/Mozu.Api/Contracts/ProductRuntime/Discount.cs @@ -14,28 +14,21 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Name of the discount added and applied to a shopping cart and order for a shopper's purchase. + /// Properties of a defined product, order, or shipping discount. /// public class Discount { - /// - ///The unique identifier of the discount. - /// public int DiscountId { get; set; } - /// - ///Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only. - /// public DateTime? ExpirationDate { get; set; } /// - ///The localizable, shopper-facing description defined for a discount or a storefront message. + ///Client-defined description that displays for the shopper on the web storefront. /// public string FriendlyDescription { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// + public decimal Impact { get; set; } + public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/DiscountSelections.cs b/Mozu.Api/Contracts/ProductRuntime/DiscountSelections.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Contracts/ProductRuntime/DiscountValidationSummary.cs b/Mozu.Api/Contracts/ProductRuntime/DiscountValidationSummary.cs old mode 100644 new mode 100755 index 8d33973d..9a5713eb --- a/Mozu.Api/Contracts/ProductRuntime/DiscountValidationSummary.cs +++ b/Mozu.Api/Contracts/ProductRuntime/DiscountValidationSummary.cs @@ -20,7 +20,7 @@ namespace Mozu.Api.Contracts.ProductRuntime public class DiscountValidationSummary { /// - ///List of discounts available per configured conditions and criteria. These discounts are associated with products, orders, and shipping costs. Shoppers can view these discounts per order, per product in an order, or for their shipping depending on the configuration. + ///List of discount IDs the shopper can redeem for a product in its current state. /// public List ApplicableDiscounts { get; set; } diff --git a/Mozu.Api/Contracts/ProductRuntime/Facet.cs b/Mozu.Api/Contracts/ProductRuntime/Facet.cs old mode 100644 new mode 100755 index 204fe8ae..1d0ad41e --- a/Mozu.Api/Contracts/ProductRuntime/Facet.cs +++ b/Mozu.Api/Contracts/ProductRuntime/Facet.cs @@ -15,28 +15,16 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Properties of the facet used to retrieve documents. + /// Properties of the facet used to index product searches on a storefront. /// public class Facet { - /// - ///The type of facet. Valid values are "range" (enables creation of a range of values) or "value" (populates the facet values based on the associated attribute or category). - /// public string FacetType { get; set; } - /// - ///The field name associated with the facet. - /// public string Field { get; set; } - /// - ///Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. - /// public string Label { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/FacetValue.cs b/Mozu.Api/Contracts/ProductRuntime/FacetValue.cs old mode 100644 new mode 100755 index 31e1780a..09d72c66 --- a/Mozu.Api/Contracts/ProductRuntime/FacetValue.cs +++ b/Mozu.Api/Contracts/ProductRuntime/FacetValue.cs @@ -19,54 +19,24 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class FacetValue { - /// - ///If applicable, the values of any subcategory facets in a hierarchy. Hierarchical facets only apply for product categories. - /// public List ChildrenFacetValues { get; set; } - /// - ///The total number of associated items. - /// public int Count { get; set; } - /// - ///Submits the selected facet value as a facet value filter. - /// public string FilterValue { get; set; } - /// - ///If true, the facet value is applied as a filter in the storefront product search. - /// public bool? IsApplied { get; set; } - /// - ///Indicates if the object is displayed on the storefront. If true, the admin product category is displayed in the store. If false, the category is not displayed. - /// public bool IsDisplayed { get; set; } - /// - ///Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. - /// public string Label { get; set; } - /// - ///If applicable, the values of any parent category facets in a hierarchy. Hierarchical facets only apply for product categories. - /// public string ParentFacetValue { get; set; } - /// - ///The maximum value selected or entered for the facet range query. - /// public string RangeQueryValueEnd { get; set; } - /// - ///The minimum value selected or entered for the facet range query. - /// public string RangeQueryValueStart { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/LocationInventory.cs b/Mozu.Api/Contracts/ProductRuntime/LocationInventory.cs old mode 100644 new mode 100755 index 6537b1c0..21021125 --- a/Mozu.Api/Contracts/ProductRuntime/LocationInventory.cs +++ b/Mozu.Api/Contracts/ProductRuntime/LocationInventory.cs @@ -14,28 +14,16 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Properties of an inventory definition that defines the level of inventory for a specific product at a given location. + /// Properties of the active product inventory levels for a specific location. /// public class LocationInventory { - /// - ///The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. - /// public string LocationCode { get; set; } - /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// public string ProductCode { get; set; } - /// - ///The soft stock level for the associated product currently available, at specified locations, and based on the number of pending soft product allocations as applicable. This value is associated with the resource and operations. - /// public int? SoftStockAvailable { get; set; } - /// - ///The stock level for the associated product currently available, at specified locations, and based on the number of pending product reservations as applicable. System-supplied and read only. - /// public int? StockAvailable { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/LocationInventoryCollection.cs b/Mozu.Api/Contracts/ProductRuntime/LocationInventoryCollection.cs old mode 100644 new mode 100755 index d5f567f3..e0618c32 --- a/Mozu.Api/Contracts/ProductRuntime/LocationInventoryCollection.cs +++ b/Mozu.Api/Contracts/ProductRuntime/LocationInventoryCollection.cs @@ -15,18 +15,12 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Array list of inventory definitions that manage the stock level of products at a given location. + /// Paged collection of product inventory information by location. /// public class LocationInventoryCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/LocationInventoryQuery.cs b/Mozu.Api/Contracts/ProductRuntime/LocationInventoryQuery.cs old mode 100644 new mode 100755 index 766d18ef..57308dfb --- a/Mozu.Api/Contracts/ProductRuntime/LocationInventoryQuery.cs +++ b/Mozu.Api/Contracts/ProductRuntime/LocationInventoryQuery.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// Properties for the product location inventory provided for queries to locate products by their location. - /// public class LocationInventoryQuery { - /// - ///List of location codes to associate with the location usage. At this time, you can only specify one location code in the request for the direct ship location usage type. - /// public List LocationCodes { get; set; } - /// - ///A list of product codes of associated products. When this field is in the Product Publishing resource, you can use this field to publish or delete individual pending product changes, or assign individual pending product changes to a publish set. - /// public List ProductCodes { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/PackageMeasurements.cs b/Mozu.Api/Contracts/ProductRuntime/PackageMeasurements.cs old mode 100644 new mode 100755 index 59cf92c6..153a89bf --- a/Mozu.Api/Contracts/ProductRuntime/PackageMeasurements.cs +++ b/Mozu.Api/Contracts/ProductRuntime/PackageMeasurements.cs @@ -19,24 +19,12 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class PackageMeasurements { - /// - ///Height of a package or bundle package in imperial units of feet and inches. - /// public Measurement PackageHeight { get; set; } - /// - ///Length of a package or bundle package in imperial units of feet and inches. - /// public Measurement PackageLength { get; set; } - /// - ///Weight of a package or bundle package in imperial units of pounds and ounces. - /// public Measurement PackageWeight { get; set; } - /// - ///Width of a package or bundle package in imperial units of feet and inches. - /// public Measurement PackageWidth { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/PriceList.cs b/Mozu.Api/Contracts/ProductRuntime/PriceList.cs old mode 100644 new mode 100755 index a1c0935f..0d1e8f03 --- a/Mozu.Api/Contracts/ProductRuntime/PriceList.cs +++ b/Mozu.Api/Contracts/ProductRuntime/PriceList.cs @@ -14,69 +14,30 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// The details of the price list. - /// public class PriceList { - /// - ///A list of price lists and their details that describe the ancestor/parent hierarchy of the current price list. Each price list within this list is an ancestor/parent of the current price list. An ancestor/parent price list can have it's own ancestor/parent, which is denoted by . - /// public List Ancestors { get; set; } - /// - ///A list of price lists and their details that describe the descendant/child hierarchy of the current price list. Each price list within this list is an descendant/child of the current price list. A descendant/child price list can have it's own descendant/child, which is denoted by . - /// public List Descendants { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists. - /// public bool Enabled { get; set; } - /// - ///Indicates whether the price list is exclusive. When a price list is exclusive, shoppers that resolve to the exclusive price list can only view and purchase products that have price entries in the price list and any of its parents. The default is . - /// public bool FilteredInStoreFront { get; set; } - /// - ///Specifies whether the price list is indexed for the site. - /// public bool? IsIndexed { get; set; } - /// - ///Specifies whether the price list is the default price list for the site. Refer to [Default](../../../guides/catalog/price-lists.htm#default) in the Price Lists guides topic for more information. - /// public bool IsSiteDefault { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The unique, user-defined code of the price list. - /// public string PriceListCode { get; set; } - /// - ///The internal identifier of the price list. - /// public int PriceListId { get; set; } - /// - ///Specifies whether the price list is resolvable. When , is able to apply the price list and its product pricing directly to a shopper. When , is unable to apply the price list and its product pricing directly to a shopper; however can still apply the price list to a shopper if it is a parent of a resolvable price list. Refer to [Resolution](../../../guides/catalog/price-lists.htm#resolution) in the Price Lists guides topic for more information. - /// public bool Resolvable { get; set; } - /// - ///A list of site identifiers for which the price list is valid. - /// public List ValidSites { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/PriceListNode.cs b/Mozu.Api/Contracts/ProductRuntime/PriceListNode.cs old mode 100644 new mode 100755 index 7690f4dc..db5bd364 --- a/Mozu.Api/Contracts/ProductRuntime/PriceListNode.cs +++ b/Mozu.Api/Contracts/ProductRuntime/PriceListNode.cs @@ -13,29 +13,14 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// Mozu.ProductRuntime.Contracts.PriceListNode ApiType DOCUMENT_HERE - /// public class PriceListNode { - /// - ///Specifies the id of the price list's parent within the ancestor/descendant hierarchy, if applicable. - /// public int? ParentPriceListId { get; set; } - /// - ///Specifies the code of the price list within the ancestor/descendant hierarchy, if applicable. - /// public string PriceListCode { get; set; } - /// - ///Specifies the internal id of the price list within the ancestor/descendant hierarchy, if applicable. - /// public int PriceListId { get; set; } - /// - ///Denotes the place of the ancestor/descendant within the hierarchy. A value of 1 is the closest ancestor/descendant to the current price list. For example an ancestor that has a value of 1 is the direct parent of the current price list. - /// public int PriceListLevel { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/Product.cs b/Mozu.Api/Contracts/ProductRuntime/Product.cs old mode 100644 new mode 100755 index 86f9ba16..15cfea2d --- a/Mozu.Api/Contracts/ProductRuntime/Product.cs +++ b/Mozu.Api/Contracts/ProductRuntime/Product.cs @@ -15,97 +15,57 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// The properties of a product, referenced and used by carts, orders, wish lists, and returns. + /// Properties of the product that appears on a designated storefront. /// public class Product { - /// - ///List of shipping discounts that can be applied to the configured product. These discounts are calculated and updated as shoppers add content to their cart and continue checkout steps to order submission. - /// public List AvailableShippingDiscounts { get; set; } /// - ///Properties of a collection of component products that make up a single product bundle with its own product code. Tenants can define product bundles for any product type that supports the Bundle product usage. + ///Properties of a collection of component products that make up a single product bundle with its own product code. /// public List BundledProducts { get; set; } - /// - ///The date and time in UTC when the product is no longer active in the catalog. - /// public DateTime? CatalogEndDate { get; set; } - /// - ///The date and time in UTC format when the product is active in the catalog. - /// public DateTime? CatalogStartDate { get; set; } - /// - ///The list of all categories associated with the product. These categories contain products, can have discounts associated, and define the grouping of products to display on the storefront. - /// public List Categories { get; set; } - /// - ///Complex type that contains content for a language specified by LocaleCode. - /// public ProductContent Content { get; set; } - /// - ///Date and time when the entity was created, represented in UTC Date/Time. - /// public DateTime CreateDate { get; set; } - /// - ///The date and time in UTC format when the product first became available in the catalog. This field is used to calculate the number of days the product has been available in the catalog for a dynamic expression. - /// public DateTime? DateFirstAvailableInCatalog { get; set; } - /// - ///The total number of days the product has been available in the catalog. This field is related to the DaysAvailableInCatalog field in a dynamic expression. - /// public int? DaysAvailableInCatalog { get; set; } /// - ///List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both. + ///The list of fulfillment types the product supports. /// public List FulfillmentTypesSupported { get; set; } - /// - ///The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit. - /// public string GoodsType { get; set; } - /// - ///Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior. - /// public ProductInventoryInfo InventoryInfo { get; set; } - /// - ///Indicates if the object or feature is active. - /// public bool? IsActive { get; set; } /// - ///Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself. + ///If true, this product cannot ship in a package with other products and must ship in a package by itself. /// public bool? IsPackagedStandAlone { get; set; } - /// - ///Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. - /// public bool IsRecurring { get; set; } - /// - ///Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules. - /// public bool IsTaxable { get; set; } - /// - ///Dimensions of the packaged product. - /// + public List LocationsInStock { get; set; } + public PackageMeasurements Measurements { get; set; } /// - ///The manufacturer's part number for the product. + ///The manufacturer part number defined for the product. /// public string MfgPartNumber { get; set; } @@ -114,44 +74,23 @@ public class Product /// public List MfgPartNumbers { get; set; } - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } - /// - ///Unit price that the tenant intends to sell the product if no sale price is set. - /// public ProductPrice Price { get; set; } - /// - ///For products with options that vary the cost of the product, the range between lowest and highest possible price of the product based on the current selection of options. - /// public ProductPriceRange PriceRange { get; set; } /// - ///Properties that describe the behavior the system uses when determining the price of products. + ///Describes the behavior the system uses when determining the price of the product. /// public ProductPricingBehaviorInfo PricingBehavior { get; set; } - /// - ///Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// public string ProductCode { get; set; } - /// - ///Integer that represents the sequential order of the product. - /// public int? ProductSequence { get; set; } - /// - ///A product type is like a product template. - /// public string ProductType { get; set; } - /// - ///The unique identifier of the product type of the product. - /// public int? ProductTypeId { get; set; } /// @@ -159,24 +98,14 @@ public class Product /// public string ProductUsage { get; set; } - /// - ///Collection of property attributes defined for the object. Properties are associated to all objects within , including documents, products, and product types. - /// public List Properties { get; set; } - /// - ///The current state of the document or product definition. States for documents include Active, Draft, or Latest. Active documents are published and cannot be deleted. Querying Latest returns the most recent version of the document, regardless of whether it is published or a draft. States for product include New, Draft, or Live. - /// public string PublishState { get; set; } - /// - ///The current state of the configured product determines whether or not the product is eligible for purchase. Products with options are only purchasable if the shopper has selected all required options. If the product is not ready for purchase, a message lists missing options that are required. - /// public ProductPurchasableState PurchasableState { get; set; } - /// - ///The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels. - /// + public string PurchaseLocation { get; set; } + public string Upc { get; set; } /// @@ -184,34 +113,16 @@ public class Product /// public List UpCs { get; set; } - /// - ///The date and time in UTC format the object was updated most recently. - /// public DateTime UpdateDate { get; set; } - /// - ///A list of price lists for which the product is valid. - /// public List ValidPriceLists { get; set; } - /// - ///Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// public string VariationProductCode { get; set; } - /// - ///A summary of all variations that exist for the product. - /// public List Variations { get; set; } - /// - ///The details of any volume price bands associated with the product.Refer to [Volume Pricing](https://www.mozu.com/docs/guides/catalog/price-lists.htm#volume_pricing) for more information. - /// public List VolumePriceBands { get; set; } - /// - ///The details of the volume price range associated with the product. Volume price ranges consist of a lower price and an upper price, and either lower or upper prices can be affected by discounts.You can display the volume price range on product listing pages, such as category and search result pages, and product detail pages.Refer to [Volume Pricing Storefront Behavior](https://www.mozu.com/docs/guides/catalog/price-lists.htm#volume_pricing_storefront_behavior) for more information. - /// public ProductPriceRange VolumePriceRange { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductCollection.cs b/Mozu.Api/Contracts/ProductRuntime/ProductCollection.cs old mode 100644 new mode 100755 index 6e3bd99d..17a3d949 --- a/Mozu.Api/Contracts/ProductRuntime/ProductCollection.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductCollection.cs @@ -15,35 +15,20 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// The container for a set of products. + /// Collection of products and their related properties. /// public class ProductCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///This parameter is associated with deep paging. If you started a deep paged request by specifying , returns an encoded value for the . In your most immediate subsequent request, set to the same value you received for to continue paging. When is null, you've reached the end of paged results. - /// public string NextCursorMark { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductContent.cs b/Mozu.Api/Contracts/ProductRuntime/ProductContent.cs old mode 100644 new mode 100755 index 5b6e3ef9..6d8ea8b6 --- a/Mozu.Api/Contracts/ProductRuntime/ProductContent.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductContent.cs @@ -19,44 +19,20 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class ProductContent { - /// - ///Description defined for metadata, used to interally manage data, in the language specified by the `localeCode`. This content is used by categories, products, localized content, and SEO content. - /// public string MetaTagDescription { get; set; } - /// - ///Keywords defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Keywords are used by content for categories, products, localized content, and SEO content. - /// public string MetaTagKeywords { get; set; } - /// - ///Title defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Titles are used by content for categories, products, localized content, and SEO content. - /// public string MetaTagTitle { get; set; } - /// - ///Lengthy full description for a product description, displayed on product detail pages within the storefront. - /// public string ProductFullDescription { get; set; } - /// - ///List of image files associated with a product. This content may include the image file URL, name, and other information as available. - /// public List ProductImages { get; set; } - /// - ///The name of the product that represents a line item in a taxable order or product bundle. - /// public string ProductName { get; set; } - /// - ///Brief text description of the product or component in a product bundle, typically used when the product is displayed in a list or in search results. - /// public string ProductShortDescription { get; set; } - /// - ///The search engine optimized, human-readable portion of the URL. The content is localized according to the product's `localeCode`. - /// public string SeoFriendlyUrl { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductCost.cs b/Mozu.Api/Contracts/ProductRuntime/ProductCost.cs old mode 100644 new mode 100755 index 097aea78..9ce8b468 --- a/Mozu.Api/Contracts/ProductRuntime/ProductCost.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductCost.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// The cost a client pays the supplier to stock the product. - /// public class ProductCost { - /// - ///cost ApiType DOCUMENT_HERE - /// public decimal Cost { get; set; } - /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// public string ProductCode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductCostCollection.cs b/Mozu.Api/Contracts/ProductRuntime/ProductCostCollection.cs old mode 100644 new mode 100755 index 2a0b785b..37788c9e --- a/Mozu.Api/Contracts/ProductRuntime/ProductCostCollection.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductCostCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// Mozu.ProductRuntime.Contracts.ProductCostCollection ApiType DOCUMENT_HERE - /// public class ProductCostCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductCostQuery.cs b/Mozu.Api/Contracts/ProductRuntime/ProductCostQuery.cs old mode 100644 new mode 100755 index 5f657e9e..59745afb --- a/Mozu.Api/Contracts/ProductRuntime/ProductCostQuery.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductCostQuery.cs @@ -14,14 +14,8 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// Mozu.ProductRuntime.Contracts.ProductCostQuery ApiType DOCUMENT_HERE - /// public class ProductCostQuery { - /// - ///A list of product codes of associated products. When this field is in the Product Publishing resource, you can use this field to publish or delete individual pending product changes, or assign individual pending product changes to a publish set. - /// public List ProductCodes { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductImage.cs b/Mozu.Api/Contracts/ProductRuntime/ProductImage.cs old mode 100644 new mode 100755 index 06973e9c..a81bd742 --- a/Mozu.Api/Contracts/ProductRuntime/ProductImage.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductImage.cs @@ -18,39 +18,21 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class ProductImage { - /// - ///Descriptive text associated with the image or video that appears on the web storefront. This text displays on a hover-over in the browser, providing further information on the content displayed. The alternate text should be plain alphanumeric text without special characters or HTML coding. - /// public string AltText { get; set; } /// - ///The identifier of the image in the CMS. Supply a value for either the CMS ID or Image URL parameter. + ///The identifier of the product image in the Mozu CMS. Supply a value for either the CMS ID or the Image URL parameter. /// public string CmsId { get; set; } - /// - ///The localized title for an image that displays on the storefront. If localized, the displayed content is set per the locale code for the site. - /// public string ImageLabel { get; set; } - /// - ///The URL link for the image file associated with a product or category. - /// public string ImageUrl { get; set; } - /// - ///Type of media specification required to successfully render the image, video, or other media content for products and categories. - /// public string MediaType { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int? Sequence { get; set; } - /// - ///The URL of a video files for a product or category. The path name is set in the language specified by the LocaleCode. - /// public string VideoUrl { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductInventoryInfo.cs b/Mozu.Api/Contracts/ProductRuntime/ProductInventoryInfo.cs old mode 100644 new mode 100755 index 575bc31b..949ad2e4 --- a/Mozu.Api/Contracts/ProductRuntime/ProductInventoryInfo.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductInventoryInfo.cs @@ -14,13 +14,10 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Properties of the inventory behavior associated with a product definition. + /// Properties of the active inventory managed for the product. /// public class ProductInventoryInfo { - /// - ///Indicates is the item's stock is managed. If true, manages inventory levels for this product. - /// public bool? ManageStock { get; set; } /// @@ -28,19 +25,10 @@ public class ProductInventoryInfo /// public string OnlineLocationCode { get; set; } - /// - ///Number of product items currently available for purchase. - /// public int? OnlineSoftStockAvailable { get; set; } - /// - ///The current number of products that are available for purchase. - /// public int? OnlineStockAvailable { get; set; } - /// - ///Determines the method this product uses when active stock is depeleted. Options include "DisplayMessage" to display an out of stock message to the shopper, "HideProduct" to disable the product on the storefront, or "AllowBackOrder" to allow the shopper to back order the product. This property is required only if manages inventory for this product. - /// public string OutOfStockBehavior { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductOption.cs b/Mozu.Api/Contracts/ProductRuntime/ProductOption.cs old mode 100644 new mode 100755 index a605e9d9..18cfc01e --- a/Mozu.Api/Contracts/ProductRuntime/ProductOption.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductOption.cs @@ -15,33 +15,18 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. + /// Represents configurable options that a shopper can choose when ordering a product, such as a t-shirt color and size. /// public class ProductOption { - /// - ///The product attribute details common between all attribute types - properties, options, and extras. - /// public AttributeDetail AttributeDetail { get; set; } - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///Indicates if the object has or can have multiple properties or values. If true, the object can have more than one value, selectable by shoppers through the storefront or configurable through the catalogs. - /// public bool? IsMultiValue { get; set; } - /// - ///Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value. - /// public bool? IsRequired { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductOptionSelection.cs b/Mozu.Api/Contracts/ProductRuntime/ProductOptionSelection.cs old mode 100644 new mode 100755 index 16d97fac..ecf55086 --- a/Mozu.Api/Contracts/ProductRuntime/ProductOptionSelection.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductOptionSelection.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class ProductOptionSelection { - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///Unique identifier of the attribute's value. - /// public int? AttributeValueId { get; set; } - /// - ///The value a shopper entered for an attribute that requires additional input for the product on a storefront. This entered value is a selected option or entered content for an extra, such as selecting a color or entering content for a monogram. - /// public object ShopperEnteredValue { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductOptionSelections.cs b/Mozu.Api/Contracts/ProductRuntime/ProductOptionSelections.cs old mode 100644 new mode 100755 index 9341219c..8ce06ec9 --- a/Mozu.Api/Contracts/ProductRuntime/ProductOptionSelections.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductOptionSelections.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class ProductOptionSelections { - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } - /// - ///Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// public string VariationProductCode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductOptionValue.cs b/Mozu.Api/Contracts/ProductRuntime/ProductOptionValue.cs old mode 100644 new mode 100755 index 995195f9..537cb51c --- a/Mozu.Api/Contracts/ProductRuntime/ProductOptionValue.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductOptionValue.cs @@ -14,63 +14,30 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Properties of a value associated with a product option attribute. + /// Represents the values that are the product option selections for a shopper to choose when ordering a product. /// public class ProductOptionValue { - /// - ///Unique identifier of the attribute's value. - /// public int AttributeValueId { get; set; } - /// - ///The bundled product of a product as extra - /// public BundledProduct BundledProduct { get; set; } - /// - ///If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".Refer to [Product Variant Pricing and Weight](../../../guides/catalog/products.htm#product_variant_pricing_and_weight) in the Products guides topic for more information. - /// public decimal? DeltaPrice { get; set; } - /// - ///The difference between the weight associated with this product, variation option, or extra and the base product. For example, if a product with a monogram weighs an extra 1/4 lb, the DeltaWeight value is "0.25". The amount of the delta is set by the weight type for the storefront. - /// public decimal? DeltaWeight { get; set; } - /// - ///Defines the intended display of this attribute in the storefront. Options include Drop Down, Image Picker, and Radio Buttons. - /// public AttributeVocabularyValueDisplayInfo DisplayInfo { get; set; } - /// - ///Indicates if the object is default. This indicator is used for product variations and site search settings. If true, the value/object is the default option. - /// public bool? IsDefault { get; set; } - /// - ///Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order. - /// public bool? IsEnabled { get; set; } - /// - ///If true, the entity is selected. If false, the entity is not selected. - /// public bool? IsSelected { get; set; } - /// - ///The value a shopper entered for an attribute that requires additional input for the product on a storefront. This entered value is a selected option or entered content for an extra, such as selecting a color or entering content for a monogram. - /// public object ShopperEnteredValue { get; set; } - /// - ///If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options. - /// public string StringValue { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductPrice.cs b/Mozu.Api/Contracts/ProductRuntime/ProductPrice.cs old mode 100644 new mode 100755 index f03a8e60..c234712d --- a/Mozu.Api/Contracts/ProductRuntime/ProductPrice.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductPrice.cs @@ -14,7 +14,7 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// The price of the product in the specified currency code (USD). This price can either be the sale price or the price for which the merchang intends to sell the product. + /// The price of the product in the specified currency code (USD). This price can either be the sale price or the price for which the merchant intends to sell the product. /// public class ProductPrice { @@ -28,53 +28,32 @@ public class ProductPrice /// public decimal? CatalogSalePrice { get; set; } - /// - ///The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards. - /// public decimal? CreditValue { get; set; } - /// - ///Name of the discount added and applied to a shopping cart and order for a shopper's purchase. - /// public AppliedDiscount Discount { get; set; } - /// - ///The price list code if a price list is applield to the product's pricing. - /// public string EffectivePricelistCode { get; set; } /// - ///The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier. + ///The manufacturer's suggested retail price for the product. /// public decimal? Msrp { get; set; } - /// - ///The price the merchant intends to charge for the product. - /// public decimal? Price { get; set; } - /// - ///The price list entry code that controls the product pricing, if a price list is applied to the product pricing. - /// public string PriceListEntryCode { get; set; } - /// - ///The pricing mode of the price list entry, if a price list is applied to the product pricing.The valid values are:* * A value of indicates the product has volume pricing. - /// public string PriceListEntryMode { get; set; } /// - ///The price type that displays in the price field on product listing pages and product detail pages on the storefront.The valid values are:* * * + ///The price type that displays on the storefront website for the Price field, which is List, MAP, or CatalogSalePrice /// public string PriceType { get; set; } - /// - ///The set sale price for a product consisting of a price with a discount already applied.For price list entries, this property is the product's sale price if the is set to . - /// public decimal? SalePrice { get; set; } /// - ///The sale price type that displays in the sale price field on product listing pages and product detail pages on the storefront.The valid values are:* * * + ///The price type that displays on the storefront website for the Sale Price field, which is CatalogSalePrice, DiscountedList, or DiscountedCatalogSalePrice /// public string SalePriceType { get; set; } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductPriceRange.cs b/Mozu.Api/Contracts/ProductRuntime/ProductPriceRange.cs old mode 100644 new mode 100755 index 23efdc70..c4ebfff7 --- a/Mozu.Api/Contracts/ProductRuntime/ProductPriceRange.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductPriceRange.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class ProductPriceRange { - /// - ///The lowest possible price value for a product with options that vary the cost of the product. - /// public ProductPrice Lower { get; set; } - /// - ///The highest possible price value for a product with options that vary the cost of the product. - /// public ProductPrice Upper { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductPricingBehaviorInfo.cs b/Mozu.Api/Contracts/ProductRuntime/ProductPricingBehaviorInfo.cs old mode 100644 new mode 100755 index aed820a6..788be0da --- a/Mozu.Api/Contracts/ProductRuntime/ProductPricingBehaviorInfo.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductPricingBehaviorInfo.cs @@ -19,7 +19,7 @@ namespace Mozu.Api.Contracts.ProductRuntime public class ProductPricingBehaviorInfo { /// - ///Indicates if the discount is restricted. If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval.For price list entries, specifies whether discounts are restricted for the specific entry if is set to .Refer to [Discount Restriction](../../../guides/catalog/price-lists.htm#discountrestriction) in the Price Lists guides topic for more information. + ///If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval. /// public bool? DiscountsRestricted { get; set; } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductProperty.cs b/Mozu.Api/Contracts/ProductRuntime/ProductProperty.cs old mode 100644 new mode 100755 index 2a3efbf3..e5bd7770 --- a/Mozu.Api/Contracts/ProductRuntime/ProductProperty.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductProperty.cs @@ -15,33 +15,18 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Details of a property defined for a product. + /// Details of a property attribute defined for a product. /// public class ProductProperty { - /// - ///The product attribute details common between all attribute types - properties, options, and extras. - /// public AttributeDetail AttributeDetail { get; set; } - /// - ///The fully qualified name of the attribute, which is a user defined attribute identifier. - /// public string AttributeFQN { get; set; } - /// - ///Indicates if the object is hidden or breaks inheritance, primarily used by facets, products, and attribute vocabulary values. For example, if true, the attribute vocabulary value does not appear in the list when defining a value for an attribute. - /// public bool? IsHidden { get; set; } - /// - ///Indicates if the object has or can have multiple properties or values. If true, the object can have more than one value, selectable by shoppers through the storefront or configurable through the catalogs. - /// public bool? IsMultiValue { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductPropertyValue.cs b/Mozu.Api/Contracts/ProductRuntime/ProductPropertyValue.cs old mode 100644 new mode 100755 index 12e353fb..39c923bf --- a/Mozu.Api/Contracts/ProductRuntime/ProductPropertyValue.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductPropertyValue.cs @@ -14,23 +14,14 @@ namespace Mozu.Api.Contracts.ProductRuntime { /// - /// Properties of a value for a product property. + /// Values of a product property attribute. /// public class ProductPropertyValue { - /// - ///Defines the intended display of this attribute in the storefront. Options include Drop Down, Image Picker, and Radio Buttons. - /// public AttributeVocabularyValueDisplayInfo DisplayInfo { get; set; } - /// - ///If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options. - /// public string StringValue { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductPurchasableState.cs b/Mozu.Api/Contracts/ProductRuntime/ProductPurchasableState.cs old mode 100644 new mode 100755 index 26608baf..fde068ef --- a/Mozu.Api/Contracts/ProductRuntime/ProductPurchasableState.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductPurchasableState.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class ProductPurchasableState { - /// - ///If true, the entity has met all requirements and considered a purchasable entity. - /// public bool IsPurchasable { get; set; } - /// - ///Array list of validation and status messages associated with shipping rates, orders, and product purchasable state. - /// public List Messages { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductSearchRandomAccessCursor.cs b/Mozu.Api/Contracts/ProductRuntime/ProductSearchRandomAccessCursor.cs old mode 100644 new mode 100755 index da301d14..9f8e2964 --- a/Mozu.Api/Contracts/ProductRuntime/ProductSearchRandomAccessCursor.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductSearchRandomAccessCursor.cs @@ -14,14 +14,8 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// Mozu.ProductRuntime.Contracts.ProductSearchRandomAccessCursor ApiType DOCUMENT_HERE - /// public class ProductSearchRandomAccessCursor { - /// - ///A calculated set of cursor marks for a given query that can be accessed in any order, providing the ability to page through all results in a random or parallelized order. You provide one of the generated cursor mark sets to the parameter of the operation in the resource or the operation in the resource. - /// public List CursorMarks { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductSearchResult.cs b/Mozu.Api/Contracts/ProductRuntime/ProductSearchResult.cs old mode 100644 new mode 100755 index 7abeeb3f..8fe5f66a --- a/Mozu.Api/Contracts/ProductRuntime/ProductSearchResult.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductSearchResult.cs @@ -19,41 +19,20 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class ProductSearchResult { - /// - ///The facets applied to index products in the product search result. - /// public List Facets { get; set; } - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///This parameter is associated with deep paging. If you started a deep paged request by specifying , returns an encoded value for the . In your most immediate subsequent request, set to the same value you received for to continue paging. When is null, you've reached the end of paged results. - /// public string NextCursorMark { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///Mozu.ProductRuntime.Contracts.ProductSearchResult solrDebugInfo ApiTypeMember DOCUMENT_HERE - /// public SolrDebugInfo SolrDebugInfo { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductValidationSummary.cs b/Mozu.Api/Contracts/ProductRuntime/ProductValidationSummary.cs old mode 100644 new mode 100755 index 130e73eb..e26f85d0 --- a/Mozu.Api/Contracts/ProductRuntime/ProductValidationSummary.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductValidationSummary.cs @@ -20,48 +20,30 @@ namespace Mozu.Api.Contracts.ProductRuntime public class ProductValidationSummary { /// - ///Properties of a collection of component products that make up a single product bundle with its own product code. Tenants can define product bundles for any product type that supports the Bundle product usage. + ///Properties of a collection of component products that make up a single product bundle with its own product code. /// public List BundledProducts { get; set; } - /// - ///The list of all categories associated with the product. These categories contain products, can have discounts associated, and define the grouping of products to display on the storefront. - /// public List Categories { get; set; } /// - ///List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both. + ///List of fulfillment types that the product supports. /// public List FulfillmentTypesSupported { get; set; } - /// - ///The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit. - /// public string GoodsType { get; set; } - /// - ///The image configured for the product on the storefront. - /// public ProductImage Image { get; set; } - /// - ///Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior. - /// public ProductInventoryInfo InventoryInfo { get; set; } /// - ///Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself. + ///If true, this product should not be packaged with other items and should ship by itself. /// public bool? IsPackagedStandAlone { get; set; } - /// - ///Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules. - /// public bool IsTaxable { get; set; } - /// - ///Dimensions of the packaged product. - /// public PackageMeasurements Measurements { get; set; } /// @@ -69,59 +51,37 @@ public class ProductValidationSummary /// public string MfgPartNumber { get; set; } - /// - ///Price that the merchant intends to sell the product which is not necessarily the list price. This is the price the merchant intends to sell the product if no sale price is present. - /// public ProductPrice Price { get; set; } /// - ///Properties that describe the behavior the system uses when determining the price of products. + ///Properties that describe the behavior the system uses when determining the price of the product. /// public ProductPricingBehaviorInfo PricingBehavior { get; set; } - /// - ///Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// public string ProductCode { get; set; } - /// - ///The name of the product that represents a line item in a taxable order or product bundle. - /// public string ProductName { get; set; } - /// - ///Brief text description of the product or component in a product bundle, typically used when the product is displayed in a list or in search results. - /// public string ProductShortDescription { get; set; } - /// - ///A product type is like a product template. - /// public string ProductType { get; set; } /// - ///The usage type that applies to this product, which is Standard (a single product without configurable options), Configurable (a product that includes configurable option attributes), Bundle (a collection of products sold as a single entity), or Component (an invididual product that represents a component in a bundle). + ///The usage type of this product, which is Standard (a single product without configurable options), Configurable (a product that includes configurable option attributes), Bundle (a collection of products sold as a single entity), or Component (an invididual product that represents a component in a bundle). /// public string ProductUsage { get; set; } - /// - ///Collection of property attributes defined for the object. Properties are associated to all objects within , including documents, products, and product types. - /// public List Properties { get; set; } - /// - ///The current state of the configured product determines whether or not the product is eligible for purchase. Products with options are only purchasable if the shopper has selected all required options. If the product is not ready for purchase, a message lists missing options that are required. - /// public ProductPurchasableState PurchasableState { get; set; } + public string PurchaseLocation { get; set; } + /// - ///The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels. + ///The universal product code defined for the product. /// public string Upc { get; set; } - /// - ///Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// public string VariationProductCode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ProductVolumePrice.cs b/Mozu.Api/Contracts/ProductRuntime/ProductVolumePrice.cs old mode 100644 new mode 100755 index ef9b20b5..ec01bc3f --- a/Mozu.Api/Contracts/ProductRuntime/ProductVolumePrice.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ProductVolumePrice.cs @@ -13,34 +13,16 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// The product price in the applicable volume band. - /// public class ProductVolumePrice { - /// - ///Specifies whether the volume pricing is current for the product. - /// public bool IsCurrent { get; set; } - /// - ///The maximum product quantity of the volume price band. A shopper must purchase a quantity equal to or less than down to the in order to receive the pricing in the volume band. - /// public int? MaxQty { get; set; } - /// - ///The minimum product quantity of the volume price band. A shopper must purchase a quantity equal to or greater than up to the in order to receive the pricing in the volume band. - /// public int MinQty { get; set; } - /// - ///The product price in the applicable volume band. - /// public ProductPrice Price { get; set; } - /// - ///For products with options that vary the cost of the product, the range between lowest and highest possible price of the product based on the current selection of options. - /// public ProductPriceRange PriceRange { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ResolvedPriceList.cs b/Mozu.Api/Contracts/ProductRuntime/ResolvedPriceList.cs old mode 100644 new mode 100755 index 7d93211f..2bc997b4 --- a/Mozu.Api/Contracts/ProductRuntime/ResolvedPriceList.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ResolvedPriceList.cs @@ -13,29 +13,14 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// Mozu.ProductRuntime.Contracts.ResolvedPriceList ApiType DOCUMENT_HERE - /// public class ResolvedPriceList { - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The code of the price list to which the customer resolves. - /// public string PriceListCode { get; set; } - /// - ///The internal id of the price list to which the customer resolves. - /// public int PriceListId { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/SearchSuggestion.cs b/Mozu.Api/Contracts/ProductRuntime/SearchSuggestion.cs old mode 100644 new mode 100755 index 2da9f388..4442332c --- a/Mozu.Api/Contracts/ProductRuntime/SearchSuggestion.cs +++ b/Mozu.Api/Contracts/ProductRuntime/SearchSuggestion.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class SearchSuggestion { - /// - ///A suggested entity based on the search query. Use the SuggestionType to determine the type of entity. Could be a SearchTerm, Product, or Category - /// public object Suggestion { get; set; } - /// - ///The type of Suggestion (e.g. Term, Product, Category). Will be one of the values of the SuggestionTypeConst type. - /// public string SuggestionType { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/SearchSuggestionGroup.cs b/Mozu.Api/Contracts/ProductRuntime/SearchSuggestionGroup.cs old mode 100644 new mode 100755 index 587b46ee..386ebe6d --- a/Mozu.Api/Contracts/ProductRuntime/SearchSuggestionGroup.cs +++ b/Mozu.Api/Contracts/ProductRuntime/SearchSuggestionGroup.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// A group of product search terms to suggest to a customer based on defined queries. - /// public class SearchSuggestionGroup { - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///List of related SearchSuggestions - /// public List Suggestions { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/SearchSuggestionResult.cs b/Mozu.Api/Contracts/ProductRuntime/SearchSuggestionResult.cs old mode 100644 new mode 100755 index 8c8a1deb..744efb60 --- a/Mozu.Api/Contracts/ProductRuntime/SearchSuggestionResult.cs +++ b/Mozu.Api/Contracts/ProductRuntime/SearchSuggestionResult.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// The results of the suggested search terms made to the customer based on queries. - /// public class SearchSuggestionResult { - /// - ///Text that the shopper types in a search query. - /// public string Query { get; set; } - /// - ///List of SearchSuggestionGroups - /// public List SuggestionGroups { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/SolrDebugInfo.cs b/Mozu.Api/Contracts/ProductRuntime/SolrDebugInfo.cs old mode 100644 new mode 100755 index 42c57112..9da9754d --- a/Mozu.Api/Contracts/ProductRuntime/SolrDebugInfo.cs +++ b/Mozu.Api/Contracts/ProductRuntime/SolrDebugInfo.cs @@ -14,34 +14,16 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// A container of debugging information from Solr. - /// public class SolrDebugInfo { - /// - ///A list of products that have been blocked in Solr by search tuning rules. - /// public List BlockedProductCodes { get; set; } - /// - ///A list of products that have been boosted in Solr by search tuning rules. - /// public List BoostedProductCodes { get; set; } - /// - ///A list of boost functions sent to Solr by search tuning rules. - /// public List BoostFunctions { get; set; } - /// - ///A list of boost queries sent to Solr by search tuning rules. - /// public List BoostQueries { get; set; } - /// - ///A list of search tuning rule codes sent to Solr. - /// public string SearchTuningRuleCode { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/ValidationMessage.cs b/Mozu.Api/Contracts/ProductRuntime/ValidationMessage.cs old mode 100644 new mode 100755 index fd776744..724ca7af --- a/Mozu.Api/Contracts/ProductRuntime/ValidationMessage.cs +++ b/Mozu.Api/Contracts/ProductRuntime/ValidationMessage.cs @@ -18,29 +18,14 @@ namespace Mozu.Api.Contracts.ProductRuntime /// public class ValidationMessage { - /// - ///The text of the change message, such as "This product is no longer available." System-supplied and read-only. - /// public string Message { get; set; } - /// - ///The severity level of validation failures for shipping rates and products. - /// public string Severity { get; set; } - /// - ///Source for an action or container for originating content. Source is used as an origin for validation and notification messages based on successful or failed actions. For originating content, source is used for the facet source information, including the category, price, or attribute properties. - /// public string Source { get; set; } - /// - ///Unique identifier of the entity that triggered the validation. - /// public string SourceId { get; set; } - /// - ///Type of validation error that occurred. This can be checked programatically. Must be one of the values in ValidationTypeConst. - /// public string ValidationType { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/VariationOption.cs b/Mozu.Api/Contracts/ProductRuntime/VariationOption.cs old mode 100644 new mode 100755 index 2dfa4f2c..6ce8cb5a --- a/Mozu.Api/Contracts/ProductRuntime/VariationOption.cs +++ b/Mozu.Api/Contracts/ProductRuntime/VariationOption.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// Mozu.ProductRuntime.Contracts.VariationOption ApiType DOCUMENT_HERE - /// public class VariationOption { - /// - ///The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name. - /// public string AttributeFQN { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } - /// - ///The number that denotes the order of the entity value within a list of entity values. - /// public int ValueSequence { get; set; } } diff --git a/Mozu.Api/Contracts/ProductRuntime/VariationSummary.cs b/Mozu.Api/Contracts/ProductRuntime/VariationSummary.cs old mode 100644 new mode 100755 index 8e35d783..eb7d7fc0 --- a/Mozu.Api/Contracts/ProductRuntime/VariationSummary.cs +++ b/Mozu.Api/Contracts/ProductRuntime/VariationSummary.cs @@ -14,24 +14,12 @@ namespace Mozu.Api.Contracts.ProductRuntime { - /// - /// Mozu.ProductRuntime.Contracts.VariationSummary ApiType DOCUMENT_HERE - /// public class VariationSummary { - /// - ///Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior. - /// public ProductInventoryInfo InventoryInfo { get; set; } - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } - /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// public string ProductCode { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/AddressSchema.cs b/Mozu.Api/Contracts/Reference/AddressSchema.cs old mode 100644 new mode 100755 index f1aac4c9..8360d040 --- a/Mozu.Api/Contracts/Reference/AddressSchema.cs +++ b/Mozu.Api/Contracts/Reference/AddressSchema.cs @@ -19,24 +19,12 @@ namespace Mozu.Api.Contracts.Reference /// public class AddressSchema { - /// - ///The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// public string CountryCode { get; set; } - /// - ///The label associated with this country. - /// public string CountryLabel { get; set; } - /// - ///The list of fields to display for a view or an associated schema. For example, the address schema would display fields for postal addresses. - /// public List Fields { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/AddressSchemaCollection.cs b/Mozu.Api/Contracts/Reference/AddressSchemaCollection.cs old mode 100644 new mode 100755 index 64112457..df09378e --- a/Mozu.Api/Contracts/Reference/AddressSchemaCollection.cs +++ b/Mozu.Api/Contracts/Reference/AddressSchemaCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Reference /// public class AddressSchemaCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/ContentLocale.cs b/Mozu.Api/Contracts/Reference/ContentLocale.cs old mode 100644 new mode 100755 index e4acc4c5..218a32b3 --- a/Mozu.Api/Contracts/Reference/ContentLocale.cs +++ b/Mozu.Api/Contracts/Reference/ContentLocale.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Reference /// public class ContentLocale { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/ContentLocaleCollection.cs b/Mozu.Api/Contracts/Reference/ContentLocaleCollection.cs old mode 100644 new mode 100755 index 3cf993b3..b6ff4263 --- a/Mozu.Api/Contracts/Reference/ContentLocaleCollection.cs +++ b/Mozu.Api/Contracts/Reference/ContentLocaleCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Reference /// public class ContentLocaleCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/Country.cs b/Mozu.Api/Contracts/Reference/Country.cs old mode 100644 new mode 100755 index a7b26d24..48973d93 --- a/Mozu.Api/Contracts/Reference/Country.cs +++ b/Mozu.Api/Contracts/Reference/Country.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Reference /// public class Country { - /// - ///The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// public string Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/CountryCollection.cs b/Mozu.Api/Contracts/Reference/CountryCollection.cs old mode 100644 new mode 100755 index cb257fa2..883a4f54 --- a/Mozu.Api/Contracts/Reference/CountryCollection.cs +++ b/Mozu.Api/Contracts/Reference/CountryCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Reference /// public class CountryCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/CountryWithStates.cs b/Mozu.Api/Contracts/Reference/CountryWithStates.cs old mode 100644 new mode 100755 index b64f5f7c..f8163009 --- a/Mozu.Api/Contracts/Reference/CountryWithStates.cs +++ b/Mozu.Api/Contracts/Reference/CountryWithStates.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.Reference { - /// - /// A country and its states. Contrains the 2-letter geographic code representing the country and any states within the country. - /// public class CountryWithStates { - /// - ///The two character country code. - /// public string Code { get; set; } - /// - ///The state code, name, and tags, if applicable. - /// public List States { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/CountryWithStatesCollection.cs b/Mozu.Api/Contracts/Reference/CountryWithStatesCollection.cs old mode 100644 new mode 100755 index b5262319..2d99215a --- a/Mozu.Api/Contracts/Reference/CountryWithStatesCollection.cs +++ b/Mozu.Api/Contracts/Reference/CountryWithStatesCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.Reference { - /// - /// The paged collection of country codes and their corresponding names. - /// public class CountryWithStatesCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/Currency.cs b/Mozu.Api/Contracts/Reference/Currency.cs old mode 100644 new mode 100755 index 7116c7e7..623bb6f7 --- a/Mozu.Api/Contracts/Reference/Currency.cs +++ b/Mozu.Api/Contracts/Reference/Currency.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Reference /// public class Currency { - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/CurrencyCollection.cs b/Mozu.Api/Contracts/Reference/CurrencyCollection.cs old mode 100644 new mode 100755 index 7fc4e786..12eead1a --- a/Mozu.Api/Contracts/Reference/CurrencyCollection.cs +++ b/Mozu.Api/Contracts/Reference/CurrencyCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Reference /// public class CurrencyCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/Field.cs b/Mozu.Api/Contracts/Reference/Field.cs old mode 100644 new mode 100755 index 2e3484a8..02c55c84 --- a/Mozu.Api/Contracts/Reference/Field.cs +++ b/Mozu.Api/Contracts/Reference/Field.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Reference /// public class Field { - /// - ///Data for the field property. - /// public List Data { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. - /// public string Label { get; set; } - /// - ///Integer that represents the sequence order of the attribute. - /// public int Order { get; set; } - /// - ///Type of field. - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/FieldData.cs b/Mozu.Api/Contracts/Reference/FieldData.cs old mode 100644 new mode 100755 index 2aaff084..f51277eb --- a/Mozu.Api/Contracts/Reference/FieldData.cs +++ b/Mozu.Api/Contracts/Reference/FieldData.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.Reference /// public class FieldData { - /// - ///Code of the field. - /// public string Code { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/State.cs b/Mozu.Api/Contracts/Reference/State.cs old mode 100644 new mode 100755 index 342fd47c..9eee1a14 --- a/Mozu.Api/Contracts/Reference/State.cs +++ b/Mozu.Api/Contracts/Reference/State.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.Reference { - /// - /// The state code, name, and tags, if applicable. - /// public class State { - /// - ///The two character state code. - /// public string Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Distinguishing information about a state, such as IsArmedForces or IsUSTerritory - /// public string Tags { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/TimeZone.cs b/Mozu.Api/Contracts/Reference/TimeZone.cs old mode 100644 new mode 100755 index 10a82472..21ee83f9 --- a/Mozu.Api/Contracts/Reference/TimeZone.cs +++ b/Mozu.Api/Contracts/Reference/TimeZone.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.Reference /// public class TimeZone { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///If true, the time zone standard observes daylight savings time advancements, for example, twice a year so that evenings have more daylight and mornings have less. If false, the time zone standard does not adhere to daylight savings changes. - /// public bool IsDaylightSavingsTime { get; set; } - /// - ///The offset associated with the time zone, such as "-12". - /// public double Offset { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/TimeZoneCollection.cs b/Mozu.Api/Contracts/Reference/TimeZoneCollection.cs old mode 100644 new mode 100755 index 7d2cd912..b1fdb6de --- a/Mozu.Api/Contracts/Reference/TimeZoneCollection.cs +++ b/Mozu.Api/Contracts/Reference/TimeZoneCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Reference /// public class TimeZoneCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/TopLevelDomainCollection.cs b/Mozu.Api/Contracts/Reference/TopLevelDomainCollection.cs old mode 100644 new mode 100755 index 3cf01b69..4c2aff0d --- a/Mozu.Api/Contracts/Reference/TopLevelDomainCollection.cs +++ b/Mozu.Api/Contracts/Reference/TopLevelDomainCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Reference /// public class TopLevelDomainCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/UnitOfMeasure.cs b/Mozu.Api/Contracts/Reference/UnitOfMeasure.cs old mode 100644 new mode 100755 index 4d36a685..cb4cc06d --- a/Mozu.Api/Contracts/Reference/UnitOfMeasure.cs +++ b/Mozu.Api/Contracts/Reference/UnitOfMeasure.cs @@ -18,24 +18,12 @@ namespace Mozu.Api.Contracts.Reference /// public class UnitOfMeasure { - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The plural name of the unit of measure, such as "feet". - /// public string PluralName { get; set; } - /// - ///The abbreviated symbol for the unit of measure, such as "ft". - /// public string Symbol { get; set; } - /// - ///The type of measurement, such as length or volume. - /// public string UnitOfMeasureType { get; set; } } diff --git a/Mozu.Api/Contracts/Reference/UnitOfMeasureCollection.cs b/Mozu.Api/Contracts/Reference/UnitOfMeasureCollection.cs old mode 100644 new mode 100755 index 38449be9..e8e1da70 --- a/Mozu.Api/Contracts/Reference/UnitOfMeasureCollection.cs +++ b/Mozu.Api/Contracts/Reference/UnitOfMeasureCollection.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.Reference /// public class UnitOfMeasureCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/CarrierConfiguration.cs b/Mozu.Api/Contracts/ShippingAdmin/CarrierConfiguration.cs old mode 100644 new mode 100755 index 69538aa1..9cf2c9c7 --- a/Mozu.Api/Contracts/ShippingAdmin/CarrierConfiguration.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/CarrierConfiguration.cs @@ -20,39 +20,18 @@ namespace Mozu.Api.Contracts.ShippingAdmin /// public class CarrierConfiguration { - /// - ///Specifies whether credentials for the carrier are set. - /// public bool AreCredentialsSet { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///A list of any custom table rates for the carrier. - /// public List CustomTableRates { get; set; } - /// - ///Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists. - /// public bool Enabled { get; set; } - /// - ///Specifies whether the carrier is enabled for creating RMA labels. - /// public bool EnabledForReturns { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Wrapper for a group of properties such as a label that includes a value and a locale code, audit information, and a key-value pair. - /// public List Settings { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/CarrierConfigurationCollection.cs b/Mozu.Api/Contracts/ShippingAdmin/CarrierConfigurationCollection.cs old mode 100644 new mode 100755 index d8307c9d..f65e66b0 --- a/Mozu.Api/Contracts/ShippingAdmin/CarrierConfigurationCollection.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/CarrierConfigurationCollection.cs @@ -19,26 +19,14 @@ namespace Mozu.Api.Contracts.ShippingAdmin /// public class CarrierConfigurationCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/CustomTableRate.cs b/Mozu.Api/Contracts/ShippingAdmin/CustomTableRate.cs old mode 100644 new mode 100755 index 596d7cc4..f96ec76a --- a/Mozu.Api/Contracts/ShippingAdmin/CustomTableRate.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/CustomTableRate.cs @@ -13,29 +13,14 @@ namespace Mozu.Api.Contracts.ShippingAdmin { - /// - /// Mozu.ShippingAdmin.Contracts.CustomTableRate ApiType DOCUMENT_HERE - /// public class CustomTableRate { - /// - ///Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes. - /// public CustomTableRateContent Content { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The type of the custom rate. - /// public string RateType { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public decimal Value { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/CustomTableRateContent.cs b/Mozu.Api/Contracts/ShippingAdmin/CustomTableRateContent.cs old mode 100644 new mode 100755 index 42a15fca..46bd9684 --- a/Mozu.Api/Contracts/ShippingAdmin/CustomTableRateContent.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/CustomTableRateContent.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.ShippingAdmin { - /// - /// Mozu.ShippingAdmin.Contracts.CustomTableRateContent ApiType DOCUMENT_HERE - /// public class CustomTableRateContent { - /// - ///The two character locale code, per the country code provided. This code determines the localized content to use and display. - /// public string LocaleCode { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/LocalizableString.cs b/Mozu.Api/Contracts/ShippingAdmin/LocalizableString.cs old mode 100644 new mode 100755 index f46d6519..4dd07598 --- a/Mozu.Api/Contracts/ShippingAdmin/LocalizableString.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/LocalizableString.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ShippingAdmin /// public class LocalizableString { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/Profile/HandlingFeeRule.cs b/Mozu.Api/Contracts/ShippingAdmin/Profile/HandlingFeeRule.cs old mode 100644 new mode 100755 index 8fe696aa..b59b202d --- a/Mozu.Api/Contracts/ShippingAdmin/Profile/HandlingFeeRule.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/Profile/HandlingFeeRule.cs @@ -16,54 +16,24 @@ namespace Mozu.Api.Contracts.ShippingAdmin.Profile { - /// - /// Mozu.ShippingAdmin.Contracts.Profile.HandlingFeeRule ApiType DOCUMENT_HERE - /// public class HandlingFeeRule { - /// - ///Specifies to what the handling fee rule applies. - /// public string AppliesTo { get; set; } - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The unique codes of any product rules associated with the handling fee. - /// public List ProductTargetRuleCodes { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int Sequence { get; set; } - /// - ///An array of service type details that are associated with the handling fee. - /// public List ServiceTypes { get; set; } - /// - ///The unique codes of any shipping target rules associated with the handling fee. - /// public List ShippingTargetRuleCodes { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public decimal Value { get; set; } - /// - ///An attribute value type is either predefined vocabulary by the admin during attribute set up or user-defined with an appropriate type (AdminEntered or ShopperEntered depending on the user). These types are used by products and attributes. The difference between predefined values versus manually entered values is such that the first choice is a set of options to choose from. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order. - /// public string ValueType { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/Profile/HandlingFeeRuleCollection.cs b/Mozu.Api/Contracts/ShippingAdmin/Profile/HandlingFeeRuleCollection.cs old mode 100644 new mode 100755 index b35bc322..6af1b080 --- a/Mozu.Api/Contracts/ShippingAdmin/Profile/HandlingFeeRuleCollection.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/Profile/HandlingFeeRuleCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ShippingAdmin.Profile { - /// - /// Mozu.ShippingAdmin.Contracts.Profile.HandlingFeeRuleCollection ApiType DOCUMENT_HERE - /// public class HandlingFeeRuleCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingInclusionRule.cs b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingInclusionRule.cs old mode 100644 new mode 100755 index 8f28176f..e873b223 --- a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingInclusionRule.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingInclusionRule.cs @@ -16,39 +16,18 @@ namespace Mozu.Api.Contracts.ShippingAdmin.Profile { - /// - /// Mozu.ShippingAdmin.Contracts.Profile.ShippingInclusionRule ApiType DOCUMENT_HERE - /// public class ShippingInclusionRule { - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///The unique codes of any product target rules associated with the shipping inclusion rule. - /// public List ProductTargetRuleCodes { get; set; } - /// - ///The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories. - /// public int Sequence { get; set; } - /// - ///An array of service type details that are associated with the shipping inclusion rule. - /// public List ServiceTypes { get; set; } - /// - ///The unique codes of any shipping target rules associated with the shipping inclusion rule. - /// public List ShippingTargetRuleCodes { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingInclusionRuleCollection.cs b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingInclusionRuleCollection.cs old mode 100644 new mode 100755 index cbbaa53e..0f2c1971 --- a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingInclusionRuleCollection.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingInclusionRuleCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ShippingAdmin.Profile { - /// - /// Mozu.ShippingAdmin.Contracts.Profile.ShippingInclusionRuleCollection ApiType DOCUMENT_HERE - /// public class ShippingInclusionRuleCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingProfile.cs b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingProfile.cs old mode 100644 new mode 100755 index 9c20acca..ff311661 --- a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingProfile.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingProfile.cs @@ -15,39 +15,18 @@ namespace Mozu.Api.Contracts.ShippingAdmin.Profile { - /// - /// Mozu.ShippingAdmin.Contracts.Profile.ShippingProfile ApiType DOCUMENT_HERE - /// public class ShippingProfile { - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The unique code of the shipping profile. - /// public string Code { get; set; } - /// - ///A list of order handling fee rules and their details. - /// public List OrderHandlingFeeRules { get; set; } - /// - ///A list of product handling fee rules and their details. - /// public List ProductHandlingFeeRules { get; set; } - /// - ///A list of shipping inclusion rules and their details. - /// public List ShippingInclusionRules { get; set; } - /// - ///A list of unique site identifiers that the shipping profile targets. - /// public List TargetedSiteIds { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingProfileCollection.cs b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingProfileCollection.cs old mode 100644 new mode 100755 index 8b0409bb..05a97f07 --- a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingProfileCollection.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingProfileCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ShippingAdmin.Profile { - /// - /// Mozu.ShippingAdmin.Contracts.Profile.ShippingProfileCollection ApiType DOCUMENT_HERE - /// public class ShippingProfileCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingStates.cs b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingStates.cs old mode 100644 new mode 100755 index e5279520..c95635c1 --- a/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingStates.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/Profile/ShippingStates.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ShippingAdmin.Profile { - /// - /// Mozu.ShippingAdmin.Contracts.Profile.ShippingStates ApiType DOCUMENT_HERE - /// public class ShippingStates { - /// - ///The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// public string CountryCode { get; set; } - /// - ///The states of the shipping profile. - /// public List States { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/Profile/State.cs b/Mozu.Api/Contracts/ShippingAdmin/Profile/State.cs old mode 100644 new mode 100755 index 1cadc85c..73c7b38d --- a/Mozu.Api/Contracts/ShippingAdmin/Profile/State.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/Profile/State.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.ShippingAdmin.Profile { - /// - /// Mozu.ShippingAdmin.Contracts.Profile.State ApiType DOCUMENT_HERE - /// public class State { - /// - ///code ApiType DOCUMENT_HERE - /// public string Code { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/ServiceType.cs b/Mozu.Api/Contracts/ShippingAdmin/ServiceType.cs old mode 100644 new mode 100755 index 8cebf37e..89f22fa1 --- a/Mozu.Api/Contracts/ShippingAdmin/ServiceType.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/ServiceType.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ShippingAdmin /// public class ServiceType { - /// - ///The service type code supplied by the carrier. Service type codes include a prefix that indicates the carrier name. For example: FEDEX_INTERNATIONAL_STANDARD. - /// public string Code { get; set; } - /// - ///Complex type that contains content for a language specified by LocaleCode. - /// public ServiceTypeLocalizedContent Content { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/ServiceTypeLocalizedContent.cs b/Mozu.Api/Contracts/ShippingAdmin/ServiceTypeLocalizedContent.cs old mode 100644 new mode 100755 index 47eaffc0..ee631526 --- a/Mozu.Api/Contracts/ShippingAdmin/ServiceTypeLocalizedContent.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/ServiceTypeLocalizedContent.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ShippingAdmin /// public class ServiceTypeLocalizedContent { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/Setting.cs b/Mozu.Api/Contracts/ShippingAdmin/Setting.cs old mode 100644 new mode 100755 index 0f6c3356..a3f1d021 --- a/Mozu.Api/Contracts/ShippingAdmin/Setting.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/Setting.cs @@ -19,24 +19,12 @@ namespace Mozu.Api.Contracts.ShippingAdmin /// public class Setting { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. - /// public LocalizableString Label { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/TargetRule.cs b/Mozu.Api/Contracts/ShippingAdmin/TargetRule.cs old mode 100644 new mode 100755 index 42fb12fd..4283f534 --- a/Mozu.Api/Contracts/ShippingAdmin/TargetRule.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/TargetRule.cs @@ -13,29 +13,14 @@ namespace Mozu.Api.Contracts.ShippingAdmin { - /// - /// Mozu.ShippingAdmin.Contracts.TargetRule ApiType DOCUMENT_HERE - /// public class TargetRule { - /// - ///code ApiType DOCUMENT_HERE - /// public string Code { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Properties of the domain that the tenant is associated with such as the domain name, the zone string, audit information (system-supplied and read-only), assignment data, and whether or not the domain is primary or requires a SSL for authentication. - /// public string Domain { get; set; } - /// - ///expression ApiType DOCUMENT_HERE - /// public string Expression { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingAdmin/TargetRuleCollection.cs b/Mozu.Api/Contracts/ShippingAdmin/TargetRuleCollection.cs old mode 100644 new mode 100755 index 1aa13dc6..e5cd051e --- a/Mozu.Api/Contracts/ShippingAdmin/TargetRuleCollection.cs +++ b/Mozu.Api/Contracts/ShippingAdmin/TargetRuleCollection.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.ShippingAdmin { - /// - /// Mozu.ShippingAdmin.Contracts.TargetRuleCollection ApiType DOCUMENT_HERE - /// public class TargetRuleCollection { - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The total number of items in the list. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/CarrierRatesResponse.cs b/Mozu.Api/Contracts/ShippingRuntime/CarrierRatesResponse.cs old mode 100644 new mode 100755 index 0e0a0e89..9c4f82f5 --- a/Mozu.Api/Contracts/ShippingRuntime/CarrierRatesResponse.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/CarrierRatesResponse.cs @@ -19,19 +19,10 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class CarrierRatesResponse { - /// - ///Unique identifier of the shipping carrier. - /// public string CarrierId { get; set; } - /// - ///Collection of carrier-specific key-value attribute pairs associated with a shipping carrier. These are required to retrieve a shipping rate request and are returned for the generated shipping label. - /// public List CustomAttributes { get; set; } - /// - ///Array list of calculated shipping rates for the specified carrier. - /// public List ShippingRates { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/Category.cs b/Mozu.Api/Contracts/ShippingRuntime/Category.cs old mode 100644 new mode 100755 index b4ef6361..5fbdb3eb --- a/Mozu.Api/Contracts/ShippingRuntime/Category.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/Category.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.ShippingRuntime { - /// - /// A descriptive container that groups products. A category is merchant defined with associated products and discounts as configured. GThe storefront displays products in a hierarchy of categories. As such, categories can include a nesting of sub-categories to organize products and product options per set guidelines such as color, brand, material, and size. - /// public class Category { - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///If applicable, the parent category in the category tree. This can be associated to a product as the parent category. - /// public Category Parent { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/CustomAttribute.cs b/Mozu.Api/Contracts/ShippingRuntime/CustomAttribute.cs old mode 100644 new mode 100755 index a947a115..2641112d --- a/Mozu.Api/Contracts/ShippingRuntime/CustomAttribute.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/CustomAttribute.cs @@ -19,19 +19,10 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class CustomAttribute { - /// - ///Collection of child attributes associated with a shipping provider integration. - /// public List ChildAttributes { get; set; } - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/ItemMeasurements.cs b/Mozu.Api/Contracts/ShippingRuntime/ItemMeasurements.cs old mode 100644 new mode 100755 index e6d8217f..78158f20 --- a/Mozu.Api/Contracts/ShippingRuntime/ItemMeasurements.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/ItemMeasurements.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class ItemMeasurements { - /// - ///Girth of the package in imperial units of feet and inches. - /// public decimal? Girth { get; set; } - /// - ///Height of the package in imperial units of feet and inches. - /// public Measurement Height { get; set; } - /// - ///Length of the package in imperial units of feet and inches. - /// public Measurement Length { get; set; } - /// - ///Weight of the package in imperial units of pounds and ounces. - /// public Measurement Weight { get; set; } - /// - ///Width of the package in imperial units of feet and inches. - /// public Measurement Width { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/ProductOption.cs b/Mozu.Api/Contracts/ShippingRuntime/ProductOption.cs old mode 100644 new mode 100755 index ff78b505..f05dce85 --- a/Mozu.Api/Contracts/ShippingRuntime/ProductOption.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/ProductOption.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.ShippingRuntime { - /// - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. - /// public class ProductOption { - /// - ///The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name. - /// public string AttributeFQN { get; set; } - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public object Value { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/ProductProperty.cs b/Mozu.Api/Contracts/ShippingRuntime/ProductProperty.cs old mode 100644 new mode 100755 index 74c8d61d..5d8eca37 --- a/Mozu.Api/Contracts/ShippingRuntime/ProductProperty.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/ProductProperty.cs @@ -14,24 +14,12 @@ namespace Mozu.Api.Contracts.ShippingRuntime { - /// - /// Details of a property defined for a product. - /// public class ProductProperty { - /// - ///The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name. - /// public string AttributeFQN { get; set; } - /// - ///The data type of the source product property, typically of type Bool, DateTime, Number, or String. - /// public string DataType { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/ProductSummary.cs b/Mozu.Api/Contracts/ShippingRuntime/ProductSummary.cs old mode 100644 new mode 100755 index 138ef0c4..c9676d95 --- a/Mozu.Api/Contracts/ShippingRuntime/ProductSummary.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/ProductSummary.cs @@ -14,54 +14,24 @@ namespace Mozu.Api.Contracts.ShippingRuntime { - /// - /// Properties of summary data for a product, including all data for name, code, categories, options, types, measurements, and more. - /// public class ProductSummary { - /// - ///The list of all categories associated with the product. These categories contain products, can have discounts associated, and define the grouping of products to display on the storefront. - /// public List Categories { get; set; } - /// - ///List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types. - /// public List Options { get; set; } - /// - ///Price (unit price * quantity) - /// public decimal Price { get; set; } - /// - ///The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// public string ProductCode { get; set; } - /// - ///Product name/description - /// public string ProductDescription { get; set; } - /// - ///A product type is like a product template. - /// public string ProductType { get; set; } - /// - ///Collection of property attributes defined for the object. Properties are associated to all objects within , including documents, products, and product types. - /// public List Properties { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int Quantity { get; set; } - /// - ///Product specific dimensions used for shipping, used by product summary and rate request items. The dimensions can differ between the two uses as a `RateRequestItem `package may contain one or more products. - /// public ItemMeasurements UnitMeasurements { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/RateRequest.cs b/Mozu.Api/Contracts/ShippingRuntime/RateRequest.cs old mode 100644 new mode 100755 index 3a5a10a2..dff92061 --- a/Mozu.Api/Contracts/ShippingRuntime/RateRequest.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/RateRequest.cs @@ -21,9 +21,6 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class RateRequest { - /// - ///Collection of attributes that may be paged list or a list, depending on the usage per object and API type. - /// public List Attributes { get; set; } /// @@ -32,63 +29,38 @@ public class RateRequest public List CarrierIds { get; set; } /// - ///Collection of carrier-specific key-value attribute pairs associated with a shipping carrier. These are required to retrieve a shipping rate request and are returned for the generated shipping label. + ///List of key-value pairs that represent custom attributes associated with the request. /// public List CustomAttributes { get; set; } - /// - ///Data included in the shipping rate information. - /// public JObject Data { get; set; } - /// - ///The physical address orders are sent to as a shipping destination. This address may contain multiple lines, city, state/province, country, and zip/postal code. The destination is used to calculate shipping costs. - /// public Address DestinationAddress { get; set; } /// - ///The estimated date and time the shipment will be shipped to the shopper. This calculation is based on product stock, availability, date of order entry, and location. + ///The date and time the shipment will be shipped to the shopper. /// public DateTime? EstimatedShipmentDate { get; set; } - /// - ///If true, the destination address associated with the shipping rate request is a commercial address. - /// + public string Id { get; set; } + public bool? IsDestinationAddressCommercial { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string IsoCurrencyCode { get; set; } - /// - ///A list of requested items. All returned data is provided in an items array.For a failed request, the returned response may be success with an empty item array. - /// public List Items { get; set; } - /// - ///The sub total of the order including all applicable discounts. - /// public decimal? OrderDiscountedSubTotal { get; set; } - /// - ///The total monetary amount of the order. This amount is used to calculate the shipping rate estimate. - /// public decimal? OrderTotal { get; set; } /// - ///The physical address from which the order or shipment will ship. + ///The physical address from which the shipment will ship. /// public Address OriginAddress { get; set; } - /// - ///The unique identifier of the order to which the shipping rate is related.You can use Arc.js in combination with this property to retrieve other properties of the related order. - /// public string RelatedOrderId { get; set; } - /// - ///The order number that the customer sees on the storefront when they place the order. - /// public int? RelatedOrderNumber { get; set; } /// diff --git a/Mozu.Api/Contracts/ShippingRuntime/RateRequestAttribute.cs b/Mozu.Api/Contracts/ShippingRuntime/RateRequestAttribute.cs old mode 100644 new mode 100755 index 99331bb2..f01e1930 --- a/Mozu.Api/Contracts/ShippingRuntime/RateRequestAttribute.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/RateRequestAttribute.cs @@ -14,24 +14,12 @@ namespace Mozu.Api.Contracts.ShippingRuntime { - /// - /// Mozu.ShippingRuntime.Contracts.RateRequestAttribute ApiType DOCUMENT_HERE - /// public class RateRequestAttribute { - /// - ///Unique identifier of the attribute definition. - /// public int? AttributeDefinitionId { get; set; } - /// - ///Fully qualified name of the attribute for the order or customer. - /// public string FullyQualifiedName { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/RateRequestGroup.cs b/Mozu.Api/Contracts/ShippingRuntime/RateRequestGroup.cs new file mode 100755 index 00000000..a8151cb3 --- /dev/null +++ b/Mozu.Api/Contracts/ShippingRuntime/RateRequestGroup.cs @@ -0,0 +1,25 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.ShippingRuntime +{ + public class RateRequestGroup + { + public string Id { get; set; } + + public List RateRequests { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/ShippingRuntime/RateRequestItem.cs b/Mozu.Api/Contracts/ShippingRuntime/RateRequestItem.cs old mode 100644 new mode 100755 index 48ae6983..f539a014 --- a/Mozu.Api/Contracts/ShippingRuntime/RateRequestItem.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/RateRequestItem.cs @@ -21,34 +21,16 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class RateRequestItem { - /// - ///Data unique to the shipping rate for the item. - /// public JObject Data { get; set; } - /// - ///Unique identifier of an item used to calculate or request a shipping rate. - /// public string ItemId { get; set; } - /// - ///If Product Summaries are populated, this information will be utilized in Product Rules (e.g. ProductCode eq "ABC" or (Weight.Unit eq "lbs" and Weight.Value ge 50) - /// public List ProductSummaries { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int? Quantity { get; set; } - /// - ///If true, this item must ship separately from other items in a shipment. - /// public bool? ShipsByItself { get; set; } - /// - ///Product specific dimensions used for shipping, used by product summary and rate request items. The dimensions can differ between the two uses as a `RateRequestItem `package may contain one or more products. - /// public ItemMeasurements UnitMeasurements { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/RatesResponse.cs b/Mozu.Api/Contracts/ShippingRuntime/RatesResponse.cs old mode 100644 new mode 100755 index 7e292089..85ee6d96 --- a/Mozu.Api/Contracts/ShippingRuntime/RatesResponse.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/RatesResponse.cs @@ -19,19 +19,12 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class RatesResponse { - /// - ///Arrayed list of calculated shipping rates for each assocuated carrier. - /// + public string Id { get; set; } + public List Rates { get; set; } - /// - ///Resolved Shipping Zone Code. This value can be null if the tenant/site does not have shipping zones defined or there are no matching shipping zones for the request (e.g. the only zone defined is "UNITED-STATES" and the destination address of the rate request is in Canada) - /// public string ResolvedShippingZoneCode { get; set; } - /// - ///A code denoting a zone for shipping rates. Zip and postal codes are associated to these zones, determining set rates and costs for shipping origin and destination points. - /// public List ShippingZoneCodes { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/RatesResponseGroup.cs b/Mozu.Api/Contracts/ShippingRuntime/RatesResponseGroup.cs new file mode 100755 index 00000000..9a3d1cda --- /dev/null +++ b/Mozu.Api/Contracts/ShippingRuntime/RatesResponseGroup.cs @@ -0,0 +1,27 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + + +namespace Mozu.Api.Contracts.ShippingRuntime +{ + public class RatesResponseGroup + { + public List ComponentRates { get; set; } + + public string Id { get; set; } + + public RatesResponse RatesResponse { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/ShippingRuntime/ShippingItemRate.cs b/Mozu.Api/Contracts/ShippingRuntime/ShippingItemRate.cs old mode 100644 new mode 100755 index 77695ac7..ad9e2029 --- a/Mozu.Api/Contracts/ShippingRuntime/ShippingItemRate.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/ShippingItemRate.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class ShippingItemRate { - /// - ///The calculated shipping amount for an item in a shipment. - /// public decimal? Amount { get; set; } - /// - ///Unique identifier of an item used to calculate or request a shipping rate. - /// public string ItemId { get; set; } - /// - ///The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations. - /// public int? Quantity { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/ShippingRate.cs b/Mozu.Api/Contracts/ShippingRuntime/ShippingRate.cs old mode 100644 new mode 100755 index 79eb00a0..484ada24 --- a/Mozu.Api/Contracts/ShippingRuntime/ShippingRate.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/ShippingRate.cs @@ -21,29 +21,14 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class ShippingRate { - /// - ///The total calculated shipping amount requested for the package or shipment. - /// public decimal? Amount { get; set; } - /// - ///The carrier-defined alphanumeric code associated with this shipping rate. - /// public string Code { get; set; } - /// - ///Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes. - /// public ShippingRateLocalizedContent Content { get; set; } - /// - ///Collection of carrier-specific key-value attribute pairs associated with a shipping carrier. These are required to retrieve a shipping rate request and are returned for the generated shipping label. - /// public List CustomAttributes { get; set; } - /// - ///Shipping rate data. - /// public JObject Data { get; set; } /// @@ -51,14 +36,8 @@ public class ShippingRate /// public int? DaysInTransit { get; set; } - /// - ///Array list of validation and status messages associated with shipping rates, orders, and product purchasable state. - /// public List Messages { get; set; } - /// - ///Properties of a calculated shipping rate for individual line items in a shipment. - /// public List ShippingItemRates { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/ShippingRateLocalizedContent.cs b/Mozu.Api/Contracts/ShippingRuntime/ShippingRateLocalizedContent.cs old mode 100644 new mode 100755 index 03c13a18..de8114ef --- a/Mozu.Api/Contracts/ShippingRuntime/ShippingRateLocalizedContent.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/ShippingRateLocalizedContent.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class ShippingRateLocalizedContent { - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } } diff --git a/Mozu.Api/Contracts/ShippingRuntime/ShippingRateValidationMessage.cs b/Mozu.Api/Contracts/ShippingRuntime/ShippingRateValidationMessage.cs old mode 100644 new mode 100755 index e3f393bf..90bc763a --- a/Mozu.Api/Contracts/ShippingRuntime/ShippingRateValidationMessage.cs +++ b/Mozu.Api/Contracts/ShippingRuntime/ShippingRateValidationMessage.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.ShippingRuntime /// public class ShippingRateValidationMessage { - /// - ///URL displayed with the shipping validation message that links to help information. - /// public string HelpLink { get; set; } - /// - ///The text of the change message, such as "This product is no longer available." System-supplied and read-only. - /// public string Message { get; set; } - /// - ///The severity level of validation failures for shipping rates and products. - /// public string Severity { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Application/Application.cs b/Mozu.Api/Contracts/SiteSettings/Application/Application.cs old mode 100644 new mode 100755 index 3ab99883..ce835bc7 --- a/Mozu.Api/Contracts/SiteSettings/Application/Application.cs +++ b/Mozu.Api/Contracts/SiteSettings/Application/Application.cs @@ -19,44 +19,23 @@ namespace Mozu.Api.Contracts.SiteSettings.Application /// public class Application { - /// - ///Unique identifier of an app available in your tenant or within Dev Center. This ID is unique across all apps installed, initialized, and enabled in the and those in development through the Dev Center Console. - /// public string AppId { get; set; } - /// - ///denotes the Application Key for the app. - /// public string AppKey { get; set; } - /// - ///List of capabilities installed in a tenant. - /// public List Capabilities { get; set; } - /// - ///Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists. - /// public bool? Enabled { get; set; } - /// - ///Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage. - /// public bool? Initialized { get; set; } /// - ///Indicates if the installed application is of type extension. An extension is an application that extends upon the infrastructure. Examples of extensions include Arc.js applications and applications that integrate third-party services. + ///If true, the application type is Extension. /// public bool? IsExtension { get; set; } - /// - ///Indicates if the installed application is a certified application. - /// public bool? IsExtensionCertified { get; set; } - /// - ///The URL defined for the application that represents the configuration website for the capability. This value is used by installed applications or the site. - /// public string UiConfigurationUrl { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Application/Capability.cs b/Mozu.Api/Contracts/SiteSettings/Application/Capability.cs old mode 100644 new mode 100755 index 8b1d1098..49238985 --- a/Mozu.Api/Contracts/SiteSettings/Application/Capability.cs +++ b/Mozu.Api/Contracts/SiteSettings/Application/Capability.cs @@ -26,17 +26,17 @@ public class Capability public List ActiveCreditTypes { get; set; } /// - ///Array list of the countries (by country code) to which this capability can actively ship. The entered shipping country is validated against a list of supported shipping countries. Messages return if the country code is not supported or duplicated. Supported carriers are also checked per country code. + ///Array list of the countries to which this capability can actively ship. /// public List ActiveShippingCountries { get; set; } /// - ///Array list of the countries (by country code) for which this capability can actively shop. All active shopping countries must be in the supported shopping country list. Validation rules determine the supported validity of the entered country against the list. + ///Array list of the countries for which this capability can actively shop. /// public List ActiveShoppingCountries { get; set; } /// - ///The enablement mode of the capability, typically read only. + ///The enablement mode of the capability. /// public string CapabilityMode { get; set; } @@ -46,17 +46,17 @@ public class Capability public string CapabilityType { get; set; } /// - ///Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists. + ///If true, the capability is enabled in the installed tenant. /// public bool? Enabled { get; set; } /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: + ///Unique identifier of the capability. /// public string Id { get; set; } /// - ///Indicates if an app is initialized and capable of being enabled in the tenant and site. Apps will need to be installed and configured to become initialized, such as validating credentials and/or API keys with a third-party service. If true, the app is initialized and can be enabled for usage. + ///If true, the application is initialized with the defined settings. /// public bool? Initialized { get; set; } @@ -66,17 +66,17 @@ public class Capability public List OperationUrls { get; set; } /// - ///The unique identifier of the scope. For example, if your scope type is site, then this value would be the site id. + ///Unique identifier of the developer account or tenant associated for which the capability is entitled. /// public int? ScopeId { get; set; } /// - ///The type of scope associated with the documentList. For example, if the documentList is pageTemplateContent, the scopeType is Site.Valid values are: "Tenant", "MasterCatalog", and "Site". + ///The type of scope for which the tenant is entitled, which is developer or tenant. /// public string ScopeType { get; set; } /// - ///List of credit types this capability supports. + ///Array list of credit types this capability supports. /// public List SupportedCreditTypes { get; set; } @@ -86,7 +86,7 @@ public class Capability public List SupportedShippingCountries { get; set; } /// - ///List of countries this capability supports for shopping. + ///Array list of countries this capability supports for shopping. /// public List SupportedShoppingCountries { get; set; } diff --git a/Mozu.Api/Contracts/SiteSettings/General/CacheSettings.cs b/Mozu.Api/Contracts/SiteSettings/General/CacheSettings.cs old mode 100644 new mode 100755 index c09cf52b..98a82053 --- a/Mozu.Api/Contracts/SiteSettings/General/CacheSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/CacheSettings.cs @@ -13,14 +13,8 @@ namespace Mozu.Api.Contracts.SiteSettings.General { - /// - /// Settings related to the CDN cache. - /// public class CacheSettings { - /// - ///A random string value appended to the URLs of CDN content. When a user clicks the Bust Cache button in , the random number in the URL forces the cache to point to the latest version of the CDN content. - /// public string CdnCacheBustKey { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/General/EmailTransactionSettings.cs b/Mozu.Api/Contracts/SiteSettings/General/EmailTransactionSettings.cs old mode 100644 new mode 100755 index 9327e633..9aea803c --- a/Mozu.Api/Contracts/SiteSettings/General/EmailTransactionSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/EmailTransactionSettings.cs @@ -13,89 +13,38 @@ namespace Mozu.Api.Contracts.SiteSettings.General { - /// - /// Mozu.SiteSettings.General.Contracts.EmailTransactionSettings ApiType DOCUMENT_HERE - /// public class EmailTransactionSettings { - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? BackInStock { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? GiftCardCreated { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? OrderChanged { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? OrderFulfillmentDetailsChanged { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? OrderShipped { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? RefundCreated { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? ReturnAuthorized { get; set; } - /// - ///There is no corresponding template for this in the Core theme. - /// public bool? ReturnCancelled { get; set; } - /// - ///This controls "email/product-return-received" in the Core theme. - /// public bool? ReturnClosed { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? ReturnCreated { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? ReturnRejected { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? ReturnUpdated { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? ShopperLoginCreated { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? ShopperPasswordReset { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? StoreCreditCreated { get; set; } - /// - ///A flag that determines if an email is sent to a shopper account when the described condition is met. - /// public bool? StoreCreditUpdated { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/General/EmailTypeSetting.cs b/Mozu.Api/Contracts/SiteSettings/General/EmailTypeSetting.cs old mode 100644 new mode 100755 index 9e8d1014..a8e6b519 --- a/Mozu.Api/Contracts/SiteSettings/General/EmailTypeSetting.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/EmailTypeSetting.cs @@ -13,34 +13,16 @@ namespace Mozu.Api.Contracts.SiteSettings.General { - /// - /// Mozu.SiteSettings.General.Contracts.EmailTypeSetting ApiType DOCUMENT_HERE - /// public class EmailTypeSetting { - /// - ///Overwrites the Bcc email address for the given template. - /// public string BccEmailAddressOverride { get; set; } - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public string Id { get; set; } - /// - ///Overwrites the Reply-to email address for the given template. - /// public string ReplyToEmailAddressOverride { get; set; } - /// - ///Overwrites the Sender email address for the given template. - /// public string SenderEmailAddressOverride { get; set; } - /// - ///Overwrites the Sender email alias for the given template. - /// public string SenderEmailAliasOverride { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/General/General/Routing/CustomRouteSettings.cs b/Mozu.Api/Contracts/SiteSettings/General/General/Routing/CustomRouteSettings.cs old mode 100644 new mode 100755 index 285410c1..5bef7cc7 --- a/Mozu.Api/Contracts/SiteSettings/General/General/Routing/CustomRouteSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/General/Routing/CustomRouteSettings.cs @@ -14,24 +14,12 @@ namespace Mozu.Api.Contracts.SiteSettings.General.General.Routing { - /// - /// Mozu.SiteSettings.General.Contracts.General.Routing.CustomRouteSettings ApiType DOCUMENT_HERE - /// public class CustomRouteSettings { - /// - ///The mappings configured for the site. Mappings allow you to map the values of URL parameters to other JSON variables or to objects such as facet values. - /// public Dictionary Mappings { get; set; } - /// - ///The routes configured for the site. Routes contain all the information necessary to match incoming URLs to a specific page in . - /// public List Routes { get; set; } - /// - ///The validators configured for a site. Validators require that URL parameters meet certain conditions before considers the template a match. - /// public Dictionary Validators { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Mapping.cs b/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Mapping.cs old mode 100644 new mode 100755 index 2d8d3f28..27553b4a --- a/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Mapping.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Mapping.cs @@ -14,54 +14,24 @@ namespace Mozu.Api.Contracts.SiteSettings.General.General.Routing { - /// - /// Mozu.SiteSettings.General.Contracts.General.Routing.Mapping ApiType DOCUMENT_HERE - /// public class Mapping { - /// - ///beforeRouting ApiType DOCUMENT_HERE - /// public bool? BeforeRouting { get; set; } - /// - ///docId ApiType DOCUMENT_HERE - /// public string DocId { get; set; } - /// - ///facetId ApiType DOCUMENT_HERE - /// public string FacetId { get; set; } - /// - ///The fully qualified name of the document list. - /// public string ListFqn { get; set; } - /// - ///mappings ApiType DOCUMENT_HERE - /// public Dictionary Mappings { get; set; } - /// - ///mapTo ApiType DOCUMENT_HERE - /// public string MapTo { get; set; } - /// - ///pattern ApiType DOCUMENT_HERE - /// public string Pattern { get; set; } - /// - ///replacement ApiType DOCUMENT_HERE - /// public string Replacement { get; set; } - /// - ///type ApiType DOCUMENT_HERE - /// public string Type { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Route.cs b/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Route.cs old mode 100644 new mode 100755 index 159d7e62..08906c23 --- a/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Route.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Route.cs @@ -14,49 +14,22 @@ namespace Mozu.Api.Contracts.SiteSettings.General.General.Routing { - /// - /// Mozu.SiteSettings.General.Contracts.General.Routing.Route ApiType DOCUMENT_HERE - /// public class Route { - /// - ///When true, specifies that the route is a canonical route. - /// public bool? Canonical { get; set; } - /// - ///An array of key-value pairs that provide default values for required route parameters. - /// public Dictionary Defaults { get; set; } - /// - ///For Arc.js routes, specifies the Arc.js function name to create a route to. For example: - /// public string FunctionId { get; set; } - /// - ///Specifies the internal route to use for a particular URL template. For example, the "ProductDetails" internal route routes matching URLs to a product page. - /// public string InternalRoute { get; set; } - /// - ///The list of mappings that a particular route uses. - /// public Dictionary Mappings { get; set; } - /// - ///Specifies the pattern of URL constants, variables, and segments that result in a match for a particular route. - /// public string Template { get; set; } - /// - ///Specifies whether a custom route uses an or protocol. This allows you to set encryption on a route generated from a non-secure request, or vice-versa. - /// public string UrlScheme { get; set; } - /// - ///Specifies the validators that a particular route uses. - /// public Dictionary Validators { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Validator.cs b/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Validator.cs old mode 100644 new mode 100755 index 27dfd5f4..cf0c2feb --- a/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Validator.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/General/Routing/Validator.cs @@ -14,44 +14,20 @@ namespace Mozu.Api.Contracts.SiteSettings.General.General.Routing { - /// - /// Mozu.SiteSettings.General.Contracts.General.Routing.Validator ApiType DOCUMENT_HERE - /// public class Validator { - /// - ///The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name. - /// public string AttributeFQN { get; set; } - /// - ///docId ApiType DOCUMENT_HERE - /// public string DocId { get; set; } - /// - ///field ApiType DOCUMENT_HERE - /// public string Field { get; set; } - /// - ///The fully qualified name of the document list. - /// public string ListFqn { get; set; } - /// - ///pattern ApiType DOCUMENT_HERE - /// public string Pattern { get; set; } - /// - ///type ApiType DOCUMENT_HERE - /// public string Type { get; set; } - /// - ///List of value data for objects. - /// public List Values { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/General/General/ViewAuthorizations.cs b/Mozu.Api/Contracts/SiteSettings/General/General/ViewAuthorizations.cs old mode 100644 new mode 100755 index 25b4185c..7a9d3311 --- a/Mozu.Api/Contracts/SiteSettings/General/General/ViewAuthorizations.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/General/ViewAuthorizations.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.SiteSettings.General.General { - /// - /// Set whether you require users to be authenticated to preview content or view the live site. - /// public class ViewAuthorizations { - /// - ///Specifies whether to enable secure communication across your entire site, using the SSL (Secure Socket Layer) security protocol. Every page on your site will display as an HTTPS page and contain an SSL certificate. - /// public bool? EnforceSitewideSSL { get; set; } - /// - ///Require log in to view live storefront site. - /// public bool RequireAuthForLive { get; set; } - /// - ///Require log in to view pending storefront site. - /// public bool RequireAuthForPending { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/General/GeneralSettings.cs b/Mozu.Api/Contracts/SiteSettings/General/GeneralSettings.cs old mode 100644 new mode 100755 index d00dc932..9c6ff9d4 --- a/Mozu.Api/Contracts/SiteSettings/General/GeneralSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/GeneralSettings.cs @@ -22,134 +22,58 @@ namespace Mozu.Api.Contracts.SiteSettings.General /// public class GeneralSettings { - /// - ///If true, the site allows entry of addresses not verified by an address validation service. - /// public bool? AllowInvalidAddresses { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///An email address to blind carbon copy anytime an automatic email is sent from to a shopper. - /// public string BccEmailAddress { get; set; } - /// - ///Set of settings to deal with site caching. - /// public CacheSettings CacheSettings { get; set; } - /// - ///Custom override of the default subdomain for CDN-hosted content. For example, for SEO reasons you may prefer that the subdomain for your CDN content be instead of the default subdomain, which might be something like . - /// public string CustomCdnHostName { get; set; } - /// - ///Site-level settings for custom routing, which allows you to use your own custom URL patterns for common pages. - /// public CustomRouteSettings CustomRoutes { get; set; } - /// - ///Set this property to to disable automatically sending order confirmation emails after an order is submitted. If you enable this property, order confirmation emails are triggered only by the API operation or a Resend Order Confirmation Email event (which can be triggered by an user). - /// public EmailTransactionSettings EmailTransactionsOnlyOnRequest { get; set; } - /// - ///A collection of overrides that allow you to apply unique email settings to the email template(s) of your choice. - /// public List EmailTypes { get; set; } - /// - ///The physical directory path or URL where the mobile favicon image file is stored. The favicon icon is generally 57x57 pixels. The icon appears on a mobile website or on the mobile device's OS Home. - /// public string FavIconMobilePath { get; set; } - /// - ///The physical directory path or URL where the mobile favicon image file is stored. The favicon icon is generally 16x16 pixels. The icon appears on a a browser tab as the website's mini logo or on a browser address bar, or next to the page name in a list of bookmarks. - /// public string FavIconPath { get; set; } - /// - ///The Google Analytics code associated with a particular store. This could be the web tracking code. - /// public string GoogleAnalyticsCode { get; set; } - /// - ///If true, a service to verify addresses as valid is enabled for the site. - /// public bool? IsAddressValidationEnabled { get; set; } - /// - ///If true, the Google analytics for eCommerce is enabled for this site. If false, the analytics are not enabled. - /// public bool? IsGoogleAnalyticsEcommerceEnabled { get; set; } - /// - ///If true, enable Google analytics for this site. If false, analytics are not enabled. - /// public bool? IsGoogleAnalyticsEnabled { get; set; } - /// - ///If true, this site represents a -hosted web storefront. - /// public bool IsMozuWebSite { get; set; } - /// - ///If true, shoppers on this site can create customer wish lists. - /// + public bool? IsMultishipEnabled { get; set; } + public bool? IsWishlistCreationEnabled { get; set; } - /// - ///The physical directory path or URL where the website logo is stored. - /// public string LogoPath { get; set; } - /// - ///The tagline or text that appears when hovering over the site logo. - /// public string LogoText { get; set; } - /// - ///Assigns an image to render in place of broken images and unspecified product images (and unspecified category images, if your theme developer has enabled category images). Specified by the name or ID of the CMS image within . - /// public string MissingImageSubstitute { get; set; } - /// - ///The name of the theme to use when viewing this website on a mobile device. - /// public string MobileTheme { get; set; } - /// - ///The email shoppers should use to reply to an automatically-generated email. - /// public string ReplyToEmailAddress { get; set; } - /// - ///Email address to set up so that shoppers and users browsing the site can use to contact the merchant. - /// public string SenderEmailAddress { get; set; } - /// - ///An alternate name for the sender email. For example, if your sender email is , you might want to use an alias of . - /// public string SenderEmailAlias { get; set; } - /// - ///Choose a format to use on the site: 12-hour (hh:mm:ss tt) or 24-hour format (HH:mm:ss). - /// public string SiteTimeFormat { get; set; } - /// - ///Choose the time zone to use for the site. - /// public string SiteTimeZone { get; set; } - /// - ///Supressed emails. Setting any of these to 'true' will block from sending that email and an event will be published instead. - /// public EmailTransactionSettings SupressedEmailTransactions { get; set; } /// @@ -157,29 +81,14 @@ public class GeneralSettings /// public string TabletTheme { get; set; } - /// - ///The territories configured for the site that are subject to sales tax. - /// public List TaxableTerritories { get; set; } - /// - ///Unique identifier of the tenant site that site uses to render content for the shopper. For example, if this site represents a third-party sales channel such as Amazon but the company wants to send shopper emails, this value represents the -hosted web storefront site that maintains this content. - /// public int? TemplateSiteId { get; set; } - /// - ///The name of the theme used on the storefront. - /// public string Theme { get; set; } - /// - ///A collection of authorizations that control access to viewing the pending and live sites. - /// public ViewAuthorizations ViewAuthorizations { get; set; } - /// - ///The name of the website to display on the storefront with no spaces. - /// public string WebsiteName { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/General/TaxableTerritory.cs b/Mozu.Api/Contracts/SiteSettings/General/TaxableTerritory.cs old mode 100644 new mode 100755 index 45480e37..2aecf506 --- a/Mozu.Api/Contracts/SiteSettings/General/TaxableTerritory.cs +++ b/Mozu.Api/Contracts/SiteSettings/General/TaxableTerritory.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.SiteSettings.General /// public class TaxableTerritory { - /// - ///The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// public string CountryCode { get; set; } - /// - ///If true, all shipping charges for this territory are subject to sales tax. - /// public bool? IsShippingTaxable { get; set; } - /// - ///The two-letter geographic code representing the state for the physical or mailing address. This is currently limited to the US. - /// public string StateOrProvinceCode { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/CartSettings.cs b/Mozu.Api/Contracts/SiteSettings/Order/CartSettings.cs old mode 100644 new mode 100755 index b6ff37b6..195b4a39 --- a/Mozu.Api/Contracts/SiteSettings/Order/CartSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/CartSettings.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.SiteSettings.Order { - /// - /// Mozu.SiteSettings.Order.Contracts.CartSettings ApiType DOCUMENT_HERE - /// public class CartSettings { - /// - ///Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Set this property to if you want to include handling fees in the calculation of the cart cost. - /// public bool EnableHandlingFee { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/CheckoutSettings.cs b/Mozu.Api/Contracts/SiteSettings/Order/CheckoutSettings.cs old mode 100644 new mode 100755 index 18b1386b..5ae9a1db --- a/Mozu.Api/Contracts/SiteSettings/Order/CheckoutSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/CheckoutSettings.cs @@ -18,19 +18,10 @@ namespace Mozu.Api.Contracts.SiteSettings.Order /// public class CheckoutSettings { - /// - ///Settings for the checkout login. Choose whether or not shoppers must first login before a purchase can be processed. Choose the option for guests to purchase without logging in, prompt guests to login, or require them to login before a purchase can be completed. - /// public CustomerCheckoutSettings CustomerCheckoutSettings { get; set; } - /// - ///Credit card payment authorization setting defined for the site for order processing. - /// public OrderProcessingSettings OrderProcessingSettings { get; set; } - /// - ///Payment gateway settings defined for the site. A payment gateway is an eCommerce application service provider that authorizes payments for eBusinesses, online retailers, and other stores that have an online commerce component. - /// public PaymentSettings PaymentSettings { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/CustomerCheckoutSettings.cs b/Mozu.Api/Contracts/SiteSettings/Order/CustomerCheckoutSettings.cs old mode 100644 new mode 100755 index 5e8092b1..ae43b77f --- a/Mozu.Api/Contracts/SiteSettings/Order/CustomerCheckoutSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/CustomerCheckoutSettings.cs @@ -19,14 +19,8 @@ namespace Mozu.Api.Contracts.SiteSettings.Order /// public class CustomerCheckoutSettings { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The type of customer checking out in the order such as a guest who has not logged in or a customer who has logged in. Valid strings are either "LoginOptional," where shoppers are prompted to sign in but are not required to do so, or "LoginRequired," where shopppers must login before purchasing. - /// public string CustomerCheckoutType { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/ExternalPaymentWorkflowDefinition.cs b/Mozu.Api/Contracts/SiteSettings/Order/ExternalPaymentWorkflowDefinition.cs old mode 100644 new mode 100755 index 25457da5..835652b5 --- a/Mozu.Api/Contracts/SiteSettings/Order/ExternalPaymentWorkflowDefinition.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/ExternalPaymentWorkflowDefinition.cs @@ -19,34 +19,16 @@ namespace Mozu.Api.Contracts.SiteSettings.Order /// public class ExternalPaymentWorkflowDefinition { - /// - ///The credential fields required to communicate with the external payment processor. - /// public List Credentials { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///Fully qualified name of the attribute for the order or customer. - /// public string FullyQualifiedName { get; set; } - /// - ///Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order. - /// public bool IsEnabled { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The namespace for the accessible APIs and source capabilities in the core of APIs. - /// public string Namespace { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/Gateway.cs b/Mozu.Api/Contracts/SiteSettings/Order/Gateway.cs old mode 100644 new mode 100755 index c8501441..e972364c --- a/Mozu.Api/Contracts/SiteSettings/Order/Gateway.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/Gateway.cs @@ -20,24 +20,12 @@ namespace Mozu.Api.Contracts.SiteSettings.Order /// public class Gateway { - /// - ///If true, the credential fields for the gateway are configured with valid values. For security purposes, does not return the credential fields for the gateway subresource. - /// public bool AreGatewayCredentialFieldsSet { get; set; } - /// - ///Account information associated with the specified payment gateway. - /// public GatewayAccount GatewayAccount { get; set; } - /// - ///Properties of the payment gateway definition. - /// public GatewayDefinition GatewayDefinition { get; set; } - /// - ///The types of credit cards supported by the payment gateway. - /// public List SupportedCards { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/LocalizedContent.cs b/Mozu.Api/Contracts/SiteSettings/Order/LocalizedContent.cs old mode 100644 new mode 100755 index 4a544b2e..1c4e2fe9 --- a/Mozu.Api/Contracts/SiteSettings/Order/LocalizedContent.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/LocalizedContent.cs @@ -13,19 +13,10 @@ namespace Mozu.Api.Contracts.SiteSettings.Order { - /// - /// The localized content associated with the object. - /// public class LocalizedContent { - /// - ///The two character locale code, per the country code provided. This code determines the localized content to use and display. - /// public string LocaleCode { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/OrderProcessingSettings.cs b/Mozu.Api/Contracts/SiteSettings/Order/OrderProcessingSettings.cs old mode 100644 new mode 100755 index 99d9d63a..a2d0d21d --- a/Mozu.Api/Contracts/SiteSettings/Order/OrderProcessingSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/OrderProcessingSettings.cs @@ -24,19 +24,10 @@ public class OrderProcessingSettings /// public int? AbandonedOrderThresholdInMinutes { get; set; } - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///Determines whether payment authorization occurs when the order is placed or when the order is shipped. - /// public string PaymentProcessingFlowType { get; set; } - /// - ///If true, use the override price defined for products in the order to calculate discounts for the order. - /// public bool UseOverridePriceToCalculateDiscounts { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/PaymentSettings.cs b/Mozu.Api/Contracts/SiteSettings/Order/PaymentSettings.cs old mode 100644 new mode 100755 index 711879b1..71fea0d5 --- a/Mozu.Api/Contracts/SiteSettings/Order/PaymentSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/PaymentSettings.cs @@ -20,29 +20,14 @@ namespace Mozu.Api.Contracts.SiteSettings.Order /// public class PaymentSettings { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The external payment workflwo definitions configured for the site's payment settings. At this time, only PayPal Express is supported. - /// public List ExternalPaymentWorkflowDefinitions { get; set; } - /// - ///List of name and account information for a payment gateway. - /// public List Gateways { get; set; } - /// - ///Settings that provide for the ability to pay for an order by mail. - /// public bool PayByMail { get; set; } - /// - ///The purchase order payment type settings associated with a site.Refer to [Enable the Purchase Order Payment Type](https://www.mozu.com/docs/guides/orders/purchase-order.htm#enable_the_purchase_order_payment_type) in the Purchase Orders guides topic for more information. - /// public PurchaseOrderPaymentDefinition PurchaseOrder { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderCustomField.cs b/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderCustomField.cs old mode 100644 new mode 100755 index 8b8a8820..faedb0c6 --- a/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderCustomField.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderCustomField.cs @@ -13,34 +13,16 @@ namespace Mozu.Api.Contracts.SiteSettings.Order { - /// - /// The details of the custom fields associated with the purchase order payment.Refer to [Custom Text Fields](https://www.mozu.com/docs/guides/orders/purchase-order.htm#custom_text_fields) in the Purchase Orders guides topic for more information. - /// public class PurchaseOrderCustomField { - /// - ///The unique code of the custom field associated with the purchase order payment type.Refer to [Custom Text Fields](https://www.mozu.com/docs/guides/orders/purchase-order.htm#custom_text_fields) in the Purchase Orders guides topic for more information. - /// public string Code { get; set; } - /// - ///Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order. - /// public bool IsEnabled { get; set; } - /// - ///Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value. - /// public bool IsRequired { get; set; } - /// - ///Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. - /// public string Label { get; set; } - /// - ///The order/sequence position in which displays the custom field. - /// public int SequenceNumber { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderPaymentDefinition.cs b/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderPaymentDefinition.cs old mode 100644 new mode 100755 index 4cab83b5..dda93db4 --- a/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderPaymentDefinition.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderPaymentDefinition.cs @@ -14,29 +14,14 @@ namespace Mozu.Api.Contracts.SiteSettings.Order { - /// - /// The details of the purchase order payment. - /// public class PurchaseOrderPaymentDefinition { - /// - ///Specifies whether another payment can be used with the purchase order. - /// public bool AllowSplitPayment { get; set; } - /// - ///The details of the custom fields associated with the purchase order payment type for the specific site.You can create custom text fields that customers or CSRs can fill out when they use the purchase order payment method before submitting the order.Refer to [Custom Text Fields](https://www.mozu.com/docs/guides/orders/purchase-order.htm#custom_text_fields) in the Purchase Orders guides topic for more information. - /// public List CustomFields { get; set; } - /// - ///Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order. - /// public bool IsEnabled { get; set; } - /// - ///The complete set of payment terms details for which all your customers are possibly applicable on that specific site.Refer to [Payment Terms](https://www.mozu.com/docs/guides/orders/purchase-order.htm#payment_terms) in the Purchase Orders guides topic for more information. - /// public List PaymentTerms { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderPaymentTerm.cs b/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderPaymentTerm.cs old mode 100644 new mode 100755 index 9916f2ed..d04a4eb8 --- a/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderPaymentTerm.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/PurchaseOrderPaymentTerm.cs @@ -13,24 +13,12 @@ namespace Mozu.Api.Contracts.SiteSettings.Order { - /// - /// The details of the payment terms assocaited with the purchase order payment.Refer to [Payment Terms](https://www.mozu.com/docs/guides/orders/purchase-order.htm#payment_terms) in the Purchase Orders guides topic for more information. - /// public class PurchaseOrderPaymentTerm { - /// - ///The unique code for the payment term associated with the purchase order payment type.Refer to [Payment Terms](https://www.mozu.com/docs/guides/orders/purchase-order.htm#payment_terms) in the Purchase Orders guides topic for more information. - /// public string Code { get; set; } - /// - ///The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. - /// public string Description { get; set; } - /// - ///The order/sequence position in which displays the payment term. - /// public int SequenceNumber { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/ThirdPartyCredentialField.cs b/Mozu.Api/Contracts/SiteSettings/Order/ThirdPartyCredentialField.cs old mode 100644 new mode 100755 index 89a6921b..d391c0ce --- a/Mozu.Api/Contracts/SiteSettings/Order/ThirdPartyCredentialField.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/ThirdPartyCredentialField.cs @@ -19,34 +19,16 @@ namespace Mozu.Api.Contracts.SiteSettings.Order /// public class ThirdPartyCredentialField { - /// - ///System-supplied API name required to communicate with the external payment processor. - /// public string ApiName { get; set; } - /// - ///The name that displays for the payment gateway or third-party credentials field. - /// public string DisplayName { get; set; } - /// - ///The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea. - /// public string InputType { get; set; } - /// - ///A flag to determine if the field holds sensitive information. - /// public bool? IsSensitive { get; set; } - /// - ///The value of a property, used by numerous objects within including facets, attributes, products, localized content, metadata, capabilities ( and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. - /// public string Value { get; set; } - /// - ///List of valid vocabulary values defined for an attribute. - /// public List VocabularyValues { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Order/VocabularyValue.cs b/Mozu.Api/Contracts/SiteSettings/Order/VocabularyValue.cs old mode 100644 new mode 100755 index 1b19b2a5..78231f32 --- a/Mozu.Api/Contracts/SiteSettings/Order/VocabularyValue.cs +++ b/Mozu.Api/Contracts/SiteSettings/Order/VocabularyValue.cs @@ -14,19 +14,10 @@ namespace Mozu.Api.Contracts.SiteSettings.Order { - /// - /// Mozu.SiteSettings.Order.Contracts.VocabularyValue ApiType DOCUMENT_HERE - /// public class VocabularyValue { - /// - ///Contents of the vocabulary values that have been defined for an attribute. - /// public List Contents { get; set; } - /// - ///Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.For search synonym definitions, refer to [Synonym Expansion Types](https://www.mozu.com/docs/Developer/api-guides/search-settings.htm#synonym_expansion_types) for more information about the key usage. - /// public string Key { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingHandlingFee.cs b/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingHandlingFee.cs old mode 100644 new mode 100755 index c051912f..c09bfb7d --- a/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingHandlingFee.cs +++ b/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingHandlingFee.cs @@ -18,9 +18,6 @@ namespace Mozu.Api.Contracts.SiteSettings.Shipping /// public class SiteShippingHandlingFee { - /// - ///The amount of the order handling fee. - /// public decimal? Amount { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingSettings.cs b/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingSettings.cs old mode 100644 new mode 100755 index 4f2144a4..1e576933 --- a/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingSettings.cs +++ b/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingSettings.cs @@ -19,19 +19,10 @@ namespace Mozu.Api.Contracts.SiteSettings.Shipping /// public class SiteShippingSettings { - /// - ///Identifier and datetime stamp information recorded when a user or application creates, updates, or deletes a resource entity. This value is system-supplied and read-only. - /// public AuditInfo AuditInfo { get; set; } - /// - ///The combined price for all items in the order, including all selected options but excluding any discounts. - /// public SiteShippingHandlingFee OrderHandlingFee { get; set; } - /// - ///Properties of the package signature requirements for the site. - /// public SiteShippingSignatureRequirement SignatureRequirement { get; set; } } diff --git a/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingSignatureRequirement.cs b/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingSignatureRequirement.cs old mode 100644 new mode 100755 index e13b5dcd..fe48c1f3 --- a/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingSignatureRequirement.cs +++ b/Mozu.Api/Contracts/SiteSettings/Shipping/SiteShippingSignatureRequirement.cs @@ -18,14 +18,8 @@ namespace Mozu.Api.Contracts.SiteSettings.Shipping /// public class SiteShippingSignatureRequirement { - /// - ///If true, this site requires signatures on shipments for orders that exceed the minimum value threshold. - /// public bool? IsSignatureRequired { get; set; } - /// - ///The minimum order amount that requires a signature on shipments. For example, if you want to require customer signatures on all orders over $5,000, the MinimumValueThreshold would be 5001. - /// public decimal? MinimumValueThreshold { get; set; } } diff --git a/Mozu.Api/Contracts/Tenant/Catalog.cs b/Mozu.Api/Contracts/Tenant/Catalog.cs old mode 100644 new mode 100755 index 57e84824..be79267f --- a/Mozu.Api/Contracts/Tenant/Catalog.cs +++ b/Mozu.Api/Contracts/Tenant/Catalog.cs @@ -14,65 +14,22 @@ namespace Mozu.Api.Contracts.Tenant { /// - /// Properties of an individual product catalog. + /// Properties of a product catalog associated with a tenant. /// public class Catalog { - /// - ///The date and time in UTC format set when the object was created. - /// - public DateTime CreateDate { get; set; } - - /// - ///The default three-letter ISO currency code for monetary amounts. Currently, only "USD" is supported for U.S. Dollar. - /// public string DefaultCurrencyCode { get; set; } - /// - ///The two-letter default locale code for setting the localized text content. Currently, only "en-US" is supported for U.S. English. - /// public string DefaultLocaleCode { get; set; } - /// - ///The date and time the object was deleted. - /// - public DateTime DeleteDate { get; set; } - - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///Indicates if the object is deleted. If true, the object has been deleted. This may affect associated child members and objects. For example, a deleted master catalog affects all associated catalogs. - /// - public bool IsDeleted { get; set; } - - /// - ///Unique identifier for the master catalog. - /// public int MasterCatalogId { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// - public string Status { get; set; } - - /// - ///Unique identifier of the Mozu tenant. - /// public int TenantId { get; set; } - /// - ///The date and time in UTC format the object was updated most recently. - /// - public DateTime UpdateDate { get; set; } - } } \ No newline at end of file diff --git a/Mozu.Api/Contracts/Tenant/MasterCatalog.cs b/Mozu.Api/Contracts/Tenant/MasterCatalog.cs old mode 100644 new mode 100755 index fde583b7..2e61bcba --- a/Mozu.Api/Contracts/Tenant/MasterCatalog.cs +++ b/Mozu.Api/Contracts/Tenant/MasterCatalog.cs @@ -15,65 +15,22 @@ namespace Mozu.Api.Contracts.Tenant { /// - /// Properties of a master product catalog defined for a tenant. All catalogs and sites associated with a master catalog share product definitions. + /// Properties of a master catalog defined for a tenant. All catalogs associated with a master catalog share product definitions. /// public class MasterCatalog { - /// - ///Collection of product catalogs that use product definitions from the master catalog. - /// public List Catalogs { get; set; } - /// - ///The date and time in UTC format set when the object was created. - /// - public DateTime CreateDate { get; set; } - - /// - ///The default three-letter ISO currency code for monetary amounts. Currently, only "USD" is supported for U.S. Dollar. - /// public string DefaultCurrencyCode { get; set; } - /// - ///The two-letter default locale code for setting the localized text content. Currently, only "en-US" is supported for U.S. English. - /// public string DefaultLocaleCode { get; set; } - /// - ///The date and time the object was deleted. - /// - public DateTime DeleteDate { get; set; } - - /// - ///Unique identifier of the source property, such as a catalog, discount, order, or email template.For a product field it will be the name of the field.For a category ID, must be a positive integer not greater than 2000000. By default, auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the query string in the endpoint. For example, . Then, use the property to specify the desired category ID.For a product attribute it will be the Attribute FQN.For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, or.For email templates, the ID must be one of the following values: - /// public int Id { get; set; } - /// - ///Indicates if the object is deleted. If true, the object has been deleted. This may affect associated child members and objects. For example, a deleted master catalog affects all associated catalogs. - /// - public bool IsDeleted { get; set; } - - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The current status of the object.This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". - /// - public string Status { get; set; } - - /// - ///Unique identifier of the Mozu tenant. - /// public int TenantId { get; set; } - /// - ///The date and time in UTC format the object was updated most recently. - /// - public DateTime UpdateDate { get; set; } - } } \ No newline at end of file diff --git a/Mozu.Api/Contracts/Tenant/Site.cs b/Mozu.Api/Contracts/Tenant/Site.cs old mode 100644 new mode 100755 index de4bad19..4a29913a --- a/Mozu.Api/Contracts/Tenant/Site.cs +++ b/Mozu.Api/Contracts/Tenant/Site.cs @@ -9,6 +9,7 @@ //------------------------------------------------------------------------------ using System; +using System.Collections.Generic; namespace Mozu.Api.Contracts.Tenant @@ -18,43 +19,24 @@ namespace Mozu.Api.Contracts.Tenant /// public class Site { - /// - ///The unique identifier of the catalog of products used by a site. - /// + public List Attributes { get; set; } + public int CatalogId { get; set; } public string CountryCode { get; set; } - /// - ///3-letter ISO 4217 standard global currency code. Currently, only "USD" (US Dollar) is supported. - /// public string CurrencyCode { get; set; } - /// - ///Properties of the domain that the tenant is associated with such as the domain name, the zone string, audit information (system-supplied and read-only), assignment data, and whether or not the domain is primary or requires a SSL for authentication. - /// public string Domain { get; set; } public int Id { get; set; } - /// - ///Language used for the entity. Currently, only "en-US" is supported. - /// public string LocaleCode { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///The primary custom domain of the site. - /// public string PrimaryCustomDomain { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int TenantId { get; set; } } diff --git a/Mozu.Api/Contracts/Tenant/Tenant.cs b/Mozu.Api/Contracts/Tenant/Tenant.cs old mode 100644 new mode 100755 index 882a19a4..34e25db8 --- a/Mozu.Api/Contracts/Tenant/Tenant.cs +++ b/Mozu.Api/Contracts/Tenant/Tenant.cs @@ -19,34 +19,16 @@ namespace Mozu.Api.Contracts.Tenant /// public class Tenant { - /// - ///Properties of the domain that the tenant is associated with such as the domain name, the zone string, audit information (system-supplied and read-only), assignment data, and whether or not the domain is primary or requires a SSL for authentication. - /// public string Domain { get; set; } - /// - ///Unique identifier of the Mozu tenant. - /// public int Id { get; set; } - /// - ///Indicates if the tenant is a development tenant. If true, the tenant represents a collection of master catalogs and catalogs for a development tenant, used by a developer account to test applications and themes. - /// public bool IsDevTenant { get; set; } - /// - ///Collection of master catalogs associated with the tenant. - /// public List MasterCatalogs { get; set; } - /// - ///The user supplied name that appears in . You can use this field for identification purposes. - /// public string Name { get; set; } - /// - ///Collection of sites associated with the tenant. - /// public List Sites { get; set; } } diff --git a/Mozu.Api/Contracts/Tenant/TenantAttribute.cs b/Mozu.Api/Contracts/Tenant/TenantAttribute.cs new file mode 100755 index 00000000..bc317791 --- /dev/null +++ b/Mozu.Api/Contracts/Tenant/TenantAttribute.cs @@ -0,0 +1,32 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; + + +namespace Mozu.Api.Contracts.Tenant +{ + public class TenantAttribute + { + public string CreateBy { get; set; } + + public DateTime CreateDate { get; set; } + + public string Name { get; set; } + + public string UpdateBy { get; set; } + + public DateTime UpdateDate { get; set; } + + public object Value { get; set; } + + } + +} \ No newline at end of file diff --git a/Mozu.Api/Contracts/Tenant/TenantCollection.cs b/Mozu.Api/Contracts/Tenant/TenantCollection.cs old mode 100644 new mode 100755 index c654d690..03544628 --- a/Mozu.Api/Contracts/Tenant/TenantCollection.cs +++ b/Mozu.Api/Contracts/Tenant/TenantCollection.cs @@ -19,29 +19,14 @@ namespace Mozu.Api.Contracts.Tenant /// public class TenantCollection { - /// - ///An array list of objects in the returned collection. - /// public List Items { get; set; } - /// - ///The number of pages returned based on the startIndex and pageSize values specified. This value is system-supplied and read-only. - /// public int PageCount { get; set; } - /// - ///The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// public int PageSize { get; set; } - /// - ///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. - /// public int StartIndex { get; set; } - /// - ///The number of results listed in the query collection, represented by a signed 64-bit (8-byte) integer. This value is system-supplied and read-only. - /// public int TotalCount { get; set; } } diff --git a/Mozu.Api/Events/IApplicationEvents.cs b/Mozu.Api/Events/IApplicationEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IAttributeEvents.cs b/Mozu.Api/Events/IAttributeEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/ICartEvents.cs b/Mozu.Api/Events/ICartEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/ICategoryEvents.cs b/Mozu.Api/Events/ICategoryEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/ICreditEvents.cs b/Mozu.Api/Events/ICreditEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/ICustomerAccountEvents.cs b/Mozu.Api/Events/ICustomerAccountEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/ICustomerSegmentEvents.cs b/Mozu.Api/Events/ICustomerSegmentEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IDiscountEvents.cs b/Mozu.Api/Events/IDiscountEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IEmailEvents.cs b/Mozu.Api/Events/IEmailEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IFacetEvents.cs b/Mozu.Api/Events/IFacetEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/ILocationTypeEvents.cs b/Mozu.Api/Events/ILocationTypeEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IOrderEvents.cs b/Mozu.Api/Events/IOrderEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IPriceListEntryEvents.cs b/Mozu.Api/Events/IPriceListEntryEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IPriceListEvents.cs b/Mozu.Api/Events/IPriceListEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IProductDraftEvents.cs b/Mozu.Api/Events/IProductDraftEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IProductEvents.cs b/Mozu.Api/Events/IProductEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IProductInventoryEvents.cs b/Mozu.Api/Events/IProductInventoryEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IProductTypeEvents.cs b/Mozu.Api/Events/IProductTypeEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IReturnEvents.cs b/Mozu.Api/Events/IReturnEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/ISearchSettingsEvents.cs b/Mozu.Api/Events/ISearchSettingsEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IShipmentEvents.cs b/Mozu.Api/Events/IShipmentEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/ISiteEvents.cs b/Mozu.Api/Events/ISiteEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/ITenantEvents.cs b/Mozu.Api/Events/ITenantEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/IWishListEvents.cs b/Mozu.Api/Events/IWishListEvents.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Events/Topics.cs b/Mozu.Api/Events/Topics.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Logging/DefaultLogger.cs b/Mozu.Api/Logging/DefaultLogger.cs index 16a97f0a..5e029540 100644 --- a/Mozu.Api/Logging/DefaultLogger.cs +++ b/Mozu.Api/Logging/DefaultLogger.cs @@ -26,7 +26,7 @@ public void Warn(object message, Exception ex = null, object properties = null) public void Debug(object message, Exception ex = null, object properties = null) { - Console.WriteLine(message); + Console.WriteLine(message); } public void Error(object message, Exception ex = null, object properties = null) @@ -36,7 +36,7 @@ public void Error(object message, Exception ex = null, object properties = null) public void Fatal(object message, Exception ex = null, object properties = null) { - Console.WriteLine(message); + Console.WriteLine(message); } } } diff --git a/Mozu.Api/Mozu.Api.csproj b/Mozu.Api/Mozu.Api.csproj index 449b8d2a..3035a8ea 100644 --- a/Mozu.Api/Mozu.Api.csproj +++ b/Mozu.Api/Mozu.Api.csproj @@ -100,968 +100,1037 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Mozu.Api/MozuClient.cs b/Mozu.Api/MozuClient.cs index 4561d04c..c980a7d8 100644 --- a/Mozu.Api/MozuClient.cs +++ b/Mozu.Api/MozuClient.cs @@ -23,6 +23,7 @@ namespace Mozu.Api { + using System.Threading; /// /// @@ -86,14 +87,10 @@ public virtual MozuClient WithBody(Stream body) } - public virtual MozuClient Execute() - { - base.ExecuteRequest(); - return this; - } - public virtual async Task> ExecuteAsync() + + public virtual async Task> ExecuteAsync(CancellationToken ct) { - await base.ExecuteRequestAsync().ConfigureAwait(false); + await base.ExecuteRequestAsync(ct).ConfigureAwait(false); return this; } @@ -160,15 +157,11 @@ public virtual MozuClient WithBody(Stream body) return this; } - public virtual MozuClient Execute() - { - base.ExecuteRequest(); - return this; - } - public virtual async Task ExecuteAsync() + + public virtual async Task ExecuteAsync(CancellationToken ct) { - await base.ExecuteRequestAsync().ConfigureAwait(false); + await base.ExecuteRequestAsync(ct).ConfigureAwait(false); return this; } @@ -323,6 +316,7 @@ protected void SetBaseAddress(string baseAddress) _baseAddress = HttpHelper.GetUrl(baseAddress); } + protected void SetVerb(string verb) { _verb = verb.ToLower(); @@ -357,7 +351,7 @@ protected void SetBody(string body) _httpContent = new StringContent(body, Encoding.UTF8, "application/json"); } - protected async Task ValidateContext() + protected async Task ValidateContext(CancellationToken ct) { if (AppAuthenticator.Instance == null) @@ -383,16 +377,7 @@ protected async Task ValidateContext() if (string.IsNullOrEmpty(_apiContext.TenantUrl)) { - var tenant = await GetTenant(_apiContext.TenantId).ConfigureAwait(false); - /*var tenantResource = new TenantResource(); - var tenant = tenantResource.GetTenant(_apiContext.TenantId); - - if (tenant == null) - { - var apiException = new ApiException("Tenant " + _apiContext.TenantId + " Not found") {ApiContext = _apiContext}; - _log.Error(apiException.Message, apiException); - throw apiException; - }*/ + var tenant = await GetTenantAsync(_apiContext.TenantId,ct).ConfigureAwait(false); _baseAddress = HttpHelper.GetUrl(tenant.Domain); } @@ -420,17 +405,17 @@ protected async Task ValidateContext() _log.Info("TenantId is missing", new ApiException("TenantId is missing") { ApiContext = _apiContext }); throw new ApiException("TenantId is missing"); } - var tenant = await GetTenant(_apiContext.TenantId).ConfigureAwait(false); + var tenant = await GetTenantAsync(_apiContext.TenantId, ct).ConfigureAwait(false); _baseAddress = tenant.IsDevTenant? MozuConfig.BaseDevPciUrl : MozuConfig.BasePciUrl; } } - private async Task GetTenant(int tenantId) + private async Task GetTenantAsync(int tenantId, CancellationToken ct) { var tenantResource = new TenantResource(); - var tenant = await tenantResource.GetTenantAsync(_apiContext.TenantId).ConfigureAwait(false); + var tenant = await tenantResource.GetTenantAsync(_apiContext.TenantId, ct: ct).ConfigureAwait(false); if (tenant == null) { @@ -441,23 +426,13 @@ private async Task GetTenant(int tenantId) return tenant; } - - protected void ExecuteRequest() - { - ValidateContext().Wait(); - var client = GetHttpClient(); - var request = GetRequestMessage(); - _httpResponseMessage = client.SendAsync(request, HttpCompletionOption.ResponseContentRead).Result; - ResponseHelper.EnsureSuccess(_httpResponseMessage, request, _apiContext); - SetCache(request); - - } - protected async Task ExecuteRequestAsync() + + protected async Task ExecuteRequestAsync(CancellationToken ct) { - await ValidateContext().ConfigureAwait(false); - var client = GetHttpClient(); + await ValidateContext(ct).ConfigureAwait(false); + var client = GetHttpClient(); var request = GetRequestMessage(); - _httpResponseMessage = await client.SendAsync(request, HttpCompletionOption.ResponseContentRead).ConfigureAwait(false); + _httpResponseMessage = await client.SendAsync(request, HttpCompletionOption.ResponseContentRead); ResponseHelper.EnsureSuccess(_httpResponseMessage,request, _apiContext); SetCache(request); } @@ -536,12 +511,12 @@ private HttpRequestMessage GetRequestMessage() return requestMessage; } - private void SetUserClaims() + private async Task SetUserClaims() { if (_apiContext == null || _apiContext.UserAuthTicket == null) return; AuthTicket newAuthTicket = null; if (_apiContext.UserAuthTicket.AuthenticationScope == AuthenticationScope.Customer) - newAuthTicket = CustomerAuthenticator.EnsureAuthTicket(_apiContext.UserAuthTicket); + newAuthTicket = await CustomerAuthenticator.EnsureAuthTicket(_apiContext.UserAuthTicket).ConfigureAwait(false); else newAuthTicket = UserAuthenticator.EnsureAuthTicket(_apiContext.UserAuthTicket); if (newAuthTicket != null) @@ -594,11 +569,12 @@ private HttpClient GetActualClient(Uri u) AllowAutoRedirect = false, UseCookies = false, AutomaticDecompression = DecompressionMethods.GZip - | DecompressionMethods.Deflate + | DecompressionMethods.Deflate, + }); - + client.Timeout = TimeSpan.FromSeconds(MozuConfig.ClientTimeoutInSeconds); client.MaxResponseContentBufferSize = int.MaxValue; _clientsByHostName[key] = client; } diff --git a/Mozu.Api/MozuConfig.cs b/Mozu.Api/MozuConfig.cs index 785daa9c..70cdaee9 100644 --- a/Mozu.Api/MozuConfig.cs +++ b/Mozu.Api/MozuConfig.cs @@ -11,7 +11,9 @@ public class MozuConfig private static bool _enableCache = true; private static int _capabilityTimeoutInSeconds = 180; private static int _eventTimeoutInSeconds = 180; - private static string _baseAppAuthUrl = "https://home.mozu.com"; + private static int _clientTimeoutInSeconds = 20; + + private static string _baseAppAuthUrl = "https://home.mozu.com"; /// /// Payment service url @@ -44,7 +46,13 @@ public static int EventTimeoutInSeconds set { _eventTimeoutInSeconds = value; } } - public static string BaseAppAuthUrl + public static int ClientTimeoutInSeconds + { + get { return _clientTimeoutInSeconds; } + set { _clientTimeoutInSeconds = value; } + } + + public static string BaseAppAuthUrl { get { return _baseAppAuthUrl; } set { _baseAppAuthUrl = value; } diff --git a/Mozu.Api/MozuUrl.cs b/Mozu.Api/MozuUrl.cs index 5453de82..d1b1c6a8 100644 --- a/Mozu.Api/MozuUrl.cs +++ b/Mozu.Api/MozuUrl.cs @@ -58,9 +58,9 @@ public void FormatUrl(string paramName, object value) if (Url.EndsWith("?")) Url = Url.Replace("?", ""); } - public static string GetProductUrl(int tenantId, int siteId, string productCode) + public static async Task GetProductUrl(int tenantId, int siteId, string productCode) { - var site = GetSite(tenantId, siteId); + var site = await GetSite(tenantId, siteId).ConfigureAwait(false); return GetProductUrl(site, productCode); } @@ -79,9 +79,9 @@ public static string GetCategoryUrl(Site site, Category category) string.Format("https://{0}/{1}/c/{2}", domain,category.Content.Slug, category.Id); } - public static string GetCategoryUrl(int tenantId, int siteId, Category category) + public static async Task GetCategoryUrl(int tenantId, int siteId, Category category) { - var site = GetSite(tenantId, siteId); + var site = await GetSite(tenantId, siteId).ConfigureAwait(false); return GetCategoryUrl(site, category); } @@ -90,10 +90,10 @@ public static string GetSiteDomain(Site site) return !String.IsNullOrEmpty(site.PrimaryCustomDomain) ? site.PrimaryCustomDomain : site.Domain; } - private static Site GetSite(int tenantId, int siteId) + private static async Task GetSite(int tenantId, int siteId) { var tenantResource = new TenantResource(); - var tenant = tenantResource.GetTenant(tenantId); + var tenant = await tenantResource.GetTenantAsync(tenantId).ConfigureAwait(false); var site = tenant.Sites.SingleOrDefault(x => x.Id.Equals(siteId)); if (site == null) throw new Exception(string.Format("{0} not found for tenant {1}", siteId, tenantId)); diff --git a/Mozu.Api/Resources/Commerce/Admin/LocationResource.cs b/Mozu.Api/Resources/Commerce/Admin/LocationResource.cs old mode 100644 new mode 100755 index 178c1650..b2176001 --- a/Mozu.Api/Resources/Commerce/Admin/LocationResource.cs +++ b/Mozu.Api/Resources/Commerce/Admin/LocationResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Admin { @@ -37,42 +38,15 @@ public LocationResource CloneWithApiContext(Action contextModificat } - /// - /// Retrieves a list of all locations associated with a tenant, according to any filter and sort criteria specified in the request. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// var locationCollection = location.GetLocations( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.LocationCollection GetLocations(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.GetLocationsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of all locations associated with a tenant, according to any filter and sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.Location.LocationCollection GetLocations(int? /// var locationCollection = await location.GetLocationsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetLocationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetLocationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.GetLocationsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the location specified in the request by location code. - /// - /// The unique, user-defined code that identifies a location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// var location = location.GetLocation( locationCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.Location GetLocation(string locationCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.GetLocationClient( locationCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the location specified in the request by location code. + /// /// - /// The unique, user-defined code that identifies a location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// The merchant-defined code of the location to retrieve. + /// /// /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.Location.Location GetLocation(string locationC /// var location = await location.GetLocationAsync( locationCode, responseFields); /// /// - public virtual async Task GetLocationAsync(string locationCode, string responseFields = null) + public virtual async Task GetLocationAsync(string locationCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.GetLocationClient( locationCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new physical location for the tenant specified in the request header. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// var location = location.AddLocation( location, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.Location AddLocation(Mozu.Api.Contracts.Location.Location location, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.AddLocationClient( location, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new physical location for the tenant specified in the request header. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. + /// + /// Properties of the location to create. /// /// /// @@ -180,48 +106,23 @@ public virtual Mozu.Api.Contracts.Location.Location AddLocation(Mozu.Api.Contrac /// var location = await location.AddLocationAsync( location, responseFields); /// /// - public virtual async Task AddLocationAsync(Mozu.Api.Contracts.Location.Location location, string responseFields = null) + public virtual async Task AddLocationAsync(Mozu.Api.Contracts.Location.Location location, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.AddLocationClient( location, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more details of a the location specified in the request by location code. - /// - /// The unique, user-defined code that identifies a location. - /// Use this field to include those fields which are not included by default. - /// Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// var location = location.UpdateLocation( location, locationCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.Location UpdateLocation(Mozu.Api.Contracts.Location.Location location, string locationCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.UpdateLocationClient( location, locationCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more details of a the location specified in the request by location code. + /// /// - /// The unique, user-defined code that identifies a location. - /// Use this field to include those fields which are not included by default. - /// Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. + /// The merchant-defined code associated with the location to update. + /// + /// Properties of the location to update. /// /// /// @@ -231,43 +132,21 @@ public virtual Mozu.Api.Contracts.Location.Location UpdateLocation(Mozu.Api.Cont /// var location = await location.UpdateLocationAsync( location, locationCode, responseFields); /// /// - public virtual async Task UpdateLocationAsync(Mozu.Api.Contracts.Location.Location location, string locationCode, string responseFields = null) + public virtual async Task UpdateLocationAsync(Mozu.Api.Contracts.Location.Location location, string locationCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.UpdateLocationClient( location, locationCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the location specified in the request. - /// - /// The unique, user-defined code that identifies a location. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// location.DeleteLocation( locationCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteLocation(string locationCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.DeleteLocationClient( locationCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the location specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. + /// The merchant-defined code of the location to delete. /// /// /// @@ -277,12 +156,12 @@ public virtual void DeleteLocation(string locationCode) /// await location.DeleteLocationAsync( locationCode); /// /// - public virtual async Task DeleteLocationAsync(string locationCode) + public virtual async Task DeleteLocationAsync(string locationCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Admin.LocationClient.DeleteLocationClient( locationCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Admin/LocationTypeResource.cs b/Mozu.Api/Resources/Commerce/Admin/LocationTypeResource.cs old mode 100644 new mode 100755 index 00b2cf3f..405550b3 --- a/Mozu.Api/Resources/Commerce/Admin/LocationTypeResource.cs +++ b/Mozu.Api/Resources/Commerce/Admin/LocationTypeResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Admin { @@ -37,31 +38,9 @@ public LocationTypeResource CloneWithApiContext(Action contextModif } - /// - /// Retrieve a list of all location types defined for the tenant. - /// - /// - /// List{} - /// - /// - /// - /// var locationtype = new LocationType(); - /// var locationType = locationtype.GetLocationTypes(); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetLocationTypes() - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.GetLocationTypesClient(); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve a list of all location types defined for the tenant. + /// /// /// /// List{} @@ -72,46 +51,22 @@ public LocationTypeResource CloneWithApiContext(Action contextModif /// var locationType = await locationtype.GetLocationTypesAsync(); /// /// - public virtual async Task> GetLocationTypesAsync() + public virtual async Task> GetLocationTypesAsync(CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.GetLocationTypesClient(); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the location type specified in the request. - /// - /// The user-defined code that identifies the location type. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var locationtype = new LocationType(); - /// var locationType = locationtype.GetLocationType( locationTypeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.LocationType GetLocationType(string locationTypeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.GetLocationTypeClient( locationTypeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the location type specified in the request. + /// /// /// The user-defined code that identifies the location type. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -121,46 +76,22 @@ public virtual Mozu.Api.Contracts.Location.LocationType GetLocationType(string l /// var locationType = await locationtype.GetLocationTypeAsync( locationTypeCode, responseFields); /// /// - public virtual async Task GetLocationTypeAsync(string locationTypeCode, string responseFields = null) + public virtual async Task GetLocationTypeAsync(string locationTypeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.GetLocationTypeClient( locationTypeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new location type based on the information specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of a type of physical location, such as warehouse or kiosk. Location types enable tenants to group similar locations for filtering and location usage type definition. - /// - /// - /// - /// - /// - /// var locationtype = new LocationType(); - /// var locationType = locationtype.AddLocationType( locationType, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.LocationType AddLocationType(Mozu.Api.Contracts.Location.LocationType locationType, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.AddLocationTypeClient( locationType, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new location type based on the information specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a type of physical location, such as warehouse or kiosk. Location types enable tenants to group similar locations for filtering and location usage type definition. + /// + /// Properties of the location type to create. /// /// /// @@ -170,48 +101,23 @@ public virtual Mozu.Api.Contracts.Location.LocationType AddLocationType(Mozu.Api /// var locationType = await locationtype.AddLocationTypeAsync( locationType, responseFields); /// /// - public virtual async Task AddLocationTypeAsync(Mozu.Api.Contracts.Location.LocationType locationType, string responseFields = null) + public virtual async Task AddLocationTypeAsync(Mozu.Api.Contracts.Location.LocationType locationType, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.AddLocationTypeClient( locationType, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the name of a defined location type. - /// - /// The user-defined code that identifies the location type. - /// Use this field to include those fields which are not included by default. - /// Properties of a type of physical location, such as warehouse or kiosk. Location types enable tenants to group similar locations for filtering and location usage type definition. - /// - /// - /// - /// - /// - /// var locationtype = new LocationType(); - /// var locationType = locationtype.UpdateLocationType( locationType, locationTypeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.LocationType UpdateLocationType(Mozu.Api.Contracts.Location.LocationType locationType, string locationTypeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.UpdateLocationTypeClient( locationType, locationTypeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the name of a defined location type. + /// /// /// The user-defined code that identifies the location type. - /// Use this field to include those fields which are not included by default. - /// Properties of a type of physical location, such as warehouse or kiosk. Location types enable tenants to group similar locations for filtering and location usage type definition. + /// + /// Properties of the location type to update. /// /// /// @@ -221,43 +127,21 @@ public virtual Mozu.Api.Contracts.Location.LocationType UpdateLocationType(Mozu. /// var locationType = await locationtype.UpdateLocationTypeAsync( locationType, locationTypeCode, responseFields); /// /// - public virtual async Task UpdateLocationTypeAsync(Mozu.Api.Contracts.Location.LocationType locationType, string locationTypeCode, string responseFields = null) + public virtual async Task UpdateLocationTypeAsync(Mozu.Api.Contracts.Location.LocationType locationType, string locationTypeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.UpdateLocationTypeClient( locationType, locationTypeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the location type specified in the request. - /// - /// The user-defined code that identifies the location type. - /// - /// - /// - /// - /// - /// var locationtype = new LocationType(); - /// locationtype.DeleteLocationType( locationTypeCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteLocationType(string locationTypeCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.DeleteLocationTypeClient( locationTypeCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the location type specified in the request. + /// /// - /// The user-defined code that identifies the location type. + /// User-defined code used to identify the location type. /// /// /// @@ -267,12 +151,12 @@ public virtual void DeleteLocationType(string locationTypeCode) /// await locationtype.DeleteLocationTypeAsync( locationTypeCode); /// /// - public virtual async Task DeleteLocationTypeAsync(string locationTypeCode) + public virtual async Task DeleteLocationTypeAsync(string locationTypeCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Admin.LocationTypeClient.DeleteLocationTypeClient( locationTypeCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Admin/Locations/Attributedefinition/AttributeResource.cs b/Mozu.Api/Resources/Commerce/Admin/Locations/Attributedefinition/AttributeResource.cs new file mode 100755 index 00000000..ba4e4448 --- /dev/null +++ b/Mozu.Api/Resources/Commerce/Admin/Locations/Attributedefinition/AttributeResource.cs @@ -0,0 +1,174 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce.Admin.Locations.Attributedefinition +{ + /// + /// + /// + public partial class AttributeResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public AttributeResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public AttributeResource CloneWithApiContext(Action contextModification) + { + return new AttributeResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var attribute = new Attribute(); + /// var attributeCollection = await attribute.GetAttributesAsync( startIndex, pageSize, sortBy, filter, responseFields); + /// + /// + public virtual async Task GetAttributesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.GetAttributesClient( startIndex, pageSize, sortBy, filter, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// List{} + /// + /// + /// + /// var attribute = new Attribute(); + /// var attributeVocabularyValue = await attribute.GetAttributeVocabularyValuesAsync( attributeFQN); + /// + /// + public virtual async Task> GetAttributeVocabularyValuesAsync(string attributeFQN, CancellationToken ct = default(CancellationToken)) + { + MozuClient> response; + var client = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.GetAttributeVocabularyValuesClient( attributeFQN); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var attribute = new Attribute(); + /// var attribute = await attribute.GetAttributeAsync( attributeFQN, responseFields); + /// + /// + public virtual async Task GetAttributeAsync(string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.GetAttributeClient( attributeFQN, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var attribute = new Attribute(); + /// var attribute = await attribute.CreateAttributeAsync( attribute, responseFields); + /// + /// + public virtual async Task CreateAttributeAsync(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.CreateAttributeClient( attribute, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var attribute = new Attribute(); + /// var attribute = await attribute.UpdateAttributeAsync( attribute, attributeFQN, responseFields); + /// + /// + public virtual async Task UpdateAttributeAsync(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Admin.Locations.Attributedefinition.AttributeClient.UpdateAttributeClient( attribute, attributeFQN, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/CartResource.cs b/Mozu.Api/Resources/Commerce/CartResource.cs old mode 100644 new mode 100755 index 27e09685..9d7e6461 --- a/Mozu.Api/Resources/Commerce/CartResource.cs +++ b/Mozu.Api/Resources/Commerce/CartResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce { /// - /// Use this resource to manage storefront shopping carts as shoppers add and remove items for purchase. Each time a shopper's cart is modified, the Carts resource updates the estimated total with any applicable discounts. + /// Use the Carts resource to manage storefront shopping carts as items are added and removed. Each time a shopper's cart is modified, the Carts resource updates the estimated total with any applicable discounts. /// public partial class CartResource { /// @@ -37,36 +38,12 @@ public CartResource CloneWithApiContext(Action contextModification) } - /// - /// Retrieves the cart specified in the request. - /// - /// Identifier of the cart to delete. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var cart = new Cart(); - /// var cart = cart.GetCart( cartId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetCart(string cartId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.CartClient.GetCartClient( cartId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the cart specified in the request. + /// /// - /// Identifier of the cart to delete. - /// Use this field to include those fields which are not included by default. + /// Identifier of the cart to retrieve. + /// /// /// /// @@ -76,44 +53,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetCart(string cart /// var cart = await cart.GetCartAsync( cartId, responseFields); /// /// - public virtual async Task GetCartAsync(string cartId, string responseFields = null) + public virtual async Task GetCartAsync(string cartId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.CartClient.GetCartClient( cartId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a cart's contents for the current shopper. If the shopper does not have an active cart on the site, the service creates one. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var cart = new Cart(); - /// var cart = cart.GetOrCreateCart( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetOrCreateCart(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.CartClient.GetOrCreateCartClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a cart's contents for the current shopper. If the shopper does not have an active cart on the site, the service creates one. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -123,44 +77,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetOrCreateCart(str /// var cart = await cart.GetOrCreateCartAsync( responseFields); /// /// - public virtual async Task GetOrCreateCartAsync(string responseFields = null) + public virtual async Task GetOrCreateCartAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.CartClient.GetOrCreateCartClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves summary information associated with the cart of the current shopper, including the number of items, the current total, and whether the cart has expired. All anonymous idle carts that do not proceed to checkout expire after 14 days. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var cart = new Cart(); - /// var cartSummary = cart.GetCartSummary( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartSummary GetCartSummary(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.CartClient.GetCartSummaryClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves summary information associated with the cart of the current shopper, including the number of items, the current total, and whether the cart has expired. All anonymous idle carts that do not proceed to checkout expire after 14 days. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -170,46 +101,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartSummary GetCartSumma /// var cartSummary = await cart.GetCartSummaryAsync( responseFields); /// /// - public virtual async Task GetCartSummaryAsync(string responseFields = null) + public virtual async Task GetCartSummaryAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.CartClient.GetCartSummaryClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves summary information associated with the cart of user specified in the request, including the number of items in the cart, the current total, and whether the cart has expired. All anonymous idle carts that do not proceed to checkout expire after 14 days. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. - /// - /// - /// - /// - /// - /// var cart = new Cart(); - /// var cartSummary = cart.GetUserCartSummary( userId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartSummary GetUserCartSummary(string userId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.CartClient.GetUserCartSummaryClient( userId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves summary information associated with the cart of user specified in the request, including the number of items in the cart, the current total, and whether the cart has expired. All anonymous idle carts that do not proceed to checkout expire after 14 days. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. + /// + /// Unique identifier of the user whose cart details you want to retrieve. /// /// /// @@ -219,46 +126,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartSummary GetUserCartS /// var cartSummary = await cart.GetUserCartSummaryAsync( userId, responseFields); /// /// - public virtual async Task GetUserCartSummaryAsync(string userId, string responseFields = null) + public virtual async Task GetUserCartSummaryAsync(string userId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.CartClient.GetUserCartSummaryClient( userId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the cart of the user specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. - /// - /// - /// - /// - /// - /// var cart = new Cart(); - /// var cart = cart.GetUserCart( userId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetUserCart(string userId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.CartClient.GetUserCartClient( userId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the cart of the user specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. + /// + /// Unique identifier of the user whose cart you want to retrieve. /// /// /// @@ -268,46 +151,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart GetUserCart(string /// var cart = await cart.GetUserCartAsync( userId, responseFields); /// /// - public virtual async Task GetUserCartAsync(string userId, string responseFields = null) + public virtual async Task GetUserCartAsync(string userId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.CartClient.GetUserCartClient( userId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update the current shopper's cart. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of a shopping cart. - /// - /// - /// - /// - /// - /// var cart = new Cart(); - /// var cart = cart.UpdateCart( cart, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart UpdateCart(Mozu.Api.Contracts.CommerceRuntime.Carts.Cart cart, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.CartClient.UpdateCartClient( cart, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update the current shopper's cart. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a shopping cart. + /// + /// All of the properties of the cart to update. The product code is required. /// /// /// @@ -317,41 +176,19 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart UpdateCart(Mozu.Api /// var cart = await cart.UpdateCartAsync( cart, responseFields); /// /// - public virtual async Task UpdateCartAsync(Mozu.Api.Contracts.CommerceRuntime.Carts.Cart cart, string responseFields = null) + public virtual async Task UpdateCartAsync(Mozu.Api.Contracts.CommerceRuntime.Carts.Cart cart, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.CartClient.UpdateCartClient( cart, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the cart specified in the request. - /// - /// Identifier of the cart to delete. - /// - /// - /// - /// - /// - /// var cart = new Cart(); - /// cart.DeleteCart( cartId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCart(string cartId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.CartClient.DeleteCartClient( cartId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the cart specified in the request. + /// /// /// Identifier of the cart to delete. /// @@ -363,39 +200,18 @@ public virtual void DeleteCart(string cartId) /// await cart.DeleteCartAsync( cartId); /// /// - public virtual async Task DeleteCartAsync(string cartId) + public virtual async Task DeleteCartAsync(string cartId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.CartClient.DeleteCartClient( cartId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the cart of the currently active shopper. - /// - /// - /// - /// - /// - /// - /// var cart = new Cart(); - /// cart.DeleteCurrentCart(); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCurrentCart() - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.CartClient.DeleteCurrentCartClient(); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the cart of the currently active shopper. + /// /// /// /// @@ -406,12 +222,12 @@ public virtual void DeleteCurrentCart() /// await cart.DeleteCurrentCartAsync(); /// /// - public virtual async Task DeleteCurrentCartAsync() + public virtual async Task DeleteCurrentCartAsync(CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.CartClient.DeleteCurrentCartClient(); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Carts/AppliedDiscountResource.cs b/Mozu.Api/Resources/Commerce/Carts/AppliedDiscountResource.cs old mode 100644 new mode 100755 index ed23ea76..4c19a01c --- a/Mozu.Api/Resources/Commerce/Carts/AppliedDiscountResource.cs +++ b/Mozu.Api/Resources/Commerce/Carts/AppliedDiscountResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Carts { /// - /// Use the Cart Coupons subresource to apply a coupon to a defined cart or remove a coupon from a cart. When the shopper proceeds to checkout, the coupons applied to the cart apply to the order. + /// Use the Cart Coupons resource to apply a coupon to a defined cart or remove a coupon from a cart. When the shopper proceeds to checkout, the coupons applied to the cart apply to the order. /// public partial class AppliedDiscountResource { /// @@ -37,38 +38,13 @@ public AppliedDiscountResource CloneWithApiContext(Action contextMo } - /// - /// Applies a defined coupon to the cart specified in the request. - /// - /// Identifier of the cart to delete. - /// Code associated with the coupon to remove from the cart. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var applieddiscount = new AppliedDiscount(); - /// var cart = applieddiscount.ApplyCoupon( cartId, couponCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart ApplyCoupon(string cartId, string couponCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.AppliedDiscountClient.ApplyCouponClient( cartId, couponCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Applies a defined coupon to the cart specified in the request. + /// /// - /// Identifier of the cart to delete. - /// Code associated with the coupon to remove from the cart. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the cart to which to apply the coupon. + /// Code associated with the coupon to apply to the cart. + /// /// /// /// @@ -78,44 +54,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart ApplyCoupon(string /// var cart = await applieddiscount.ApplyCouponAsync( cartId, couponCode, responseFields); /// /// - public virtual async Task ApplyCouponAsync(string cartId, string couponCode, string responseFields = null) + public virtual async Task ApplyCouponAsync(string cartId, string couponCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.AppliedDiscountClient.ApplyCouponClient( cartId, couponCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes all coupons from the cart specified in the request. - /// - /// Identifier of the cart to delete. - /// - /// - /// - /// - /// - /// var applieddiscount = new AppliedDiscount(); - /// var cart = applieddiscount.RemoveCoupons( cartId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveCoupons(string cartId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.AppliedDiscountClient.RemoveCouponsClient( cartId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes all coupons from the cart specified in the request. + /// /// - /// Identifier of the cart to delete. + /// Unique identifier of the cart. /// /// /// @@ -125,45 +78,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveCoupons(strin /// var cart = await applieddiscount.RemoveCouponsAsync( cartId); /// /// - public virtual async Task RemoveCouponsAsync(string cartId) + public virtual async Task RemoveCouponsAsync(string cartId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.AppliedDiscountClient.RemoveCouponsClient( cartId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes an applied coupon from the cart specified in the request. - /// - /// Identifier of the cart to delete. - /// Code associated with the coupon to remove from the cart. - /// - /// - /// - /// - /// - /// var applieddiscount = new AppliedDiscount(); - /// var cart = applieddiscount.RemoveCoupon( cartId, couponCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveCoupon(string cartId, string couponCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.AppliedDiscountClient.RemoveCouponClient( cartId, couponCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes an applied coupon from the cart specified in the request. + /// /// - /// Identifier of the cart to delete. + /// Unique identifier of the cart. /// Code associated with the coupon to remove from the cart. /// /// @@ -174,12 +103,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveCoupon(string /// var cart = await applieddiscount.RemoveCouponAsync( cartId, couponCode); /// /// - public virtual async Task RemoveCouponAsync(string cartId, string couponCode) + public virtual async Task RemoveCouponAsync(string cartId, string couponCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.AppliedDiscountClient.RemoveCouponClient( cartId, couponCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Carts/CartItemResource.cs b/Mozu.Api/Resources/Commerce/Carts/CartItemResource.cs old mode 100644 new mode 100755 index 639b2dd0..50b1207f --- a/Mozu.Api/Resources/Commerce/Carts/CartItemResource.cs +++ b/Mozu.Api/Resources/Commerce/Carts/CartItemResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Carts { @@ -37,36 +38,12 @@ public CartItemResource CloneWithApiContext(Action contextModificat } - /// - /// Retrieves a particular cart item by providing the cart item ID. - /// - /// Identifier of the cart item to delete. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var cartitem = new CartItem(); - /// var cartItem = cartitem.GetCartItem( cartItemId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem GetCartItem(string cartItemId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.GetCartItemClient( cartItemId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a particular cart item by providing the cart item ID. + /// /// - /// Identifier of the cart item to delete. - /// Use this field to include those fields which are not included by default. + /// Identifier of the cart item to retrieve. + /// /// /// /// @@ -76,44 +53,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem GetCartItem(str /// var cartItem = await cartitem.GetCartItemAsync( cartItemId, responseFields); /// /// - public virtual async Task GetCartItemAsync(string cartItemId, string responseFields = null) + public virtual async Task GetCartItemAsync(string cartItemId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.GetCartItemClient( cartItemId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of cart items including the total number of items in the cart. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var cartitem = new CartItem(); - /// var cartItemCollection = cartitem.GetCartItems( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItemCollection GetCartItems(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.GetCartItemsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of cart items including the total number of items in the cart. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -123,46 +77,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItemCollection GetCa /// var cartItemCollection = await cartitem.GetCartItemsAsync( responseFields); /// /// - public virtual async Task GetCartItemsAsync(string responseFields = null) + public virtual async Task GetCartItemsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.GetCartItemsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a product to the current shopper's cart. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of an item added to an active shopping cart. - /// - /// - /// - /// - /// - /// var cartitem = new CartItem(); - /// var cartItem = cartitem.AddItemToCart( cartItem, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem AddItemToCart(Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem cartItem, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.AddItemToCartClient( cartItem, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a product to the current shopper's cart. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of an item added to an active shopping cart. + /// + /// All properties of the new cart item. The product code is required. /// /// /// @@ -172,48 +102,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem AddItemToCart(M /// var cartItem = await cartitem.AddItemToCartAsync( cartItem, responseFields); /// /// - public virtual async Task AddItemToCartAsync(Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem cartItem, string responseFields = null) + public virtual async Task AddItemToCartAsync(Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem cartItem, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.AddItemToCartClient( cartItem, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update the quantity of an individual cart item in the cart of the current shopper. - /// - /// Identifier of the cart item to delete. - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var cartitem = new CartItem(); - /// var cartItem = cartitem.UpdateCartItemQuantity( cartItemId, quantity, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem UpdateCartItemQuantity(string cartItemId, int quantity, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.UpdateCartItemQuantityClient( cartItemId, quantity, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update the quantity of an individual cart item in the cart of the current shopper. + /// /// - /// Identifier of the cart item to delete. + /// Identifier of the cart item to update quantity. /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -223,48 +128,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem UpdateCartItemQ /// var cartItem = await cartitem.UpdateCartItemQuantityAsync( cartItemId, quantity, responseFields); /// /// - public virtual async Task UpdateCartItemQuantityAsync(string cartItemId, int quantity, string responseFields = null) + public virtual async Task UpdateCartItemQuantityAsync(string cartItemId, int quantity, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.UpdateCartItemQuantityClient( cartItemId, quantity, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update the product or product quantity of an item in the current shopper's cart. - /// - /// Identifier of the cart item to delete. - /// Use this field to include those fields which are not included by default. - /// Properties of an item added to an active shopping cart. - /// - /// - /// - /// - /// - /// var cartitem = new CartItem(); - /// var cartItem = cartitem.UpdateCartItem( cartItem, cartItemId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem UpdateCartItem(Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem cartItem, string cartItemId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.UpdateCartItemClient( cartItem, cartItemId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update the product or product quantity of an item in the current shopper's cart. + /// /// - /// Identifier of the cart item to delete. - /// Use this field to include those fields which are not included by default. - /// Properties of an item added to an active shopping cart. + /// Identifier of the cart item to update. + /// + /// The properties of the cart item to update. /// /// /// @@ -274,41 +154,19 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem UpdateCartItem( /// var cartItem = await cartitem.UpdateCartItemAsync( cartItem, cartItemId, responseFields); /// /// - public virtual async Task UpdateCartItemAsync(Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem cartItem, string cartItemId, string responseFields = null) + public virtual async Task UpdateCartItemAsync(Mozu.Api.Contracts.CommerceRuntime.Carts.CartItem cartItem, string cartItemId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.UpdateCartItemClient( cartItem, cartItemId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes all items in the current shopper's active cart. - /// - /// - /// - /// - /// - /// - /// var cartitem = new CartItem(); - /// var cart = cartitem.RemoveAllCartItems(); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveAllCartItems() - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.RemoveAllCartItemsClient(); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes all items in the current shopper's active cart. + /// /// /// /// @@ -319,41 +177,19 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.Cart RemoveAllCartItems( /// var cart = await cartitem.RemoveAllCartItemsAsync(); /// /// - public virtual async Task RemoveAllCartItemsAsync() + public virtual async Task RemoveAllCartItemsAsync(CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.RemoveAllCartItemsClient(); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a specific cart item by providing the cart item ID. - /// - /// Identifier of the cart item to delete. - /// - /// - /// - /// - /// - /// var cartitem = new CartItem(); - /// cartitem.DeleteCartItem( cartItemId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCartItem(string cartItemId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.DeleteCartItemClient( cartItemId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a specific cart item by providing the cart item ID. + /// /// /// Identifier of the cart item to delete. /// @@ -365,12 +201,12 @@ public virtual void DeleteCartItem(string cartItemId) /// await cartitem.DeleteCartItemAsync( cartItemId); /// /// - public virtual async Task DeleteCartItemAsync(string cartItemId) + public virtual async Task DeleteCartItemAsync(string cartItemId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.CartItemClient.DeleteCartItemClient( cartItemId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Carts/ChangeMessageResource.cs b/Mozu.Api/Resources/Commerce/Carts/ChangeMessageResource.cs old mode 100644 new mode 100755 index d6c25d02..798f1fba --- a/Mozu.Api/Resources/Commerce/Carts/ChangeMessageResource.cs +++ b/Mozu.Api/Resources/Commerce/Carts/ChangeMessageResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Carts { @@ -37,34 +38,11 @@ public ChangeMessageResource CloneWithApiContext(Action contextModi } - /// - /// Retrieves the messages associated with the current shopper's cart. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var changemessage = new ChangeMessage(); - /// var cartChangeMessageCollection = changemessage.GetMessages( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartChangeMessageCollection GetMessages(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.ChangeMessageClient.GetMessagesClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the messages associated with the current shopper's cart. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -74,40 +52,19 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Carts.CartChangeMessageCollect /// var cartChangeMessageCollection = await changemessage.GetMessagesAsync( responseFields); /// /// - public virtual async Task GetMessagesAsync(string responseFields = null) + public virtual async Task GetMessagesAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.ChangeMessageClient.GetMessagesClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes all messages associated with the cart of the current shopper. - /// - /// - /// - /// - /// - /// - /// var changemessage = new ChangeMessage(); - /// changemessage.RemoveAllMessages(); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void RemoveAllMessages() - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.ChangeMessageClient.RemoveAllMessagesClient(); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes all messages associated with the cart of the current shopper. + /// /// /// /// @@ -118,40 +75,18 @@ public virtual void RemoveAllMessages() /// await changemessage.RemoveAllMessagesAsync(); /// /// - public virtual async Task RemoveAllMessagesAsync() + public virtual async Task RemoveAllMessagesAsync(CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.ChangeMessageClient.RemoveAllMessagesClient(); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Removes a single message associated with the cart of the current shopper. - /// - /// Identifier of the message to remove from the cart. - /// - /// - /// - /// - /// - /// var changemessage = new ChangeMessage(); - /// changemessage.RemoveMessage( messageId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void RemoveMessage(string messageId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.ChangeMessageClient.RemoveMessageClient( messageId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes a single message associated with the cart of the current shopper. + /// /// /// Identifier of the message to remove from the cart. /// @@ -163,12 +98,12 @@ public virtual void RemoveMessage(string messageId) /// await changemessage.RemoveMessageAsync( messageId); /// /// - public virtual async Task RemoveMessageAsync(string messageId) + public virtual async Task RemoveMessageAsync(string messageId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.ChangeMessageClient.RemoveMessageClient( messageId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Carts/ExtendedPropertyResource.cs b/Mozu.Api/Resources/Commerce/Carts/ExtendedPropertyResource.cs old mode 100644 new mode 100755 index b83513af..a2d0ec0e --- a/Mozu.Api/Resources/Commerce/Carts/ExtendedPropertyResource.cs +++ b/Mozu.Api/Resources/Commerce/Carts/ExtendedPropertyResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Carts { /// - /// Use the Cart Extended Properties subresource to store an arbitrary number of cart extended properties such as tracking strings, marketing sources, affiliates, sales personnel/data, and so on, on a per cart basis. Each cart may have none, one, or more than one entry in the extended properties collection, and all values in the extended properties collection are represented as strings. When you create an order from a cart, all extended properties are retained from the cart and copied to the order. Refer to the subresource for more information about order extended properties. + /// /// public partial class ExtendedPropertyResource { /// @@ -37,31 +38,9 @@ public ExtendedPropertyResource CloneWithApiContext(Action contextM } - /// - /// Retrieves a list of cart extended properties specified in the request. - /// - /// - /// List{} - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// var extendedProperty = extendedproperty.GetExtendedProperties(); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetExtendedProperties() - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.GetExtendedPropertiesClient(); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of cart extended properties specified in the request. + /// /// /// /// List{} @@ -72,44 +51,21 @@ public ExtendedPropertyResource CloneWithApiContext(Action contextM /// var extendedProperty = await extendedproperty.GetExtendedPropertiesAsync(); /// /// - public virtual async Task> GetExtendedPropertiesAsync() + public virtual async Task> GetExtendedPropertiesAsync(CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.GetExtendedPropertiesClient(); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds one or more specified extended properties to the carts extended properties collection. - /// - /// The details of the new extended property. - /// - /// List{} - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// var extendedProperty = extendedproperty.AddExtendedProperties( extendedProperties); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List AddExtendedProperties(List extendedProperties) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.AddExtendedPropertiesClient( extendedProperties); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds one or more specified extended properties to the carts extended properties collection. + /// /// - /// The details of the new extended property. + /// /// /// List{} /// @@ -119,50 +75,24 @@ public ExtendedPropertyResource CloneWithApiContext(Action contextM /// var extendedProperty = await extendedproperty.AddExtendedPropertiesAsync( extendedProperties); /// /// - public virtual async Task> AddExtendedPropertiesAsync(List extendedProperties) + public virtual async Task> AddExtendedPropertiesAsync(List extendedProperties, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.AddExtendedPropertiesClient( extendedProperties); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more details of the extended property specified in the request. - /// - /// Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Any set of key value pairs to be stored in the extended properties of a cart. - /// The details of the updated extended property. - /// - /// - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// var extendedProperty = extendedproperty.UpdateExtendedProperty( extendedProperty, key, upsert, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty UpdateExtendedProperty(Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty extendedProperty, string key, bool? upsert = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.UpdateExtendedPropertyClient( extendedProperty, key, upsert, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more details of the extended property specified in the request. + /// /// - /// Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Any set of key value pairs to be stored in the extended properties of a cart. - /// The details of the updated extended property. + /// + /// + /// + /// /// /// /// @@ -172,46 +102,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty Upda /// var extendedProperty = await extendedproperty.UpdateExtendedPropertyAsync( extendedProperty, key, upsert, responseFields); /// /// - public virtual async Task UpdateExtendedPropertyAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty extendedProperty, string key, bool? upsert = null, string responseFields = null) + public virtual async Task UpdateExtendedPropertyAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty extendedProperty, string key, bool? upsert = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.UpdateExtendedPropertyClient( extendedProperty, key, upsert, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more details of the extended properties specified in the request. - /// - /// Any set of key value pairs to be stored in the extended properties of a cart. - /// The details of the updated extended properties. - /// - /// List{} - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// var extendedProperty = extendedproperty.UpdateExtendedProperties( extendedProperties, upsert); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateExtendedProperties(List extendedProperties, bool? upsert = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.UpdateExtendedPropertiesClient( extendedProperties, upsert); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more details of the extended properties specified in the request. + /// /// - /// Any set of key value pairs to be stored in the extended properties of a cart. - /// The details of the updated extended properties. + /// + /// /// /// List{} /// @@ -221,41 +127,19 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty Upda /// var extendedProperty = await extendedproperty.UpdateExtendedPropertiesAsync( extendedProperties, upsert); /// /// - public virtual async Task> UpdateExtendedPropertiesAsync(List extendedProperties, bool? upsert = null) + public virtual async Task> UpdateExtendedPropertiesAsync(List extendedProperties, bool? upsert = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.UpdateExtendedPropertiesClient( extendedProperties, upsert); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the extended properties cart extended properties collection. - /// - /// - /// - /// - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// extendedproperty.DeleteExtendedProperties( keys); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteExtendedProperties(List keys) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.DeleteExtendedPropertiesClient( keys); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the extended properties cart extended properties collection. + /// /// /// /// @@ -267,40 +151,18 @@ public virtual void DeleteExtendedProperties(List keys) /// await extendedproperty.DeleteExtendedPropertiesAsync( keys); /// /// - public virtual async Task DeleteExtendedPropertiesAsync(List keys) + public virtual async Task DeleteExtendedPropertiesAsync(List keys, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.DeleteExtendedPropertiesClient( keys); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes a specific extended property from the cart extended property collection. - /// - /// - /// - /// - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// extendedproperty.DeleteExtendedProperty( key); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteExtendedProperty(string key) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.DeleteExtendedPropertyClient( key); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a specific extended property from the cart extended property collection. + /// /// /// /// @@ -312,12 +174,12 @@ public virtual void DeleteExtendedProperty(string key) /// await extendedproperty.DeleteExtendedPropertyAsync( key); /// /// - public virtual async Task DeleteExtendedPropertyAsync(string key) + public virtual async Task DeleteExtendedPropertyAsync(string key, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Carts.ExtendedPropertyClient.DeleteExtendedPropertyClient( key); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/AttributeResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/AttributeResource.cs old mode 100644 new mode 100755 index 3bbe5f0a..b99e2d3a --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/AttributeResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/AttributeResource.cs @@ -13,13 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Attributedefinition { /// - /// Attributes are used to add custom definitions and characteristics to the following objects: - - + /// Use the Attribute Definition resource to manage the properties, options, and extras that uniquely describe products of a specific type. Attributes can be associated with a product type, assigned values by a client or shopper, and added as faceted search filters for a product category. Options are product attributes that describe unique configurations made by the shopper, such as size or color, and generate a new product variation (or unique SKU). Properties are product attributes that describe aspects of the product that do not represent an option configurable by the shopper, such as screen resolution or brand. Extras are product attributes that describe add-on configurations made by the shopper that do not represent a product variation, such as a monogram. /// public partial class AttributeResource { /// @@ -39,41 +38,13 @@ public AttributeResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// - /// - /// {} - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// var attributeCollection = attribute.GetAttributes( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeCollection GetAttributes(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.GetAttributesClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// {} @@ -86,47 +57,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeCollection GetAttributes /// var attributeCollection = await attribute.GetAttributesAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAttributesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAttributesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.GetAttributesClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the specified product attribute. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// {} - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// var attribute = attribute.GetAttribute( attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Attribute GetAttribute(string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.GetAttributeClient( attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified product attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// {} /// /// @@ -137,48 +83,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Attribute GetAttribute(string att /// var attribute = await attribute.GetAttributeAsync( attributeFQN, responseFields); /// /// - public virtual async Task GetAttributeAsync(string attributeFQN, string responseFields = null) + public virtual async Task GetAttributeAsync(string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.GetAttributeClient( attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new attribute to describe one aspect of a product such as color or size, based on its defined product type. The attribute name, attribute type, input type, and data type are required. - /// - /// Use this field to include those fields which are not included by default. - /// {} - /// Properties of an attribute used to describe customers or orders. - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// var attribute = attribute.AddAttribute( attribute, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Attribute AddAttribute(Mozu.Api.Contracts.ProductAdmin.Attribute attribute, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.AddAttributeClient( attribute, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new attribute to describe one aspect of a product such as color or size, based on its defined product type. The attribute name, attribute type, input type, and data type are required. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute used to describe customers or orders. + /// Properties of the new product attribute to create. /// /// /// @@ -188,50 +109,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Attribute AddAttribute(Mozu.Api.C /// var attribute = await attribute.AddAttributeAsync( attribute, responseFields); /// /// - public virtual async Task AddAttributeAsync(Mozu.Api.Contracts.ProductAdmin.Attribute attribute, string responseFields = null) + public virtual async Task AddAttributeAsync(Mozu.Api.Contracts.ProductAdmin.Attribute attribute, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.AddAttributeClient( attribute, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates an existing attribute with attribute properties to set. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// {} - /// Properties of an attribute used to describe customers or orders. - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// var attribute = attribute.UpdateAttribute( attribute, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Attribute UpdateAttribute(Mozu.Api.Contracts.ProductAdmin.Attribute attribute, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.UpdateAttributeClient( attribute, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates an existing attribute with attribute properties to set. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// {} - /// Properties of an attribute used to describe customers or orders. + /// Any properties of the attribute that to update. /// /// /// @@ -241,44 +136,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Attribute UpdateAttribute(Mozu.Ap /// var attribute = await attribute.UpdateAttributeAsync( attribute, attributeFQN, responseFields); /// /// - public virtual async Task UpdateAttributeAsync(Mozu.Api.Contracts.ProductAdmin.Attribute attribute, string attributeFQN, string responseFields = null) + public virtual async Task UpdateAttributeAsync(Mozu.Api.Contracts.ProductAdmin.Attribute attribute, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.UpdateAttributeClient( attribute, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a defined product attribute. You cannot delete an attribute assigned a value for a product. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// {} - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// attribute.DeleteAttribute( attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteAttribute(string attributeFQN) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.DeleteAttributeClient( attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a defined product attribute. You cannot delete an attribute assigned a value for a product. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// {} /// /// @@ -289,12 +161,12 @@ public virtual void DeleteAttribute(string attributeFQN) /// await attribute.DeleteAttributeAsync( attributeFQN); /// /// - public virtual async Task DeleteAttributeAsync(string attributeFQN) + public virtual async Task DeleteAttributeAsync(string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.AttributeClient.DeleteAttributeClient( attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentResource.cs old mode 100644 new mode 100755 index dd19032d..a96e0eb0 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Attributedefinition.Attributes { /// - /// Properties of localized content for attributes, based on a `localeCode` at a site/tenant level. This content supports translated text for product, product options, and additional objects. + /// /// public partial class AttributeLocalizedContentResource { /// @@ -37,35 +38,11 @@ public AttributeLocalizedContentResource CloneWithApiContext(Action } - /// - /// Retrieves a collection of localized content for attributes based on a `localeCode`. - /// - /// Fully qualified name for an attribute. - /// {} - /// - /// List{} - /// - /// - /// - /// var attributelocalizedcontent = new AttributeLocalizedContent(); - /// var attributeLocalizedContent = attributelocalizedcontent.GetAttributeLocalizedContents( attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAttributeLocalizedContents(string attributeFQN) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.GetAttributeLocalizedContentsClient( attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of localized content for attributes based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. + /// /// {} /// /// List{} @@ -76,49 +53,23 @@ public AttributeLocalizedContentResource CloneWithApiContext(Action /// var attributeLocalizedContent = await attributelocalizedcontent.GetAttributeLocalizedContentsAsync( attributeFQN); /// /// - public virtual async Task> GetAttributeLocalizedContentsAsync(string attributeFQN) + public virtual async Task> GetAttributeLocalizedContentsAsync(string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.GetAttributeLocalizedContentsClient( attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the localized content for an attribute based on a `localeCode`. - /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. - /// {} - /// - /// - /// - /// - /// - /// var attributelocalizedcontent = new AttributeLocalizedContent(); - /// var attributeLocalizedContent = attributelocalizedcontent.GetAttributeLocalizedContent( attributeFQN, localeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent GetAttributeLocalizedContent(string attributeFQN, string localeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.GetAttributeLocalizedContentClient( attributeFQN, localeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the localized content for an attribute based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// {} /// /// @@ -129,50 +80,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent GetAttr /// var attributeLocalizedContent = await attributelocalizedcontent.GetAttributeLocalizedContentAsync( attributeFQN, localeCode, responseFields); /// /// - public virtual async Task GetAttributeLocalizedContentAsync(string attributeFQN, string localeCode, string responseFields = null) + public virtual async Task GetAttributeLocalizedContentAsync(string attributeFQN, string localeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.GetAttributeLocalizedContentClient( attributeFQN, localeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds new localized content for an attribute based on a `localeCode`. - /// - /// Fully qualified name for an attribute. - /// Use this field to include those fields which are not included by default. - /// {} - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. - /// - /// - /// - /// - /// - /// var attributelocalizedcontent = new AttributeLocalizedContent(); - /// var attributeLocalizedContent = attributelocalizedcontent.AddLocalizedContent( localizedContent, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent AddLocalizedContent(Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent localizedContent, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.AddLocalizedContentClient( localizedContent, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds new localized content for an attribute based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Use this field to include those fields which are not included by default. + /// + /// /// {} - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. + /// /// /// /// @@ -182,48 +107,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent AddLoca /// var attributeLocalizedContent = await attributelocalizedcontent.AddLocalizedContentAsync( localizedContent, attributeFQN, responseFields); /// /// - public virtual async Task AddLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent localizedContent, string attributeFQN, string responseFields = null) + public virtual async Task AddLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent localizedContent, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.AddLocalizedContentClient( localizedContent, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the localized content for a collection of existing attributes based on a `localeCode`. - /// - /// Fully qualified name for an attribute. - /// {} - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. - /// - /// List{} - /// - /// - /// - /// var attributelocalizedcontent = new AttributeLocalizedContent(); - /// var attributeLocalizedContent = attributelocalizedcontent.UpdateLocalizedContents( localizedContent, attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateLocalizedContents(List localizedContent, string attributeFQN) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.UpdateLocalizedContentsClient( localizedContent, attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the localized content for a collection of existing attributes based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. + /// /// {} - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. + /// /// /// List{} /// @@ -233,52 +133,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent AddLoca /// var attributeLocalizedContent = await attributelocalizedcontent.UpdateLocalizedContentsAsync( localizedContent, attributeFQN); /// /// - public virtual async Task> UpdateLocalizedContentsAsync(List localizedContent, string attributeFQN) + public virtual async Task> UpdateLocalizedContentsAsync(List localizedContent, string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.UpdateLocalizedContentsClient( localizedContent, attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the localized content for an existing attribute based on a `localeCode`. - /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. - /// {} - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. - /// - /// - /// - /// - /// - /// var attributelocalizedcontent = new AttributeLocalizedContent(); - /// var attributeLocalizedContent = attributelocalizedcontent.UpdateLocalizedContent( localizedContent, attributeFQN, localeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent UpdateLocalizedContent(Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent localizedContent, string attributeFQN, string localeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.UpdateLocalizedContentClient( localizedContent, attributeFQN, localeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the localized content for an existing attribute based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// {} - /// The localized name and description of the attribute, displayed in the locale defined for the master catalog. + /// /// /// /// @@ -288,46 +161,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent UpdateL /// var attributeLocalizedContent = await attributelocalizedcontent.UpdateLocalizedContentAsync( localizedContent, attributeFQN, localeCode, responseFields); /// /// - public virtual async Task UpdateLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent localizedContent, string attributeFQN, string localeCode, string responseFields = null) + public virtual async Task UpdateLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.AttributeLocalizedContent localizedContent, string attributeFQN, string localeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.UpdateLocalizedContentClient( localizedContent, attributeFQN, localeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes all localized content. Localized content is translated text information and data based on a `localeCode`. - /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// {} - /// - /// - /// - /// - /// - /// var attributelocalizedcontent = new AttributeLocalizedContent(); - /// attributelocalizedcontent.DeleteLocalizedContent( attributeFQN, localeCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteLocalizedContent(string attributeFQN, string localeCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.DeleteLocalizedContentClient( attributeFQN, localeCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes all localized content. Localized content is translated text information and data based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. + /// + /// /// {} /// /// @@ -338,12 +187,12 @@ public virtual void DeleteLocalizedContent(string attributeFQN, string localeCod /// await attributelocalizedcontent.DeleteLocalizedContentAsync( attributeFQN, localeCode); /// /// - public virtual async Task DeleteLocalizedContentAsync(string attributeFQN, string localeCode) + public virtual async Task DeleteLocalizedContentAsync(string attributeFQN, string localeCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeLocalizedContentClient.DeleteLocalizedContentClient( attributeFQN, localeCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleResource.cs old mode 100644 new mode 100755 index 08fa1367..40294844 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Attributedefinition.Attributes { @@ -37,41 +38,13 @@ public AttributeTypeRuleResource CloneWithApiContext(Action context } - /// - /// 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. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// - /// - /// {} - /// - /// - /// - /// - /// - /// var attributetyperule = new AttributeTypeRule(); - /// var attributeTypeRuleCollection = attributetyperule.GetAttributeTypeRules( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeTypeRuleCollection GetAttributeTypeRules(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeTypeRuleClient.GetAttributeTypeRulesClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// 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. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// {} @@ -84,12 +57,12 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeTypeRuleCollection GetAt /// var attributeTypeRuleCollection = await attributetyperule.GetAttributeTypeRulesAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAttributeTypeRulesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAttributeTypeRulesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeTypeRuleClient.GetAttributeTypeRulesClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueResource.cs old mode 100644 new mode 100755 index 7914a3b9..093b68ad --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Attributedefinition.Attributes { @@ -37,35 +38,11 @@ public AttributeVocabularyValueResource CloneWithApiContext(Action } - /// - /// Retrieves a list of vocabulary values defined for the attribute specified in the request. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// {} - /// - /// List{} - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValue = attributevocabularyvalue.GetAttributeVocabularyValues( attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAttributeVocabularyValues(string attributeFQN) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.GetAttributeVocabularyValuesClient( attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of vocabulary values defined for the attribute specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// {} /// /// List{} @@ -76,47 +53,22 @@ public AttributeVocabularyValueResource CloneWithApiContext(Action /// var attributeVocabularyValue = await attributevocabularyvalue.GetAttributeVocabularyValuesAsync( attributeFQN); /// /// - public virtual async Task> GetAttributeVocabularyValuesAsync(string attributeFQN) + public virtual async Task> GetAttributeVocabularyValuesAsync(string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.GetAttributeVocabularyValuesClient( attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of localized content for vocabulary value attributes based on a `localeCode`. - /// - /// Fully qualified name for an attribute. - /// The value string to create. - /// {} - /// - /// List{} - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValueLocalizedContent = attributevocabularyvalue.GetAttributeVocabularyValueLocalizedContents( attributeFQN, value); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAttributeVocabularyValueLocalizedContents(string attributeFQN, string value) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.GetAttributeVocabularyValueLocalizedContentsClient( attributeFQN, value); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of localized content for vocabulary value attributes based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// The value string to create. + /// + /// /// {} /// /// List{} @@ -127,51 +79,24 @@ public AttributeVocabularyValueResource CloneWithApiContext(Action /// var attributeVocabularyValueLocalizedContent = await attributevocabularyvalue.GetAttributeVocabularyValueLocalizedContentsAsync( attributeFQN, value); /// /// - public virtual async Task> GetAttributeVocabularyValueLocalizedContentsAsync(string attributeFQN, string value) + public virtual async Task> GetAttributeVocabularyValueLocalizedContentsAsync(string attributeFQN, string value, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.GetAttributeVocabularyValueLocalizedContentsClient( attributeFQN, value); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the localized content for a vocabulary value attribute based on a `localeCode`. - /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// {} - /// - /// - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValueLocalizedContent = attributevocabularyvalue.GetAttributeVocabularyValueLocalizedContent( attributeFQN, value, localeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedContent GetAttributeVocabularyValueLocalizedContent(string attributeFQN, string value, string localeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.GetAttributeVocabularyValueLocalizedContentClient( attributeFQN, value, localeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the localized content for a vocabulary value attribute based on a `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// /// {} /// /// @@ -182,49 +107,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalized /// var attributeVocabularyValueLocalizedContent = await attributevocabularyvalue.GetAttributeVocabularyValueLocalizedContentAsync( attributeFQN, value, localeCode, responseFields); /// /// - public virtual async Task GetAttributeVocabularyValueLocalizedContentAsync(string attributeFQN, string value, string localeCode, string responseFields = null) + public virtual async Task GetAttributeVocabularyValueLocalizedContentAsync(string attributeFQN, string value, string localeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.GetAttributeVocabularyValueLocalizedContentClient( attributeFQN, value, localeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a vocabulary value defined for an attribute by providing the attribute's fully qualified name and the value to retrieve. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// {} - /// - /// - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValue = attributevocabularyvalue.GetAttributeVocabularyValue( attributeFQN, value, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue GetAttributeVocabularyValue(string attributeFQN, string value, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.GetAttributeVocabularyValueClient( attributeFQN, value, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a vocabulary value defined for an attribute by providing the attribute's fully qualified name and the value to retrieve. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// The actual unique value of the attribute vocabulary to retrieve. A single attribute must have a unique value and match the attribute's data type. If a string value returns null, the system will generate a value. The actual string content displayed shoud be stored as "Content" and actual content is required for string values. /// {} /// /// @@ -235,52 +134,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue GetAttri /// var attributeVocabularyValue = await attributevocabularyvalue.GetAttributeVocabularyValueAsync( attributeFQN, value, responseFields); /// /// - public virtual async Task GetAttributeVocabularyValueAsync(string attributeFQN, string value, string responseFields = null) + public virtual async Task GetAttributeVocabularyValueAsync(string attributeFQN, string value, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.GetAttributeVocabularyValueClient( attributeFQN, value, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates and saves localized vocabulary value content for an attribute, based on the `localeCode`. - /// - /// Fully qualified name for an attribute. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// {} - /// The localized text for the string value of a product attribute. - /// - /// - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValueLocalizedContent = attributevocabularyvalue.AddAttributeVocabularyValueLocalizedContent( localizedContent, attributeFQN, value, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedContent AddAttributeVocabularyValueLocalizedContent(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedContent localizedContent, string attributeFQN, string value, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.AddAttributeVocabularyValueLocalizedContentClient( localizedContent, attributeFQN, value, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates and saves localized vocabulary value content for an attribute, based on the `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// /// {} - /// The localized text for the string value of a product attribute. + /// /// /// /// @@ -290,50 +162,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalized /// var attributeVocabularyValueLocalizedContent = await attributevocabularyvalue.AddAttributeVocabularyValueLocalizedContentAsync( localizedContent, attributeFQN, value, responseFields); /// /// - public virtual async Task AddAttributeVocabularyValueLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedContent localizedContent, string attributeFQN, string value, string responseFields = null) + public virtual async Task AddAttributeVocabularyValueLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedContent localizedContent, string attributeFQN, string value, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.AddAttributeVocabularyValueLocalizedContentClient( localizedContent, attributeFQN, value, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a vocabulary value for a defined product attribute. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// {} - /// Properties of a vocabulary value defined for an extensible attribute. - /// - /// - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValue = attributevocabularyvalue.AddAttributeVocabularyValue( attributeVocabularyValue, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttributeVocabularyValue(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue attributeVocabularyValue, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.AddAttributeVocabularyValueClient( attributeVocabularyValue, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a vocabulary value for a defined product attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// {} - /// Properties of a vocabulary value defined for an extensible attribute. + /// The predefined vocabulary value to add to the attribute content. /// /// /// @@ -343,48 +189,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttri /// var attributeVocabularyValue = await attributevocabularyvalue.AddAttributeVocabularyValueAsync( attributeVocabularyValue, attributeFQN, responseFields); /// /// - public virtual async Task AddAttributeVocabularyValueAsync(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue attributeVocabularyValue, string attributeFQN, string responseFields = null) + public virtual async Task AddAttributeVocabularyValueAsync(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue attributeVocabularyValue, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.AddAttributeVocabularyValueClient( attributeVocabularyValue, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update existing vocabulary values for an attribute. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// {} - /// Properties of a vocabulary value defined for an extensible attribute. - /// - /// List{} - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValue = attributevocabularyvalue.UpdateAttributeVocabularyValues( vocabularyValues, attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateAttributeVocabularyValues(List vocabularyValues, string attributeFQN) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.UpdateAttributeVocabularyValuesClient( vocabularyValues, attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update existing vocabulary values for an attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// {} - /// Properties of a vocabulary value defined for an extensible attribute. + /// The actual vocabulary values for the attribute being updated. /// /// List{} /// @@ -394,50 +215,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttri /// var attributeVocabularyValue = await attributevocabularyvalue.UpdateAttributeVocabularyValuesAsync( vocabularyValues, attributeFQN); /// /// - public virtual async Task> UpdateAttributeVocabularyValuesAsync(List vocabularyValues, string attributeFQN) + public virtual async Task> UpdateAttributeVocabularyValuesAsync(List vocabularyValues, string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.UpdateAttributeVocabularyValuesClient( vocabularyValues, attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a collection of localized vocabulary value content for existing attributes, based on the `localeCode`. - /// - /// Fully qualified name for an attribute. - /// The value string to create. - /// {} - /// The localized text for the string value of a product attribute. - /// - /// List{} - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValueLocalizedContent = attributevocabularyvalue.UpdateAttributeVocabularyValueLocalizedContents( localizedContent, attributeFQN, value); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateAttributeVocabularyValueLocalizedContents(List localizedContent, string attributeFQN, string value) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.UpdateAttributeVocabularyValueLocalizedContentsClient( localizedContent, attributeFQN, value); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a collection of localized vocabulary value content for existing attributes, based on the `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// The value string to create. + /// + /// /// {} - /// The localized text for the string value of a product attribute. + /// /// /// List{} /// @@ -447,54 +242,26 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue AddAttri /// var attributeVocabularyValueLocalizedContent = await attributevocabularyvalue.UpdateAttributeVocabularyValueLocalizedContentsAsync( localizedContent, attributeFQN, value); /// /// - public virtual async Task> UpdateAttributeVocabularyValueLocalizedContentsAsync(List localizedContent, string attributeFQN, string value) + public virtual async Task> UpdateAttributeVocabularyValueLocalizedContentsAsync(List localizedContent, string attributeFQN, string value, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.UpdateAttributeVocabularyValueLocalizedContentsClient( localizedContent, attributeFQN, value); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates localized vocabulary value content for an existing attribute, based on the `localeCode`. - /// - /// Fully qualified name for an attribute. - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// {} - /// The localized text for the string value of a product attribute. - /// - /// - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValueLocalizedContent = attributevocabularyvalue.UpdateAttributeVocabularyValueLocalizedContent( localizedContent, attributeFQN, value, localeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedContent UpdateAttributeVocabularyValueLocalizedContent(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedContent localizedContent, string attributeFQN, string value, string localeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.UpdateAttributeVocabularyValueLocalizedContentClient( localizedContent, attributeFQN, value, localeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates localized vocabulary value content for an existing attribute, based on the `localeCode`. + /// /// - /// Fully qualified name for an attribute. - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// /// {} - /// The localized text for the string value of a product attribute. + /// /// /// /// @@ -504,52 +271,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalized /// var attributeVocabularyValueLocalizedContent = await attributevocabularyvalue.UpdateAttributeVocabularyValueLocalizedContentAsync( localizedContent, attributeFQN, value, localeCode, responseFields); /// /// - public virtual async Task UpdateAttributeVocabularyValueLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedContent localizedContent, string attributeFQN, string value, string localeCode, string responseFields = null) + public virtual async Task UpdateAttributeVocabularyValueLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValueLocalizedContent localizedContent, string attributeFQN, string value, string localeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.UpdateAttributeVocabularyValueLocalizedContentClient( localizedContent, attributeFQN, value, localeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates existing attribute vocabulary values. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// {} - /// Properties of a vocabulary value defined for an extensible attribute. - /// - /// - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// var attributeVocabularyValue = attributevocabularyvalue.UpdateAttributeVocabularyValue( attributeVocabularyValue, attributeFQN, value, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue UpdateAttributeVocabularyValue(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue attributeVocabularyValue, string attributeFQN, string value, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.UpdateAttributeVocabularyValueClient( attributeVocabularyValue, attributeFQN, value, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates existing attribute vocabulary values. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// The actual unique value of the attribute vocabulary value to update. A single attribute must have a unique value and match the attribute's data type. If a string value returns null, the system will generate a value. The actual string content displayed shoud be stored as "Content" and actual content is required for string values. /// {} - /// Properties of a vocabulary value defined for an extensible attribute. + /// The predefined vocabulary value to add to the attribute content to update. /// /// /// @@ -559,46 +299,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue UpdateAt /// var attributeVocabularyValue = await attributevocabularyvalue.UpdateAttributeVocabularyValueAsync( attributeVocabularyValue, attributeFQN, value, responseFields); /// /// - public virtual async Task UpdateAttributeVocabularyValueAsync(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue attributeVocabularyValue, string attributeFQN, string value, string responseFields = null) + public virtual async Task UpdateAttributeVocabularyValueAsync(Mozu.Api.Contracts.ProductAdmin.AttributeVocabularyValue attributeVocabularyValue, string attributeFQN, string value, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.UpdateAttributeVocabularyValueClient( attributeVocabularyValue, attributeFQN, value, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes an attribute's vocabulary value. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The value string to create. - /// {} - /// - /// - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// attributevocabularyvalue.DeleteAttributeVocabularyValue( attributeFQN, value); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteAttributeVocabularyValue(string attributeFQN, string value) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.DeleteAttributeVocabularyValueClient( attributeFQN, value); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes an attribute's vocabulary value. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The value string to create. + /// + /// The actual unique value of the attribute vocabulary to delete. A single attribute must have a unique value and match the attribute's data type. If a string value returns null, the system will generate a value. The actual string content displayed shoud be stored as "Content" and actual content is required for string values. /// {} /// /// @@ -609,47 +325,22 @@ public virtual void DeleteAttributeVocabularyValue(string attributeFQN, string v /// await attributevocabularyvalue.DeleteAttributeVocabularyValueAsync( attributeFQN, value); /// /// - public virtual async Task DeleteAttributeVocabularyValueAsync(string attributeFQN, string value) + public virtual async Task DeleteAttributeVocabularyValueAsync(string attributeFQN, string value, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.DeleteAttributeVocabularyValueClient( attributeFQN, value); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Removes localized content for a vocabulary value attribute. - /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The value string to create. - /// {} - /// - /// - /// - /// - /// - /// var attributevocabularyvalue = new AttributeVocabularyValue(); - /// attributevocabularyvalue.DeleteAttributeVocabularyValueLocalizedContent( attributeFQN, value, localeCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteAttributeVocabularyValueLocalizedContent(string attributeFQN, string value, string localeCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.DeleteAttributeVocabularyValueLocalizedContentClient( attributeFQN, value, localeCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes localized content for a vocabulary value attribute. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The value string to create. + /// + /// + /// /// {} /// /// @@ -660,12 +351,12 @@ public virtual void DeleteAttributeVocabularyValueLocalizedContent(string attrib /// await attributevocabularyvalue.DeleteAttributeVocabularyValueLocalizedContentAsync( attributeFQN, value, localeCode); /// /// - public virtual async Task DeleteAttributeVocabularyValueLocalizedContentAsync(string attributeFQN, string value, string localeCode) + public virtual async Task DeleteAttributeVocabularyValueLocalizedContentAsync(string attributeFQN, string value, string localeCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Attributes.AttributeVocabularyValueClient.DeleteAttributeVocabularyValueLocalizedContentClient( attributeFQN, value, localeCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/ProductTypeResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/ProductTypeResource.cs old mode 100644 new mode 100755 index 7b739647..6f9249bb --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/ProductTypeResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/ProductTypeResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Attributedefinition { @@ -44,41 +45,13 @@ public ProductTypeResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of product types according to any specified filter criteria and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// - /// - /// {} - /// - /// - /// - /// - /// - /// var producttype = new ProductType(); - /// var productTypeCollection = producttype.GetProductTypes(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductTypeCollection GetProductTypes(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.GetProductTypesClient(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of product types according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product type search results by any of its properties. 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=Name+cont+shoes" + /// + /// /// /// /// {} @@ -91,47 +64,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductTypeCollection GetProductT /// var productTypeCollection = await producttype.GetProductTypesAsync(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetProductTypesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetProductTypesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.GetProductTypesClient(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the product type specified in the request. - /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// - /// - /// - /// - /// - /// var producttype = new ProductType(); - /// var productType = producttype.GetProductType(_dataViewMode, productTypeId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductType GetProductType(int productTypeId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.GetProductTypeClient(_dataViewMode, productTypeId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the product type specified in the request. + /// /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// Identifier of the product type to retrieve. + /// /// {} /// /// @@ -142,48 +90,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductType GetProductType(int pr /// var productType = await producttype.GetProductTypeAsync(_dataViewMode, productTypeId, responseFields); /// /// - public virtual async Task GetProductTypeAsync(int productTypeId, string responseFields = null) + public virtual async Task GetProductTypeAsync(int productTypeId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.GetProductTypeClient(_dataViewMode, productTypeId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new product type based on the information supplied in the request. - /// - /// Use this field to include those fields which are not included by default. - /// {} - /// A product type is like a product template. - /// - /// - /// - /// - /// - /// var producttype = new ProductType(); - /// var productType = producttype.AddProductType(_dataViewMode, productType, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductType AddProductType(Mozu.Api.Contracts.ProductAdmin.ProductType productType, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.AddProductTypeClient(_dataViewMode, productType, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new product type based on the information supplied in the request. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// {} - /// A product type is like a product template. + /// Properties of the product type to create. /// /// /// @@ -193,50 +116,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductType AddProductType(Mozu.A /// var productType = await producttype.AddProductTypeAsync(_dataViewMode, productType, responseFields); /// /// - public virtual async Task AddProductTypeAsync(Mozu.Api.Contracts.ProductAdmin.ProductType productType, string responseFields = null) + public virtual async Task AddProductTypeAsync(Mozu.Api.Contracts.ProductAdmin.ProductType productType, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.AddProductTypeClient(_dataViewMode, productType, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of a product type. - /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// A product type is like a product template. - /// - /// - /// - /// - /// - /// var producttype = new ProductType(); - /// var productType = producttype.UpdateProductType(_dataViewMode, productType, productTypeId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductType UpdateProductType(Mozu.Api.Contracts.ProductAdmin.ProductType productType, int productTypeId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.UpdateProductTypeClient(_dataViewMode, productType, productTypeId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a product type. + /// /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// Identifier of the product type to update. + /// /// {} - /// A product type is like a product template. + /// The details of the product type to update. /// /// /// @@ -246,44 +143,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductType UpdateProductType(Moz /// var productType = await producttype.UpdateProductTypeAsync(_dataViewMode, productType, productTypeId, responseFields); /// /// - public virtual async Task UpdateProductTypeAsync(Mozu.Api.Contracts.ProductAdmin.ProductType productType, int productTypeId, string responseFields = null) + public virtual async Task UpdateProductTypeAsync(Mozu.Api.Contracts.ProductAdmin.ProductType productType, int productTypeId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.UpdateProductTypeClient(_dataViewMode, productType, productTypeId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the product type by providing the product type ID. - /// - /// Identifier of the product type. - /// {} - /// - /// - /// - /// - /// - /// var producttype = new ProductType(); - /// producttype.DeleteProductType(_dataViewMode, productTypeId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProductType(int productTypeId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.DeleteProductTypeClient(_dataViewMode, productTypeId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the product type by providing the product type ID. + /// /// - /// Identifier of the product type. + /// Identifier of the product type to delete. /// {} /// /// @@ -294,12 +168,12 @@ public virtual void DeleteProductType(int productTypeId) /// await producttype.DeleteProductTypeAsync(_dataViewMode, productTypeId); /// /// - public virtual async Task DeleteProductTypeAsync(int productTypeId) + public virtual async Task DeleteProductTypeAsync(int productTypeId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.ProductTypeClient.DeleteProductTypeClient(_dataViewMode, productTypeId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraResource.cs old mode 100644 new mode 100755 index 8c10af51..8f6f25f3 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Attributedefinition.Producttypes { @@ -44,33 +45,9 @@ public ProductTypeExtraResource(IApiContext apiContext, DataViewMode dataViewMod _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of extra attributes defined for the specified product type. - /// - /// Identifier of the product type. - /// {} - /// - /// List{} - /// - /// - /// - /// var producttypeextra = new ProductTypeExtra(); - /// var attributeInProductType = producttypeextra.GetExtras(_dataViewMode, productTypeId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetExtras(int productTypeId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.GetExtrasClient(_dataViewMode, productTypeId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of extra attributes defined for the specified product type. + /// /// /// Identifier of the product type. /// {} @@ -83,49 +60,23 @@ public ProductTypeExtraResource(IApiContext apiContext, DataViewMode dataViewMod /// var attributeInProductType = await producttypeextra.GetExtrasAsync(_dataViewMode, productTypeId); /// /// - public virtual async Task> GetExtrasAsync(int productTypeId) + public virtual async Task> GetExtrasAsync(int productTypeId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.GetExtrasClient(_dataViewMode, productTypeId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of an extra attribute definition for the specified product type. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// - /// - /// - /// - /// - /// var producttypeextra = new ProductTypeExtra(); - /// var attributeInProductType = producttypeextra.GetExtra(_dataViewMode, productTypeId, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetExtra(int productTypeId, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.GetExtraClient(_dataViewMode, productTypeId, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of an extra attribute definition for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// + /// Identifier of the product type whose extra is being retrieved. + /// /// {} /// /// @@ -136,50 +87,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetExtra(i /// var attributeInProductType = await producttypeextra.GetExtraAsync(_dataViewMode, productTypeId, attributeFQN, responseFields); /// /// - public virtual async Task GetExtraAsync(int productTypeId, string attributeFQN, string responseFields = null) + public virtual async Task GetExtraAsync(int productTypeId, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.GetExtraClient(_dataViewMode, productTypeId, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Assigns a defined extra attribute to the product type based on the information supplied in the request. - /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. - /// - /// - /// - /// - /// - /// var producttypeextra = new ProductTypeExtra(); - /// var attributeInProductType = producttypeextra.AddExtra(_dataViewMode, attributeInProductType, productTypeId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddExtra(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.AddExtraClient(_dataViewMode, attributeInProductType, productTypeId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Assigns a defined extra attribute to the product type based on the information supplied in the request. + /// /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// The properties of the extra attribute definition for this product type assignment. /// /// /// @@ -189,52 +114,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddExtra(M /// var attributeInProductType = await producttypeextra.AddExtraAsync(_dataViewMode, attributeInProductType, productTypeId, responseFields); /// /// - public virtual async Task AddExtraAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string responseFields = null) + public virtual async Task AddExtraAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.AddExtraClient(_dataViewMode, attributeInProductType, productTypeId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update the definition of an extra attribute for the specified product type. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. - /// - /// - /// - /// - /// - /// var producttypeextra = new ProductTypeExtra(); - /// var attributeInProductType = producttypeextra.UpdateExtra(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateExtra(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.UpdateExtraClient(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update the definition of an extra attribute for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// The properties of the extra attribute definition to update for the product type. /// /// /// @@ -244,45 +142,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateExtr /// var attributeInProductType = await producttypeextra.UpdateExtraAsync(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); /// /// - public virtual async Task UpdateExtraAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string attributeFQN, string responseFields = null) + public virtual async Task UpdateExtraAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.UpdateExtraClient(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes an extra attribute definition from the specified product type. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// {} - /// - /// - /// - /// - /// - /// var producttypeextra = new ProductTypeExtra(); - /// producttypeextra.DeleteExtra(_dataViewMode, productTypeId, attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteExtra(int productTypeId, string attributeFQN) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.DeleteExtraClient(_dataViewMode, productTypeId, attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes an extra attribute definition from the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. /// {} /// @@ -294,12 +168,12 @@ public virtual void DeleteExtra(int productTypeId, string attributeFQN) /// await producttypeextra.DeleteExtraAsync(_dataViewMode, productTypeId, attributeFQN); /// /// - public virtual async Task DeleteExtraAsync(int productTypeId, string attributeFQN) + public virtual async Task DeleteExtraAsync(int productTypeId, string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeExtraClient.DeleteExtraClient(_dataViewMode, productTypeId, attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionResource.cs old mode 100644 new mode 100755 index 41488d7b..10de18dd --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Attributedefinition.Producttypes { @@ -44,35 +45,11 @@ public ProductTypeOptionResource(IApiContext apiContext, DataViewMode dataViewMo _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of option product attributes defined for the specified product type. - /// - /// Identifier of the product type. - /// {} - /// - /// List{} - /// - /// - /// - /// var producttypeoption = new ProductTypeOption(); - /// var attributeInProductType = producttypeoption.GetOptions(_dataViewMode, productTypeId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetOptions(int productTypeId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.GetOptionsClient(_dataViewMode, productTypeId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of option product attributes defined for the specified product type. + /// /// - /// Identifier of the product type. + /// Identifier of the product type to retrieve. /// {} /// /// List{} @@ -83,49 +60,23 @@ public ProductTypeOptionResource(IApiContext apiContext, DataViewMode dataViewMo /// var attributeInProductType = await producttypeoption.GetOptionsAsync(_dataViewMode, productTypeId); /// /// - public virtual async Task> GetOptionsAsync(int productTypeId) + public virtual async Task> GetOptionsAsync(int productTypeId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.GetOptionsClient(_dataViewMode, productTypeId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of an option attribute defined for the specified product type. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// - /// - /// - /// - /// - /// var producttypeoption = new ProductTypeOption(); - /// var attributeInProductType = producttypeoption.GetOption(_dataViewMode, productTypeId, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetOption(int productTypeId, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.GetOptionClient(_dataViewMode, productTypeId, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of an option attribute defined for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// + /// The identifier of the product type. + /// /// {} /// /// @@ -136,50 +87,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetOption( /// var attributeInProductType = await producttypeoption.GetOptionAsync(_dataViewMode, productTypeId, attributeFQN, responseFields); /// /// - public virtual async Task GetOptionAsync(int productTypeId, string attributeFQN, string responseFields = null) + public virtual async Task GetOptionAsync(int productTypeId, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.GetOptionClient(_dataViewMode, productTypeId, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Assigns an option attribute to the product type based on the information supplied in the request. - /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. - /// - /// - /// - /// - /// - /// var producttypeoption = new ProductTypeOption(); - /// var attributeInProductType = producttypeoption.AddOption(_dataViewMode, attributeInProductType, productTypeId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddOption(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.AddOptionClient(_dataViewMode, attributeInProductType, productTypeId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Assigns an option attribute to the product type based on the information supplied in the request. + /// /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// Properties of the option attribute to define for the specified product type. /// /// /// @@ -189,52 +114,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddOption( /// var attributeInProductType = await producttypeoption.AddOptionAsync(_dataViewMode, attributeInProductType, productTypeId, responseFields); /// /// - public virtual async Task AddOptionAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string responseFields = null) + public virtual async Task AddOptionAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.AddOptionClient(_dataViewMode, attributeInProductType, productTypeId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates an option attribute definition for the specified product type. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. - /// - /// - /// - /// - /// - /// var producttypeoption = new ProductTypeOption(); - /// var attributeInProductType = producttypeoption.UpdateOption(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateOption(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.UpdateOptionClient(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates an option attribute definition for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// Properties of the option product attribute to define for the specified product type. /// /// /// @@ -244,45 +142,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateOpti /// var attributeInProductType = await producttypeoption.UpdateOptionAsync(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); /// /// - public virtual async Task UpdateOptionAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string attributeFQN, string responseFields = null) + public virtual async Task UpdateOptionAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.UpdateOptionClient(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes an option attribute definition for the specified product type. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// {} - /// - /// - /// - /// - /// - /// var producttypeoption = new ProductTypeOption(); - /// producttypeoption.DeleteOption(_dataViewMode, productTypeId, attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteOption(int productTypeId, string attributeFQN) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.DeleteOptionClient(_dataViewMode, productTypeId, attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes an option attribute definition for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. /// {} /// @@ -294,12 +168,12 @@ public virtual void DeleteOption(int productTypeId, string attributeFQN) /// await producttypeoption.DeleteOptionAsync(_dataViewMode, productTypeId, attributeFQN); /// /// - public virtual async Task DeleteOptionAsync(int productTypeId, string attributeFQN) + public virtual async Task DeleteOptionAsync(int productTypeId, string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeOptionClient.DeleteOptionClient(_dataViewMode, productTypeId, attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyResource.cs old mode 100644 new mode 100755 index 16e9d3b1..659f09ff --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Attributedefinition.Producttypes { @@ -44,33 +45,9 @@ public ProductTypePropertyResource(IApiContext apiContext, DataViewMode dataView _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of product property attributes defined for a product type. - /// - /// Identifier of the product type. - /// {} - /// - /// List{} - /// - /// - /// - /// var producttypeproperty = new ProductTypeProperty(); - /// var attributeInProductType = producttypeproperty.GetProperties(_dataViewMode, productTypeId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetProperties(int productTypeId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.GetPropertiesClient(_dataViewMode, productTypeId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of product property attributes defined for a product type. + /// /// /// Identifier of the product type. /// {} @@ -83,49 +60,23 @@ public ProductTypePropertyResource(IApiContext apiContext, DataViewMode dataView /// var attributeInProductType = await producttypeproperty.GetPropertiesAsync(_dataViewMode, productTypeId); /// /// - public virtual async Task> GetPropertiesAsync(int productTypeId) + public virtual async Task> GetPropertiesAsync(int productTypeId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.GetPropertiesClient(_dataViewMode, productTypeId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a product property attribute definition for the specified product type. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// - /// - /// - /// - /// - /// var producttypeproperty = new ProductTypeProperty(); - /// var attributeInProductType = producttypeproperty.GetProperty(_dataViewMode, productTypeId, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetProperty(int productTypeId, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.GetPropertyClient(_dataViewMode, productTypeId, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a product property attribute definition for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} /// /// @@ -136,50 +87,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType GetPropert /// var attributeInProductType = await producttypeproperty.GetPropertyAsync(_dataViewMode, productTypeId, attributeFQN, responseFields); /// /// - public virtual async Task GetPropertyAsync(int productTypeId, string attributeFQN, string responseFields = null) + public virtual async Task GetPropertyAsync(int productTypeId, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.GetPropertyClient(_dataViewMode, productTypeId, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Assigns a property attribute to the specified product type, according to the information defined in the request. - /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. - /// - /// - /// - /// - /// - /// var producttypeproperty = new ProductTypeProperty(); - /// var attributeInProductType = producttypeproperty.AddProperty(_dataViewMode, attributeInProductType, productTypeId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddProperty(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.AddPropertyClient(_dataViewMode, attributeInProductType, productTypeId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Assigns a property attribute to the specified product type, according to the information defined in the request. + /// /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// Properties of the property attribute to define for the specified product type. /// /// /// @@ -189,52 +114,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType AddPropert /// var attributeInProductType = await producttypeproperty.AddPropertyAsync(_dataViewMode, attributeInProductType, productTypeId, responseFields); /// /// - public virtual async Task AddPropertyAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string responseFields = null) + public virtual async Task AddPropertyAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.AddPropertyClient(_dataViewMode, attributeInProductType, productTypeId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the definition of a property attribute for the specified product type. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. - /// - /// - /// - /// - /// - /// var producttypeproperty = new ProductTypeProperty(); - /// var attributeInProductType = producttypeproperty.UpdateProperty(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateProperty(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.UpdatePropertyClient(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the definition of a property attribute for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// {} - /// Properties of an attribute definition associated with a specific product type. When an attribute is applied to a product type, each product of that type maintains the same set of attributes. + /// Properties of the property attribute to define for the product type. /// /// /// @@ -244,45 +142,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.AttributeInProductType UpdateProp /// var attributeInProductType = await producttypeproperty.UpdatePropertyAsync(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); /// /// - public virtual async Task UpdatePropertyAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string attributeFQN, string responseFields = null) + public virtual async Task UpdatePropertyAsync(Mozu.Api.Contracts.ProductAdmin.AttributeInProductType attributeInProductType, int productTypeId, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.UpdatePropertyClient(_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes a property attribute previously defined for the specified product type. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// {} - /// - /// - /// - /// - /// - /// var producttypeproperty = new ProductTypeProperty(); - /// producttypeproperty.DeleteProperty(_dataViewMode, productTypeId, attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProperty(int productTypeId, string attributeFQN) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.DeletePropertyClient(_dataViewMode, productTypeId, attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes a property attribute previously defined for the specified product type. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. /// {} /// @@ -294,12 +168,12 @@ public virtual void DeleteProperty(int productTypeId, string attributeFQN) /// await producttypeproperty.DeletePropertyAsync(_dataViewMode, productTypeId, attributeFQN); /// /// - public virtual async Task DeletePropertyAsync(int productTypeId, string attributeFQN) + public virtual async Task DeletePropertyAsync(int productTypeId, string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypePropertyClient.DeletePropertyClient(_dataViewMode, productTypeId, attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationResource.cs old mode 100644 new mode 100755 index 68ce05d7..fc0f75f8 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Attributedefinition.Producttypes { @@ -37,50 +38,19 @@ public ProductTypeVariationResource CloneWithApiContext(Action cont } - /// - /// Generates the variations possible for a product associated with the product type based on the option values supplied in the request. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// {} - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. - /// - /// - /// - /// - /// - /// var producttypevariation = new ProductTypeVariation(); - /// var productVariationPagedCollection = producttypevariation.GenerateProductVariations( productOptionsIn, productTypeId, productCode, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationPagedCollection GenerateProductVariations(List productOptionsIn, int productTypeId, string productCode = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeVariationClient.GenerateProductVariationsClient( productOptionsIn, productTypeId, productCode, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Generates the variations possible for a product associated with the product type based on the option values supplied in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. + /// + /// /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// Unique identifier of the product type. + /// + /// + /// /// {} - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. + /// The product option attributes configured for this product type. /// /// /// @@ -90,12 +60,12 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationPagedCollection G /// var productVariationPagedCollection = await producttypevariation.GenerateProductVariationsAsync( productOptionsIn, productTypeId, productCode, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GenerateProductVariationsAsync(List productOptionsIn, int productTypeId, string productCode = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GenerateProductVariationsAsync(List productOptionsIn, int productTypeId, string productCode = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Attributedefinition.Producttypes.ProductTypeVariationClient.GenerateProductVariationsClient( productOptionsIn, productTypeId, productCode, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/CategoryResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/CategoryResource.cs old mode 100644 new mode 100755 index 53556692..6c8ba099 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/CategoryResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/CategoryResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { @@ -44,40 +45,13 @@ public CategoryResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of categories according to any specified filter criteria and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var categoryPagedCollection = category.GetCategories(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.CategoryPagedCollection GetCategories(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.GetCategoriesClient(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of categories according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product category search results by any of its properties, including its position in the category hierarchy. 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" + /// + /// /// /// /// @@ -89,46 +63,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.CategoryPagedCollection GetCatego /// var categoryPagedCollection = await category.GetCategoriesAsync(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetCategoriesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetCategoriesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.GetCategoriesClient(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the list of subcategories within a category. - /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var categoryCollection = category.GetChildCategories( categoryId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.CategoryCollection GetChildCategories(int categoryId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.GetChildCategoriesClient( categoryId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the list of subcategories within a category. + /// /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the category for which to retrieve subcategories. + /// /// /// /// @@ -138,46 +88,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.CategoryCollection GetChildCatego /// var categoryCollection = await category.GetChildCategoriesAsync( categoryId, responseFields); /// /// - public virtual async Task GetChildCategoriesAsync(int categoryId, string responseFields = null) + public virtual async Task GetChildCategoriesAsync(int categoryId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.GetChildCategoriesClient( categoryId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a single category. - /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var category = category.GetCategory(_dataViewMode, categoryId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Category GetCategory(int categoryId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.GetCategoryClient(_dataViewMode, categoryId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a single category. + /// /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the category to retrieve. + /// /// /// /// @@ -187,50 +113,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Category GetCategory(int category /// var category = await category.GetCategoryAsync(_dataViewMode, categoryId, responseFields); /// /// - public virtual async Task GetCategoryAsync(int categoryId, string responseFields = null) + public virtual async Task GetCategoryAsync(int categoryId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.GetCategoryClient(_dataViewMode, categoryId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a new category to the site's category hierarchy.Specify a to determine where to place the category in the hierarchy. If no is specified, the new category is a top-level category. - /// - /// If true, when adding a new product category, set the sequence number of the new category to an increment of one integer greater than the maximum available sequence number across all product categories. If false, set the sequence number to zero. - /// Use this field to include those fields which are not included by default. - /// Optional. If , uses the you specify in the request as the category's id. If , generates an for the category regardless if you specify an id in the request.If you specify an id already in use and set this parameter to , returns an error. - /// A descriptive container that groups products. A category is merchant defined with associated products and discounts as configured. GThe storefront displays products in a hierarchy of categories. As such, categories can include a nesting of sub-categories to organize products and product options per set guidelines such as color, brand, material, and size. - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var category = category.AddCategory( category, incrementSequence, useProvidedId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Category AddCategory(Mozu.Api.Contracts.ProductAdmin.Category category, bool? incrementSequence = null, bool? useProvidedId = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.AddCategoryClient( category, incrementSequence, useProvidedId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a new category to the site's category hierarchy.Specify a to determine where to place the category in the hierarchy. If no is specified, the new category is a top-level category. + /// /// /// If true, when adding a new product category, set the sequence number of the new category to an increment of one integer greater than the maximum available sequence number across all product categories. If false, set the sequence number to zero. - /// Use this field to include those fields which are not included by default. - /// Optional. If , uses the you specify in the request as the category's id. If , generates an for the category regardless if you specify an id in the request.If you specify an id already in use and set this parameter to , returns an error. - /// A descriptive container that groups products. A category is merchant defined with associated products and discounts as configured. GThe storefront displays products in a hierarchy of categories. As such, categories can include a nesting of sub-categories to organize products and product options per set guidelines such as color, brand, material, and size. + /// + /// + /// Properties of the new category to create. You must specify a name and parent category if you want to create it as a subcategory. /// /// /// @@ -240,46 +140,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Category AddCategory(Mozu.Api.Con /// var category = await category.AddCategoryAsync( category, incrementSequence, useProvidedId, responseFields); /// /// - public virtual async Task AddCategoryAsync(Mozu.Api.Contracts.ProductAdmin.Category category, bool? incrementSequence = null, bool? useProvidedId = null, string responseFields = null) + public virtual async Task AddCategoryAsync(Mozu.Api.Contracts.ProductAdmin.Category category, bool? incrementSequence = null, bool? useProvidedId = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.AddCategoryClient( category, incrementSequence, useProvidedId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Validate the precomputed dynamic category expression for correctness. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the dynamic expression that you want to validate. - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var dynamicExpression = category.ValidateDynamicExpression( dynamicExpressionIn, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.DynamicExpression ValidateDynamicExpression(Mozu.Api.Contracts.ProductAdmin.DynamicExpression dynamicExpressionIn, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.ValidateDynamicExpressionClient( dynamicExpressionIn, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Validate the precomputed dynamic category expression for correctness. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the dynamic expression that you want to validate. + /// + /// /// /// /// @@ -289,46 +165,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.DynamicExpression ValidateDynamic /// var dynamicExpression = await category.ValidateDynamicExpressionAsync( dynamicExpressionIn, responseFields); /// /// - public virtual async Task ValidateDynamicExpressionAsync(Mozu.Api.Contracts.ProductAdmin.DynamicExpression dynamicExpressionIn, string responseFields = null) + public virtual async Task ValidateDynamicExpressionAsync(Mozu.Api.Contracts.ProductAdmin.DynamicExpression dynamicExpressionIn, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.ValidateDynamicExpressionClient( dynamicExpressionIn, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Validates the readltime dynamic category expression for correctness. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the dynamic expression that you want to validate. - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var dynamicExpression = category.ValidateRealTimeDynamicExpression( dynamicExpressionIn, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.DynamicExpression ValidateRealTimeDynamicExpression(Mozu.Api.Contracts.ProductAdmin.DynamicExpression dynamicExpressionIn, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.ValidateRealTimeDynamicExpressionClient( dynamicExpressionIn, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Validates the readltime dynamic category expression for correctness. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the dynamic expression that you want to validate. + /// + /// /// /// /// @@ -338,50 +190,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.DynamicExpression ValidateRealTim /// var dynamicExpression = await category.ValidateRealTimeDynamicExpressionAsync( dynamicExpressionIn, responseFields); /// /// - public virtual async Task ValidateRealTimeDynamicExpressionAsync(Mozu.Api.Contracts.ProductAdmin.DynamicExpression dynamicExpressionIn, string responseFields = null) + public virtual async Task ValidateRealTimeDynamicExpressionAsync(Mozu.Api.Contracts.ProductAdmin.DynamicExpression dynamicExpressionIn, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.ValidateRealTimeDynamicExpressionClient( dynamicExpressionIn, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update the properties of a defined category or move it to another location in the category hierarchy. Because this operation replaces the defined resource,include all the information to maintain for the category in the request. - /// - /// If true, when changing the display option for the category, change it for all subcategories also. The default value is false. - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. - /// A descriptive container that groups products. A category is merchant defined with associated products and discounts as configured. GThe storefront displays products in a hierarchy of categories. As such, categories can include a nesting of sub-categories to organize products and product options per set guidelines such as color, brand, material, and size. - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var category = category.UpdateCategory( category, categoryId, cascadeVisibility, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Category UpdateCategory(Mozu.Api.Contracts.ProductAdmin.Category category, int categoryId, bool? cascadeVisibility = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.UpdateCategoryClient( category, categoryId, cascadeVisibility, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update the properties of a defined category or move it to another location in the category hierarchy. Because this operation replaces the defined resource,include all the information to maintain for the category in the request. + /// /// - /// If true, when changing the display option for the category, change it for all subcategories also. The default value is false. + /// If true, when changing the display option for the category, change it for all subcategories also. Default: False. /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. - /// A descriptive container that groups products. A category is merchant defined with associated products and discounts as configured. GThe storefront displays products in a hierarchy of categories. As such, categories can include a nesting of sub-categories to organize products and product options per set guidelines such as color, brand, material, and size. + /// + /// Properties of the category to modify. /// /// /// @@ -391,49 +217,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Category UpdateCategory(Mozu.Api. /// var category = await category.UpdateCategoryAsync( category, categoryId, cascadeVisibility, responseFields); /// /// - public virtual async Task UpdateCategoryAsync(Mozu.Api.Contracts.ProductAdmin.Category category, int categoryId, bool? cascadeVisibility = null, string responseFields = null) + public virtual async Task UpdateCategoryAsync(Mozu.Api.Contracts.ProductAdmin.Category category, int categoryId, bool? cascadeVisibility = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.UpdateCategoryClient( category, categoryId, cascadeVisibility, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified category. Use the categoryId parameter to specify the category. - /// - /// Specifies whether to also delete all subcategories associated with the specified category.If you set this value is false, only the specified category is deleted.The default value is false. - /// Unique identifier of the category to modify. - /// Specifies whether the category, and any associated subcategories, are deleted even if there are products that reference them. The default value is false. - /// Specifies whether any subcategories of the specified category are reassigned to the parent of the specified category.This field only applies if the cascadeDelete parameter is false.The default value is false. - /// - /// - /// - /// - /// - /// var category = new Category(); - /// category.DeleteCategoryById( categoryId, cascadeDelete, forceDelete, reassignToParent); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCategoryById(int categoryId, bool? cascadeDelete = null, bool? forceDelete = null, bool? reassignToParent = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.DeleteCategoryByIdClient( categoryId, cascadeDelete, forceDelete, reassignToParent); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified category. Use the categoryId parameter to specify the category. + /// /// - /// Specifies whether to also delete all subcategories associated with the specified category.If you set this value is false, only the specified category is deleted.The default value is false. - /// Unique identifier of the category to modify. - /// Specifies whether the category, and any associated subcategories, are deleted even if there are products that reference them. The default value is false. - /// Specifies whether any subcategories of the specified category are reassigned to the parent of the specified category.This field only applies if the cascadeDelete parameter is false.The default value is false. + /// If true, also delete all subcategories associated with the specified category. + /// Unique identifier of the category to delete. + /// + /// /// /// /// @@ -443,12 +244,12 @@ public virtual void DeleteCategoryById(int categoryId, bool? cascadeDelete = nu /// await category.DeleteCategoryByIdAsync( categoryId, cascadeDelete, forceDelete, reassignToParent); /// /// - public virtual async Task DeleteCategoryByIdAsync(int categoryId, bool? cascadeDelete = null, bool? forceDelete = null, bool? reassignToParent = null) + public virtual async Task DeleteCategoryByIdAsync(int categoryId, bool? cascadeDelete = null, bool? forceDelete = null, bool? reassignToParent = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CategoryClient.DeleteCategoryByIdClient( categoryId, cascadeDelete, forceDelete, reassignToParent); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/CouponSetResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/CouponSetResource.cs old mode 100644 new mode 100755 index 65e4cb4e..978e9d7b --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/CouponSetResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/CouponSetResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { /// - /// Use the Coupon Sets resource to view and create coupon sets. You can use coupon sets to group multiple coupon codes together and associate them with one or more discounts. Use the subresource to manage the coupon codes within manual coupon sets. Use the subresource to mange the discounts assigned to coupon sets. + /// /// public partial class CouponSetResource { /// @@ -37,44 +38,16 @@ public CouponSetResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves a list of coupon sets in the catalog according to any specified filter criteria and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Specifies whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts in the response body. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var couponset = new CouponSet(); - /// var couponSetCollection = couponset.GetCouponSets( startIndex, pageSize, sortBy, filter, includeCounts, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.CouponSetCollection GetCouponSets(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeCounts = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.GetCouponSetsClient( startIndex, pageSize, sortBy, filter, includeCounts, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of coupon sets in the catalog according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Specifies whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts in the response body. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// /// @@ -84,48 +57,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.CouponSetCollection GetCouponSets /// var couponSetCollection = await couponset.GetCouponSetsAsync( startIndex, pageSize, sortBy, filter, includeCounts, responseFields); /// /// - public virtual async Task GetCouponSetsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeCounts = null, string responseFields = null) + public virtual async Task GetCouponSetsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeCounts = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.GetCouponSetsClient( startIndex, pageSize, sortBy, filter, includeCounts, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a single coupon set. Use the couponSetCode parameter to specify the coupon set. Use the includeCounts parameter to specify whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts. - /// - /// The unique identifier of the coupon set. - /// Specifies whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts in the response body. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var couponset = new CouponSet(); - /// var couponSet = couponset.GetCouponSet( couponSetCode, includeCounts, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.CouponSet GetCouponSet(string couponSetCode, bool? includeCounts = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.GetCouponSetClient( couponSetCode, includeCounts, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a single coupon set. Use the couponSetCode parameter to specify the coupon set. Use the includeCounts parameter to specify whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts. + /// /// - /// The unique identifier of the coupon set. - /// Specifies whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts in the response body. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// /// @@ -135,44 +83,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.CouponSet GetCouponSet(string cou /// var couponSet = await couponset.GetCouponSetAsync( couponSetCode, includeCounts, responseFields); /// /// - public virtual async Task GetCouponSetAsync(string couponSetCode, bool? includeCounts = null, string responseFields = null) + public virtual async Task GetCouponSetAsync(string couponSetCode, bool? includeCounts = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.GetCouponSetClient( couponSetCode, includeCounts, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Returns a unique, random four character code to use for the couponSetCode. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// string - /// - /// - /// - /// var couponset = new CouponSet(); - /// var string = couponset.GetUniqueCouponSetCode( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual string GetUniqueCouponSetCode(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.GetUniqueCouponSetCodeClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Returns a unique, random four character code to use for the couponSetCode. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// string /// @@ -182,46 +107,22 @@ public virtual string GetUniqueCouponSetCode(string responseFields = null) /// var string = await couponset.GetUniqueCouponSetCodeAsync( responseFields); /// /// - public virtual async Task GetUniqueCouponSetCodeAsync(string responseFields = null) + public virtual async Task GetUniqueCouponSetCodeAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.GetUniqueCouponSetCodeClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a single coupon set to the catalog. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new coupon set. - /// - /// - /// - /// - /// - /// var couponset = new CouponSet(); - /// var couponSet = couponset.AddCouponSet( couponSet, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.CouponSet AddCouponSet(Mozu.Api.Contracts.ProductAdmin.CouponSet couponSet, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.AddCouponSetClient( couponSet, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a single coupon set to the catalog. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new coupon set. + /// + /// /// /// /// @@ -231,43 +132,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.CouponSet AddCouponSet(Mozu.Api.C /// var couponSet = await couponset.AddCouponSetAsync( couponSet, responseFields); /// /// - public virtual async Task AddCouponSetAsync(Mozu.Api.Contracts.ProductAdmin.CouponSet couponSet, string responseFields = null) + public virtual async Task AddCouponSetAsync(Mozu.Api.Contracts.ProductAdmin.CouponSet couponSet, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.AddCouponSetClient( couponSet, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Validates the couponSetCode and tests it for uniqueness. - /// - /// User-defined code that uniqely identifies the channel group. - /// - /// - /// - /// - /// - /// var couponset = new CouponSet(); - /// couponset.ValidateUniqueCouponSetCode( code); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void ValidateUniqueCouponSetCode(string code) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.ValidateUniqueCouponSetCodeClient( code); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Validates the couponSetCode and tests it for uniqueness. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// /// /// /// @@ -277,47 +156,22 @@ public virtual void ValidateUniqueCouponSetCode(string code) /// await couponset.ValidateUniqueCouponSetCodeAsync( code); /// /// - public virtual async Task ValidateUniqueCouponSetCodeAsync(string code) + public virtual async Task ValidateUniqueCouponSetCodeAsync(string code, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.ValidateUniqueCouponSetCodeClient( code); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates one or more properties of a coupon set in the catalog. - /// - /// The unique identifier of the coupon set. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the updated coupon set. - /// - /// - /// - /// - /// - /// var couponset = new CouponSet(); - /// var couponSet = couponset.UpdateCouponSet( couponSet, couponSetCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.CouponSet UpdateCouponSet(Mozu.Api.Contracts.ProductAdmin.CouponSet couponSet, string couponSetCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.UpdateCouponSetClient( couponSet, couponSetCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a coupon set in the catalog. + /// /// - /// The unique identifier of the coupon set. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the updated coupon set. + /// + /// + /// /// /// /// @@ -327,43 +181,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.CouponSet UpdateCouponSet(Mozu.Ap /// var couponSet = await couponset.UpdateCouponSetAsync( couponSet, couponSetCode, responseFields); /// /// - public virtual async Task UpdateCouponSetAsync(Mozu.Api.Contracts.ProductAdmin.CouponSet couponSet, string couponSetCode, string responseFields = null) + public virtual async Task UpdateCouponSetAsync(Mozu.Api.Contracts.ProductAdmin.CouponSet couponSet, string couponSetCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.UpdateCouponSetClient( couponSet, couponSetCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a specified coupon set from the catalog. Use the couponSetCode parameter to specify the coupon set to delete. - /// - /// The unique identifier of the coupon set. - /// - /// - /// - /// - /// - /// var couponset = new CouponSet(); - /// couponset.DeleteCouponSet( couponSetCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCouponSet(string couponSetCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.DeleteCouponSetClient( couponSetCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a specified coupon set from the catalog. Use the couponSetCode parameter to specify the coupon set to delete. + /// /// - /// The unique identifier of the coupon set. + /// /// /// /// @@ -373,12 +205,12 @@ public virtual void DeleteCouponSet(string couponSetCode) /// await couponset.DeleteCouponSetAsync( couponSetCode); /// /// - public virtual async Task DeleteCouponSetAsync(string couponSetCode) + public virtual async Task DeleteCouponSetAsync(string couponSetCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.CouponSetClient.DeleteCouponSetClient( couponSetCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Couponsets/AssignedDiscountResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Couponsets/AssignedDiscountResource.cs old mode 100644 new mode 100755 index 8c56678e..ae7c102f --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Couponsets/AssignedDiscountResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Couponsets/AssignedDiscountResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Couponsets { /// - /// Use the AssignedDiscounts resource to manage the discounts assigned to coupon sets. + /// /// public partial class AssignedDiscountResource { /// @@ -37,34 +38,11 @@ public AssignedDiscountResource CloneWithApiContext(Action contextM } - /// - /// Retrieves the discountIds of any assigned discounts for the specified coupon set. - /// - /// The unique identifier of the coupon set. - /// - /// List{} - /// - /// - /// - /// var assigneddiscount = new AssignedDiscount(); - /// var assignedDiscount = assigneddiscount.GetAssignedDiscounts( couponSetCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAssignedDiscounts(string couponSetCode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.AssignedDiscountClient.GetAssignedDiscountsClient( couponSetCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the discountIds of any assigned discounts for the specified coupon set. + /// /// - /// The unique identifier of the coupon set. + /// /// /// List{} /// @@ -74,45 +52,22 @@ public AssignedDiscountResource CloneWithApiContext(Action contextM /// var assignedDiscount = await assigneddiscount.GetAssignedDiscountsAsync( couponSetCode); /// /// - public virtual async Task> GetAssignedDiscountsAsync(string couponSetCode) + public virtual async Task> GetAssignedDiscountsAsync(string couponSetCode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.AssignedDiscountClient.GetAssignedDiscountsClient( couponSetCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Assigns or associates an existing discount to a specified coupon set. Use the couponSetCode parameter to specify the coupon set. - /// - /// The unique identifier of the coupon set. - /// The details of the discount assigned to the coupon set. - /// - /// - /// - /// - /// - /// var assigneddiscount = new AssignedDiscount(); - /// assigneddiscount.AssignDiscount( assignedDiscount, couponSetCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void AssignDiscount(Mozu.Api.Contracts.ProductAdmin.AssignedDiscount assignedDiscount, string couponSetCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.AssignedDiscountClient.AssignDiscountClient( assignedDiscount, couponSetCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Assigns or associates an existing discount to a specified coupon set. Use the couponSetCode parameter to specify the coupon set. + /// /// - /// The unique identifier of the coupon set. - /// The details of the discount assigned to the coupon set. + /// + /// /// /// /// @@ -122,44 +77,21 @@ public virtual void AssignDiscount(Mozu.Api.Contracts.ProductAdmin.AssignedDisco /// await assigneddiscount.AssignDiscountAsync( assignedDiscount, couponSetCode); /// /// - public virtual async Task AssignDiscountAsync(Mozu.Api.Contracts.ProductAdmin.AssignedDiscount assignedDiscount, string couponSetCode) + public virtual async Task AssignDiscountAsync(Mozu.Api.Contracts.ProductAdmin.AssignedDiscount assignedDiscount, string couponSetCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.AssignedDiscountClient.AssignDiscountClient( assignedDiscount, couponSetCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Unassigns or disassociates the specified discount with the specified coupon set. - /// - /// The unique identifier of the coupon set. - /// discountId parameter description DOCUMENT_HERE - /// - /// - /// - /// - /// - /// var assigneddiscount = new AssignedDiscount(); - /// assigneddiscount.UnAssignDiscount( couponSetCode, discountId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void UnAssignDiscount(string couponSetCode, int discountId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.AssignedDiscountClient.UnAssignDiscountClient( couponSetCode, discountId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Unassigns or disassociates the specified discount with the specified coupon set. + /// /// - /// The unique identifier of the coupon set. - /// discountId parameter description DOCUMENT_HERE + /// + /// /// /// /// @@ -169,12 +101,12 @@ public virtual void UnAssignDiscount(string couponSetCode, int discountId) /// await assigneddiscount.UnAssignDiscountAsync( couponSetCode, discountId); /// /// - public virtual async Task UnAssignDiscountAsync(string couponSetCode, int discountId) + public virtual async Task UnAssignDiscountAsync(string couponSetCode, int discountId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.AssignedDiscountClient.UnAssignDiscountClient( couponSetCode, discountId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Couponsets/CouponResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Couponsets/CouponResource.cs old mode 100644 new mode 100755 index e7136f56..fb6014cc --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Couponsets/CouponResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Couponsets/CouponResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Couponsets { /// - /// Use the Coupons subresource to manage coupons within manual coupon sets. + /// /// public partial class CouponResource { /// @@ -37,40 +38,14 @@ public CouponResource CloneWithApiContext(Action contextModificatio } - /// - /// Retrieves the details of the specified coupon. Use the couponSetCode and the couponCode parameter to specify the coupon within a coupon set. Use the includeCounts paramter to specify whether to return the redemptionCount property in the response body object. - /// - /// Code associated with the coupon to remove from the cart. - /// The unique identifier of the coupon set that the coupon belongs to. - /// Specifies whether to return the redemptionCount property in the response body object. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var coupon = new Coupon(); - /// var coupon = coupon.GetCoupon( couponSetCode, couponCode, includeCounts, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Coupon GetCoupon(string couponSetCode, string couponCode, bool? includeCounts = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.GetCouponClient( couponSetCode, couponCode, includeCounts, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified coupon. Use the couponSetCode and the couponCode parameter to specify the coupon within a coupon set. Use the includeCounts paramter to specify whether to return the redemptionCount property in the response body object. + /// /// - /// Code associated with the coupon to remove from the cart. - /// The unique identifier of the coupon set that the coupon belongs to. - /// Specifies whether to return the redemptionCount property in the response body object. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// /// @@ -80,56 +55,27 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Coupon GetCoupon(string couponSet /// var coupon = await coupon.GetCouponAsync( couponSetCode, couponCode, includeCounts, responseFields); /// /// - public virtual async Task GetCouponAsync(string couponSetCode, string couponCode, bool? includeCounts = null, string responseFields = null) + public virtual async Task GetCouponAsync(string couponSetCode, string couponCode, bool? includeCounts = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.GetCouponClient( couponSetCode, couponCode, includeCounts, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of coupons in a specified coupon set according to any specified filter criteria and sort options. - /// - /// The unique identifier of the coupon set that the coupons belongs to. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Specifies whether to include the redemptionCount property in the response body object. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var coupon = new Coupon(); - /// var couponCollection = coupon.GetCoupons( couponSetCode, startIndex, pageSize, sortBy, filter, includeCounts, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.CouponCollection GetCoupons(string couponSetCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeCounts = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.GetCouponsClient( couponSetCode, startIndex, pageSize, sortBy, filter, includeCounts, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of coupons in a specified coupon set according to any specified filter criteria and sort options. + /// /// - /// The unique identifier of the coupon set that the coupons belongs to. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Specifies whether to include the redemptionCount property in the response body object. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// + /// /// /// /// @@ -139,45 +85,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.CouponCollection GetCoupons(strin /// var couponCollection = await coupon.GetCouponsAsync( couponSetCode, startIndex, pageSize, sortBy, filter, includeCounts, responseFields); /// /// - public virtual async Task GetCouponsAsync(string couponSetCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeCounts = null, string responseFields = null) + public virtual async Task GetCouponsAsync(string couponSetCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeCounts = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.GetCouponsClient( couponSetCode, startIndex, pageSize, sortBy, filter, includeCounts, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds coupons to a specified manual coupon set. Use the couponSetCode parameter to specify the manual coupon set. - /// - /// The unique identifier of the coupon set. - /// The details necessary to assign the discount to a coupon set, including . - /// - /// - /// - /// - /// - /// var coupon = new Coupon(); - /// coupon.AddCoupons( coupons, couponSetCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void AddCoupons(List coupons, string couponSetCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.AddCouponsClient( coupons, couponSetCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Adds coupons to a specified manual coupon set. Use the couponSetCode parameter to specify the manual coupon set. + /// /// - /// The unique identifier of the coupon set. - /// The details necessary to assign the discount to a coupon set, including . + /// + /// /// /// /// @@ -187,44 +110,21 @@ public virtual void AddCoupons(List coup /// await coupon.AddCouponsAsync( coupons, couponSetCode); /// /// - public virtual async Task AddCouponsAsync(List coupons, string couponSetCode) + public virtual async Task AddCouponsAsync(List coupons, string couponSetCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.AddCouponsClient( coupons, couponSetCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the specified coupons and removes them from the coupon set. You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. - /// - /// The unique identifier of the coupon set that the coupon belongs to. - /// The unique identifiers of the coupons to delete. - /// - /// - /// - /// - /// - /// var coupon = new Coupon(); - /// coupon.DeleteCoupons( couponCodes, couponSetCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCoupons(List couponCodes, string couponSetCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.DeleteCouponsClient( couponCodes, couponSetCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified coupons and removes them from the coupon set. You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. + /// /// - /// The unique identifier of the coupon set that the coupon belongs to. - /// The unique identifiers of the coupons to delete. + /// + /// /// /// /// @@ -234,44 +134,21 @@ public virtual void DeleteCoupons(List couponCodes, string couponSetCode /// await coupon.DeleteCouponsAsync( couponCodes, couponSetCode); /// /// - public virtual async Task DeleteCouponsAsync(List couponCodes, string couponSetCode) + public virtual async Task DeleteCouponsAsync(List couponCodes, string couponSetCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.DeleteCouponsClient( couponCodes, couponSetCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the specified coupon and remove it from the coupon set. You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. - /// - /// Code associated with the coupon to remove from the cart. - /// The unique identifier of the coupon set that the coupon belongs to. - /// - /// - /// - /// - /// - /// var coupon = new Coupon(); - /// coupon.DeleteCoupon( couponSetCode, couponCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCoupon(string couponSetCode, string couponCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.DeleteCouponClient( couponSetCode, couponCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified coupon and remove it from the coupon set. You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. + /// /// - /// Code associated with the coupon to remove from the cart. - /// The unique identifier of the coupon set that the coupon belongs to. + /// + /// /// /// /// @@ -281,12 +158,12 @@ public virtual void DeleteCoupon(string couponSetCode, string couponCode) /// await coupon.DeleteCouponAsync( couponSetCode, couponCode); /// /// - public virtual async Task DeleteCouponAsync(string couponSetCode, string couponCode) + public virtual async Task DeleteCouponAsync(string couponSetCode, string couponCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Couponsets.CouponClient.DeleteCouponClient( couponSetCode, couponCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/DiscountResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/DiscountResource.cs old mode 100644 new mode 100755 index 5ab4f211..d523b005 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/DiscountResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/DiscountResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { /// - /// Use the Discounts resource to define and manage discounts to apply to products, product categories, or orders. The discounts can be a specified amount off the price, percentage off the price, or for free shipping. You can create a coupon code that shoppers can use to redeem the discount. + /// Define and manage discounts to apply to products, product categories, or orders. The discounts can be a specified amount off the price, percentage off the price, or for free shipping. Create a coupon code that shoppers can use to redeem the discount. /// public partial class DiscountResource { /// @@ -44,40 +45,13 @@ public DiscountResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of discounts according to any specified filter criteria and sort options. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// - /// - /// var discount = new Discount(); - /// var discountCollection = discount.GetDiscounts(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.DiscountCollection GetDiscounts(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.GetDiscountsClient(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of discounts according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -89,46 +63,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.DiscountCollection GetDiscounts(i /// var discountCollection = await discount.GetDiscountsAsync(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetDiscountsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetDiscountsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.GetDiscountsClient(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the localized content specified for the specified discount. - /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var discount = new Discount(); - /// var discountLocalizedContent = discount.GetDiscountContent(_dataViewMode, discountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent GetDiscountContent(int discountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.GetDiscountContentClient(_dataViewMode, discountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the localized content specified for the specified discount. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read-only. + /// /// /// /// @@ -138,46 +88,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent GetDisco /// var discountLocalizedContent = await discount.GetDiscountContentAsync(_dataViewMode, discountId, responseFields); /// /// - public virtual async Task GetDiscountContentAsync(int discountId, string responseFields = null) + public virtual async Task GetDiscountContentAsync(int discountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.GetDiscountContentClient(_dataViewMode, discountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a single discount. - /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var discount = new Discount(); - /// var discount = discount.GetDiscount(_dataViewMode, discountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Discount GetDiscount(int discountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.GetDiscountClient(_dataViewMode, discountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a single discount. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read-only. + /// /// /// /// @@ -187,44 +113,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Discount GetDiscount(int discount /// var discount = await discount.GetDiscountAsync(_dataViewMode, discountId, responseFields); /// /// - public virtual async Task GetDiscountAsync(int discountId, string responseFields = null) + public virtual async Task GetDiscountAsync(int discountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.GetDiscountClient(_dataViewMode, discountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Generates a random code for a coupon. - /// - /// Use this field to include those fields which are not included by default. - /// - /// string - /// - /// - /// - /// var discount = new Discount(); - /// var string = discount.GenerateRandomCoupon( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual string GenerateRandomCoupon(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.GenerateRandomCouponClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Generates a random code for a coupon. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// string /// @@ -234,46 +137,22 @@ public virtual string GenerateRandomCoupon(string responseFields = null) /// var string = await discount.GenerateRandomCouponAsync( responseFields); /// /// - public virtual async Task GenerateRandomCouponAsync(string responseFields = null) + public virtual async Task GenerateRandomCouponAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.GenerateRandomCouponClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new discount or coupon to apply to a product, category, order, or shipping. - /// - /// Use this field to include those fields which are not included by default. - /// Name of the discount added and applied to a shopping cart and order for a shopper's purchase. - /// - /// - /// - /// - /// - /// var discount = new Discount(); - /// var discount = discount.CreateDiscount( discount, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Discount CreateDiscount(Mozu.Api.Contracts.ProductAdmin.Discount discount, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.CreateDiscountClient( discount, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new discount or coupon to apply to a product, category, order, or shipping. + /// /// - /// Use this field to include those fields which are not included by default. - /// Name of the discount added and applied to a shopping cart and order for a shopper's purchase. + /// + /// Properties of the discount to create. You must specify the discount name, amount type, start date, and target. /// /// /// @@ -283,48 +162,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Discount CreateDiscount(Mozu.Api. /// var discount = await discount.CreateDiscountAsync( discount, responseFields); /// /// - public virtual async Task CreateDiscountAsync(Mozu.Api.Contracts.ProductAdmin.Discount discount, string responseFields = null) + public virtual async Task CreateDiscountAsync(Mozu.Api.Contracts.ProductAdmin.Discount discount, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.CreateDiscountClient( discount, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the localizable content for the specified discount or renames the discount without modifying its other properties. - /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// The container for the language-specific name of the discount. A container exists for each supported language (LocaleCode). This parameter enables you to display the discount name in multiple languages yet manage it as a single discount internally. - /// - /// - /// - /// - /// - /// var discount = new Discount(); - /// var discountLocalizedContent = discount.UpdateDiscountContent( content, discountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent UpdateDiscountContent(Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent content, int discountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.UpdateDiscountContentClient( content, discountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the localizable content for the specified discount or renames the discount without modifying its other properties. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// The container for the language-specific name of the discount. A container exists for each supported language (LocaleCode). This parameter enables you to display the discount name in multiple languages yet manage it as a single discount internally. + /// Unique identifier of the discount. System-supplied and read-only. + /// + /// The discount content to update, including the discount name. /// /// /// @@ -334,48 +188,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent UpdateDi /// var discountLocalizedContent = await discount.UpdateDiscountContentAsync( content, discountId, responseFields); /// /// - public virtual async Task UpdateDiscountContentAsync(Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent content, int discountId, string responseFields = null) + public virtual async Task UpdateDiscountContentAsync(Mozu.Api.Contracts.ProductAdmin.DiscountLocalizedContent content, int discountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.UpdateDiscountContentClient( content, discountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of the specified discount. - /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// Name of the discount added and applied to a shopping cart and order for a shopper's purchase. - /// - /// - /// - /// - /// - /// var discount = new Discount(); - /// var discount = discount.UpdateDiscount( discount, discountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Discount UpdateDiscount(Mozu.Api.Contracts.ProductAdmin.Discount discount, int discountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.UpdateDiscountClient( discount, discountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of the specified discount. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// Name of the discount added and applied to a shopping cart and order for a shopper's purchase. + /// Unique identifier of the discount to update. + /// + /// Properties of the discount to update. /// /// /// @@ -385,43 +214,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Discount UpdateDiscount(Mozu.Api. /// var discount = await discount.UpdateDiscountAsync( discount, discountId, responseFields); /// /// - public virtual async Task UpdateDiscountAsync(Mozu.Api.Contracts.ProductAdmin.Discount discount, int discountId, string responseFields = null) + public virtual async Task UpdateDiscountAsync(Mozu.Api.Contracts.ProductAdmin.Discount discount, int discountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.UpdateDiscountClient( discount, discountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a discount specified by its discount ID. - /// - /// discountId parameter description DOCUMENT_HERE - /// - /// - /// - /// - /// - /// var discount = new Discount(); - /// discount.DeleteDiscount( discountId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDiscount(int discountId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.DeleteDiscountClient( discountId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a discount specified by its discount ID. + /// /// - /// discountId parameter description DOCUMENT_HERE + /// Unique identifier of the discount. System-supplied and read-only. /// /// /// @@ -431,12 +238,12 @@ public virtual void DeleteDiscount(int discountId) /// await discount.DeleteDiscountAsync( discountId); /// /// - public virtual async Task DeleteDiscountAsync(int discountId) + public virtual async Task DeleteDiscountAsync(int discountId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountClient.DeleteDiscountClient( discountId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/DiscountSettingsResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/DiscountSettingsResource.cs new file mode 100755 index 00000000..a9028f62 --- /dev/null +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/DiscountSettingsResource.cs @@ -0,0 +1,106 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce.Catalog.Admin +{ + /// + /// + /// + public partial class DiscountSettingsResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + private readonly DataViewMode _dataViewMode; + + public DiscountSettingsResource(IApiContext apiContext) + { + _apiContext = apiContext; + _dataViewMode = DataViewMode.Live; + } + + public DiscountSettingsResource CloneWithApiContext(Action contextModification) + { + return new DiscountSettingsResource(_apiContext.CloneWith(contextModification), _dataViewMode); + } + + public DiscountSettingsResource(IApiContext apiContext, DataViewMode dataViewMode) + { + _apiContext = apiContext; + _dataViewMode = dataViewMode; + } + + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// var discountsettings = new DiscountSettings(); + /// var discountSettings = await discountsettings.GetDiscountSettingsAsync(_dataViewMode, catalogId, responseFields); + /// + /// + public virtual async Task GetDiscountSettingsAsync(int catalogId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountSettingsClient.GetDiscountSettingsClient(_dataViewMode, catalogId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// + /// var discountsettings = new DiscountSettings(); + /// var discountSettings = await discountsettings.UpdateDiscountSettingsAsync( discountSettings, catalogId, responseFields); + /// + /// + public virtual async Task UpdateDiscountSettingsAsync(Mozu.Api.Contracts.ProductAdmin.DiscountSettings discountSettings, int catalogId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Catalog.Admin.DiscountSettingsClient.UpdateDiscountSettingsClient( discountSettings, catalogId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Discounts/DiscountTargetResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Discounts/DiscountTargetResource.cs old mode 100644 new mode 100755 index 11e60e72..36fabea1 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Discounts/DiscountTargetResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Discounts/DiscountTargetResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Discounts { @@ -44,36 +45,12 @@ public DiscountTargetResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves the discount target, that is which products, categories, or shipping methods are eligible for the discount. - /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var discounttarget = new DiscountTarget(); - /// var discountTarget = discounttarget.GetDiscountTarget(_dataViewMode, discountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.DiscountTarget GetDiscountTarget(int discountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Discounts.DiscountTargetClient.GetDiscountTargetClient(_dataViewMode, discountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the discount target, that is which products, categories, or shipping methods are eligible for the discount. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read only. + /// /// /// /// @@ -83,48 +60,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.DiscountTarget GetDiscountTarget( /// var discountTarget = await discounttarget.GetDiscountTargetAsync(_dataViewMode, discountId, responseFields); /// /// - public virtual async Task GetDiscountTargetAsync(int discountId, string responseFields = null) + public virtual async Task GetDiscountTargetAsync(int discountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Discounts.DiscountTargetClient.GetDiscountTargetClient(_dataViewMode, discountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Modifies properties of the discount target, for example, the dollar amount, or precentage off the price. - /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// 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. - /// - /// - /// - /// - /// - /// var discounttarget = new DiscountTarget(); - /// var discountTarget = discounttarget.UpdateDiscountTarget( discountTarget, discountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.DiscountTarget UpdateDiscountTarget(Mozu.Api.Contracts.ProductAdmin.DiscountTarget discountTarget, int discountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Discounts.DiscountTargetClient.UpdateDiscountTargetClient( discountTarget, discountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Modifies properties of the discount target, for example, the dollar amount, or precentage off the price. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. - /// 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. + /// Unique identifier of the discount. System-supplied and read-only. + /// + /// Properties of the discount target to modify. Required properties: Target.Type. Any unspecified properties are set to null and boolean variables to false. /// /// /// @@ -134,12 +86,12 @@ public virtual Mozu.Api.Contracts.ProductAdmin.DiscountTarget UpdateDiscountTarg /// var discountTarget = await discounttarget.UpdateDiscountTargetAsync( discountTarget, discountId, responseFields); /// /// - public virtual async Task UpdateDiscountTargetAsync(Mozu.Api.Contracts.ProductAdmin.DiscountTarget discountTarget, int discountId, string responseFields = null) + public virtual async Task UpdateDiscountTargetAsync(Mozu.Api.Contracts.ProductAdmin.DiscountTarget discountTarget, int discountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Discounts.DiscountTargetClient.UpdateDiscountTargetClient( discountTarget, discountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/FacetResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/FacetResource.cs old mode 100644 new mode 100755 index f7f98719..c2427bf7 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/FacetResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/FacetResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { @@ -37,37 +38,12 @@ public FacetResource CloneWithApiContext(Action contextModification } - /// - /// Retrieves a facet specified by its unique identifier and displays its properties. - /// - /// Unique identifier of the facet to retrieve. - /// Use this field to include those fields which are not included by default. - /// Validates that the product category associated with a facet is active. System-supplied and read only. - /// - /// - /// - /// - /// - /// var facet = new Facet(); - /// var facet = facet.GetFacet( facetId, validate, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Facet GetFacet(int facetId, bool? validate = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.GetFacetClient( facetId, validate, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a facet specified by its unique identifier and displays its properties. + /// /// /// Unique identifier of the facet to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// Validates that the product category associated with a facet is active. System-supplied and read only. /// /// @@ -78,49 +54,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Facet GetFacet(int facetId, bool? /// var facet = await facet.GetFacetAsync( facetId, validate, responseFields); /// /// - public virtual async Task GetFacetAsync(int facetId, bool? validate = null, string responseFields = null) + public virtual async Task GetFacetAsync(int facetId, bool? validate = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.GetFacetClient( facetId, validate, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of the facets defined for the specified category. - /// - /// Unique identifier of the category to modify. - /// If true, returns a list of the attributes and categories associated with a product type that have not been defined as a facet for the category. - /// Use this field to include those fields which are not included by default. - /// Validates that the product category associated with a facet is active. System-supplied and read only. - /// - /// - /// - /// - /// - /// var facet = new Facet(); - /// var facetSet = facet.GetFacetCategoryList( categoryId, includeAvailable, validate, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.FacetSet GetFacetCategoryList(int categoryId, bool? includeAvailable = null, bool? validate = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.GetFacetCategoryListClient( categoryId, includeAvailable, validate, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the facets defined for the specified category. + /// /// - /// Unique identifier of the category to modify. + /// Unique identifier of the category associated with the facets to retrieve. /// If true, returns a list of the attributes and categories associated with a product type that have not been defined as a facet for the category. - /// Use this field to include those fields which are not included by default. + /// /// Validates that the product category associated with a facet is active. System-supplied and read only. /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.FacetSet GetFacetCategoryList(int /// var facetSet = await facet.GetFacetCategoryListAsync( categoryId, includeAvailable, validate, responseFields); /// /// - public virtual async Task GetFacetCategoryListAsync(int categoryId, bool? includeAvailable = null, bool? validate = null, string responseFields = null) + public virtual async Task GetFacetCategoryListAsync(int categoryId, bool? includeAvailable = null, bool? validate = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.GetFacetCategoryListClient( categoryId, includeAvailable, validate, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new category, price, or attribute facet. Define the category or attribute source to use for the facet values. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of the facet used to retrieve documents. - /// - /// - /// - /// - /// - /// var facet = new Facet(); - /// var facet = facet.AddFacet( facet, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Facet AddFacet(Mozu.Api.Contracts.ProductAdmin.Facet facet, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.AddFacetClient( facet, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new category, price, or attribute facet. Define the category or attribute source to use for the facet values. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the facet used to retrieve documents. + /// + /// Properties of the new facet to create. You must specify the source, type, and category. /// /// /// @@ -180,48 +106,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Facet AddFacet(Mozu.Api.Contracts /// var facet = await facet.AddFacetAsync( facet, responseFields); /// /// - public virtual async Task AddFacetAsync(Mozu.Api.Contracts.ProductAdmin.Facet facet, string responseFields = null) + public virtual async Task AddFacetAsync(Mozu.Api.Contracts.ProductAdmin.Facet facet, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.AddFacetClient( facet, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Modifies one or more properties of a defined facet. - /// - /// Unique identifier of the facet to retrieve. - /// Use this field to include those fields which are not included by default. - /// Properties of the facet used to retrieve documents. - /// - /// - /// - /// - /// - /// var facet = new Facet(); - /// var facet = facet.UpdateFacet( facet, facetId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Facet UpdateFacet(Mozu.Api.Contracts.ProductAdmin.Facet facet, int facetId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.UpdateFacetClient( facet, facetId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Modifies one or more properties of a defined facet. + /// /// - /// Unique identifier of the facet to retrieve. - /// Use this field to include those fields which are not included by default. - /// Properties of the facet used to retrieve documents. + /// Unique identifier of the facet to modify. + /// + /// Properties of the defined facet to modify. /// /// /// @@ -231,43 +132,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Facet UpdateFacet(Mozu.Api.Contra /// var facet = await facet.UpdateFacetAsync( facet, facetId, responseFields); /// /// - public virtual async Task UpdateFacetAsync(Mozu.Api.Contracts.ProductAdmin.Facet facet, int facetId, string responseFields = null) + public virtual async Task UpdateFacetAsync(Mozu.Api.Contracts.ProductAdmin.Facet facet, int facetId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.UpdateFacetClient( facet, facetId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the facet specified by its unique identifier. - /// - /// Unique identifier of the facet to retrieve. - /// - /// - /// - /// - /// - /// var facet = new Facet(); - /// facet.DeleteFacetById( facetId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteFacetById(int facetId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.DeleteFacetByIdClient( facetId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the facet specified by its unique identifier. + /// /// - /// Unique identifier of the facet to retrieve. + /// Unique identifier of the facet to delete. /// /// /// @@ -277,12 +156,12 @@ public virtual void DeleteFacetById(int facetId) /// await facet.DeleteFacetByIdAsync( facetId); /// /// - public virtual async Task DeleteFacetByIdAsync(int facetId) + public virtual async Task DeleteFacetByIdAsync(int facetId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.FacetClient.DeleteFacetByIdClient( facetId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/LocationInventoryResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/LocationInventoryResource.cs old mode 100644 new mode 100755 index 36d26eac..1be3af68 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/LocationInventoryResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/LocationInventoryResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { @@ -44,39 +45,13 @@ public LocationInventoryResource(IApiContext apiContext, DataViewMode dataViewMo _dataViewMode = dataViewMode; } - /// - /// Retrieves the details of a product's active inventory at the location specified in the request. - /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// {} - /// - /// - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// var locationInventory = locationinventory.GetLocationInventory(_dataViewMode, locationCode, productCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInventory(string locationCode, string productCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.GetLocationInventoryClient(_dataViewMode, locationCode, productCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a product's active inventory at the location specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// User-defined code that uniquely identifies the location. + /// + /// /// {} /// /// @@ -87,57 +62,27 @@ public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInve /// var locationInventory = await locationinventory.GetLocationInventoryAsync(_dataViewMode, locationCode, productCode, responseFields); /// /// - public virtual async Task GetLocationInventoryAsync(string locationCode, string productCode, string responseFields = null) + public virtual async Task GetLocationInventoryAsync(string locationCode, string productCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.GetLocationInventoryClient(_dataViewMode, locationCode, productCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of all product inventory definitions for the location code specified in the request. - /// - /// 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" - /// Functions that optimize commonly used filters for efficiency.For the operation, you have access to the filter function. For example, use to filter only for product inventory that is currently active. - /// The unique, user-defined code that identifies a location. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// {} - /// - /// - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// var locationInventoryCollection = locationinventory.GetLocationInventories(_dataViewMode, locationCode, startIndex, pageSize, sortBy, filter, filterFunctions, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLocationInventories(string locationCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string filterFunctions = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.GetLocationInventoriesClient(_dataViewMode, locationCode, startIndex, pageSize, sortBy, filter, filterFunctions, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of all product inventory definitions for the location code specified in the request. + /// /// - /// 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" - /// Functions that optimize commonly used filters for efficiency.For the operation, you have access to the filter function. For example, use to filter only for product inventory that is currently active. - /// The unique, user-defined code that identifies a location. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// + /// /// {} /// /// @@ -148,50 +93,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLo /// var locationInventoryCollection = await locationinventory.GetLocationInventoriesAsync(_dataViewMode, locationCode, startIndex, pageSize, sortBy, filter, filterFunctions, responseFields); /// /// - public virtual async Task GetLocationInventoriesAsync(string locationCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string filterFunctions = null, string responseFields = null) + public virtual async Task GetLocationInventoriesAsync(string locationCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string filterFunctions = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.GetLocationInventoriesClient(_dataViewMode, locationCode, startIndex, pageSize, sortBy, filter, filterFunctions, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates an array of product inventory definitions for the location specified in the request. When adding a new inventory definition, you must specify the productCode and stockOnHand value in each array you define. All other properties are system-supplied and read only. - /// - /// The unique, user-defined code that identifies a location. - /// Query string parameter lets the service perform an update for a new or existing record. When run, the update occurs without throwing a conflict exception that the record exists. If true, the updates completes regardless of the record currently existing. By default, if no value is specified, the service assumes this value is false. - /// {} - /// Properties of an inventory definition that defines the level of inventory for a specific product at a given location. - /// - /// List{} - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// var locationInventory = locationinventory.AddLocationInventory(_dataViewMode, locationInventoryList, locationCode, performUpserts); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List AddLocationInventory(List locationInventoryList, string locationCode, bool? performUpserts = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.AddLocationInventoryClient(_dataViewMode, locationInventoryList, locationCode, performUpserts); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates an array of product inventory definitions for the location specified in the request. When adding a new inventory definition, you must specify the productCode and stockOnHand value in each array you define. All other properties are system-supplied and read only. + /// /// - /// The unique, user-defined code that identifies a location. - /// Query string parameter lets the service perform an update for a new or existing record. When run, the update occurs without throwing a conflict exception that the record exists. If true, the updates completes regardless of the record currently existing. By default, if no value is specified, the service assumes this value is false. + /// User-defined code that uniquely identifies the location. + /// /// {} - /// Properties of an inventory definition that defines the level of inventory for a specific product at a given location. + /// Array list of product inventory definitions for all associated locations. For each location inventory in the list, define the productCode and stockOnHand values. /// /// List{} /// @@ -201,48 +120,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLo /// var locationInventory = await locationinventory.AddLocationInventoryAsync(_dataViewMode, locationInventoryList, locationCode, performUpserts); /// /// - public virtual async Task> AddLocationInventoryAsync(List locationInventoryList, string locationCode, bool? performUpserts = null) + public virtual async Task> AddLocationInventoryAsync(List locationInventoryList, string locationCode, bool? performUpserts = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.AddLocationInventoryClient(_dataViewMode, locationInventoryList, locationCode, performUpserts); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the active stock on hand inventory of products for the location code specified in the request. - /// - /// The unique, user-defined code that identifies a location. - /// {} - /// Properties of an adjustment to the active product inventory of a specific location. - /// - /// List{} - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// var locationInventory = locationinventory.UpdateLocationInventory(_dataViewMode, locationInventoryAdjustments, locationCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateLocationInventory(List locationInventoryAdjustments, string locationCode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.UpdateLocationInventoryClient(_dataViewMode, locationInventoryAdjustments, locationCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the active stock on hand inventory of products for the location code specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. + /// User-defined code that uniquely identifies the location. /// {} - /// Properties of an adjustment to the active product inventory of a specific location. + /// Properties of the inventory adjustments to perform for the specified location. /// /// List{} /// @@ -252,46 +146,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLo /// var locationInventory = await locationinventory.UpdateLocationInventoryAsync(_dataViewMode, locationInventoryAdjustments, locationCode); /// /// - public virtual async Task> UpdateLocationInventoryAsync(List locationInventoryAdjustments, string locationCode) + public virtual async Task> UpdateLocationInventoryAsync(List locationInventoryAdjustments, string locationCode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.UpdateLocationInventoryClient(_dataViewMode, locationInventoryAdjustments, locationCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the product code inventory definition for the location specified in the request. - /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// {} - /// - /// - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// locationinventory.DeleteLocationInventory(_dataViewMode, locationCode, productCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteLocationInventory(string locationCode, string productCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.DeleteLocationInventoryClient(_dataViewMode, locationCode, productCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the product code inventory definition for the location specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// User-defined code that uniquely identifies the location. + /// /// {} /// /// @@ -302,12 +172,12 @@ public virtual void DeleteLocationInventory(string locationCode, string productC /// await locationinventory.DeleteLocationInventoryAsync(_dataViewMode, locationCode, productCode); /// /// - public virtual async Task DeleteLocationInventoryAsync(string locationCode, string productCode) + public virtual async Task DeleteLocationInventoryAsync(string locationCode, string productCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.LocationInventoryClient.DeleteLocationInventoryClient(_dataViewMode, locationCode, productCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/MasterCatalogResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/MasterCatalogResource.cs old mode 100644 new mode 100755 index a806351b..ac7fdc8e --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/MasterCatalogResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/MasterCatalogResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { @@ -37,34 +38,11 @@ public MasterCatalogResource CloneWithApiContext(Action contextModi } - /// - /// Retrieve the details of all master catalog associated with a tenant. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var mastercatalog = new MasterCatalog(); - /// var masterCatalogCollection = mastercatalog.GetMasterCatalogs( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.MasterCatalogCollection GetMasterCatalogs(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.MasterCatalogClient.GetMasterCatalogsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve the details of all master catalog associated with a tenant. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -74,46 +52,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.MasterCatalogCollection GetMaster /// var masterCatalogCollection = await mastercatalog.GetMasterCatalogsAsync( responseFields); /// /// - public virtual async Task GetMasterCatalogsAsync(string responseFields = null) + public virtual async Task GetMasterCatalogsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.MasterCatalogClient.GetMasterCatalogsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieve the details of the master catalog specified in the request. - /// - /// The unique identifier of the master catalog associated with the entity. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var mastercatalog = new MasterCatalog(); - /// var masterCatalog = mastercatalog.GetMasterCatalog( masterCatalogId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.MasterCatalog GetMasterCatalog(int masterCatalogId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.MasterCatalogClient.GetMasterCatalogClient( masterCatalogId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve the details of the master catalog specified in the request. + /// /// - /// The unique identifier of the master catalog associated with the entity. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// @@ -123,48 +77,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.MasterCatalog GetMasterCatalog(in /// var masterCatalog = await mastercatalog.GetMasterCatalogAsync( masterCatalogId, responseFields); /// /// - public virtual async Task GetMasterCatalogAsync(int masterCatalogId, string responseFields = null) + public virtual async Task GetMasterCatalogAsync(int masterCatalogId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.MasterCatalogClient.GetMasterCatalogClient( masterCatalogId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the product publishing mode for the master catalog specified in the request. - /// - /// - /// Use this field to include those fields which are not included by default. - /// Properties of a master product catalog defined for a tenant. All catalogs and sites associated with a master catalog share product definitions. - /// - /// - /// - /// - /// - /// var mastercatalog = new MasterCatalog(); - /// var masterCatalog = mastercatalog.UpdateMasterCatalog( masterCatalog, masterCatalogId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.MasterCatalog UpdateMasterCatalog(Mozu.Api.Contracts.ProductAdmin.MasterCatalog masterCatalog, int masterCatalogId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.MasterCatalogClient.UpdateMasterCatalogClient( masterCatalog, masterCatalogId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the product publishing mode for the master catalog specified in the request. + /// /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a master product catalog defined for a tenant. All catalogs and sites associated with a master catalog share product definitions. + /// + /// Properties of the master catalog to update, which consists of the product publishing mode. Possible values are "Pending" which saves product updates in draft mode until they are published, and "Live" which publishes all product changes immediately. /// /// /// @@ -174,12 +103,12 @@ public virtual Mozu.Api.Contracts.ProductAdmin.MasterCatalog UpdateMasterCatalog /// var masterCatalog = await mastercatalog.UpdateMasterCatalogAsync( masterCatalog, masterCatalogId, responseFields); /// /// - public virtual async Task UpdateMasterCatalogAsync(Mozu.Api.Contracts.ProductAdmin.MasterCatalog masterCatalog, int masterCatalogId, string responseFields = null) + public virtual async Task UpdateMasterCatalogAsync(Mozu.Api.Contracts.ProductAdmin.MasterCatalog masterCatalog, int masterCatalogId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.MasterCatalogClient.UpdateMasterCatalogClient( masterCatalog, masterCatalogId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/PriceListResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/PriceListResource.cs old mode 100644 new mode 100755 index 2eaa3076..4dea0bf2 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/PriceListResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/PriceListResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { /// - /// Use the Price Lists resource to view and create price lists. You can use price lists to override the catalog pricing of products for specific customer segments and/or sites. You can override products' list price, sale price, advanced pricing information such as MSRP, cost, MAP, and the catalog price of any extras associated with the product in a price list. You can also restrict discounts from applying to the overridden product pricing in a price list. Refer to [Price Lists](../../../guides/catalog/price-lists.htm) in the Guides section for more information about price lists. + /// /// public partial class PriceListResource { /// @@ -37,42 +38,15 @@ public PriceListResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves a list of price lists according to any specified facets, filter criteria, and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// var priceListCollection = pricelist.GetPriceLists( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PriceListCollection GetPriceLists(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.GetPriceListsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of price lists according to any specified facets, filter criteria, and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PriceListCollection GetPriceLists /// var priceListCollection = await pricelist.GetPriceListsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetPriceListsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetPriceListsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.GetPriceListsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the specified price list. - /// - /// The unique, user-defined code of the price list. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// var priceList = pricelist.GetPriceList( priceListCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PriceList GetPriceList(string priceListCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.GetPriceListClient( priceListCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified price list. + /// /// - /// The unique, user-defined code of the price list. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PriceList GetPriceList(string pri /// var priceList = await pricelist.GetPriceListAsync( priceListCode, responseFields); /// /// - public virtual async Task GetPriceListAsync(string priceListCode, string responseFields = null) + public virtual async Task GetPriceListAsync(string priceListCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.GetPriceListClient( priceListCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a new price list to the tenant. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new price list. - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// var priceList = pricelist.AddPriceList( priceList, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PriceList AddPriceList(Mozu.Api.Contracts.ProductAdmin.PriceList priceList, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.AddPriceListClient( priceList, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a new price list to the tenant. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new price list. + /// + /// /// /// /// @@ -180,46 +106,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PriceList AddPriceList(Mozu.Api.C /// var priceList = await pricelist.AddPriceListAsync( priceList, responseFields); /// /// - public virtual async Task AddPriceListAsync(Mozu.Api.Contracts.ProductAdmin.PriceList priceList, string responseFields = null) + public virtual async Task AddPriceListAsync(Mozu.Api.Contracts.ProductAdmin.PriceList priceList, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.AddPriceListClient( priceList, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds up to 5000 new price list entries in bulk. - /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to adding price list entries to the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. - /// - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// pricelist.BulkAddPriceListEntries( priceListEntriesIn, publishEvents, invalidateCache); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void BulkAddPriceListEntries(List priceListEntriesIn, bool? publishEvents = null, bool? invalidateCache = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.BulkAddPriceListEntriesClient( priceListEntriesIn, publishEvents, invalidateCache); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Adds up to 5000 new price list entries in bulk. + /// /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to adding price list entries to the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. + /// + /// /// /// /// @@ -230,45 +132,21 @@ public virtual void BulkAddPriceListEntries(List /// - public virtual async Task BulkAddPriceListEntriesAsync(List priceListEntriesIn, bool? publishEvents = null, bool? invalidateCache = null) + public virtual async Task BulkAddPriceListEntriesAsync(List priceListEntriesIn, bool? publishEvents = null, bool? invalidateCache = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.BulkAddPriceListEntriesClient( priceListEntriesIn, publishEvents, invalidateCache); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes up to 5000 price list entries in bulk. - /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to deleting price list entries from the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. - /// - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// pricelist.BulkDeletePriceListEntries( priceListEntriesIn, publishEvents, invalidateCache); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void BulkDeletePriceListEntries(List priceListEntriesIn, bool? publishEvents = null, bool? invalidateCache = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.BulkDeletePriceListEntriesClient( priceListEntriesIn, publishEvents, invalidateCache); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes up to 5000 price list entries in bulk. + /// /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to deleting price list entries from the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. + /// + /// /// /// /// @@ -279,45 +157,21 @@ public virtual void BulkDeletePriceListEntries(List /// - public virtual async Task BulkDeletePriceListEntriesAsync(List priceListEntriesIn, bool? publishEvents = null, bool? invalidateCache = null) + public virtual async Task BulkDeletePriceListEntriesAsync(List priceListEntriesIn, bool? publishEvents = null, bool? invalidateCache = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.BulkDeletePriceListEntriesClient( priceListEntriesIn, publishEvents, invalidateCache); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates up to 5000 price list entries in bulk. - /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to updating price list entries in the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. - /// - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// pricelist.BulkUpdatePriceListEntries( priceListEntriesIn, publishEvents, invalidateCache); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void BulkUpdatePriceListEntries(List priceListEntriesIn, bool? publishEvents = null, bool? invalidateCache = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.BulkUpdatePriceListEntriesClient( priceListEntriesIn, publishEvents, invalidateCache); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Updates up to 5000 price list entries in bulk. + /// /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to updating price list entries in the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. + /// + /// /// /// /// @@ -328,47 +182,22 @@ public virtual void BulkUpdatePriceListEntries(List /// - public virtual async Task BulkUpdatePriceListEntriesAsync(List priceListEntriesIn, bool? publishEvents = null, bool? invalidateCache = null) + public virtual async Task BulkUpdatePriceListEntriesAsync(List priceListEntriesIn, bool? publishEvents = null, bool? invalidateCache = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.BulkUpdatePriceListEntriesClient( priceListEntriesIn, publishEvents, invalidateCache); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates the details of the specified price list. - /// - /// The unique, user-defined code of the price list. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the updated price list. - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// var priceList = pricelist.UpdatePriceList( priceList, priceListCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PriceList UpdatePriceList(Mozu.Api.Contracts.ProductAdmin.PriceList priceList, string priceListCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.UpdatePriceListClient( priceList, priceListCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of the specified price list. + /// /// - /// The unique, user-defined code of the price list. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the updated price list. + /// + /// + /// /// /// /// @@ -378,45 +207,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PriceList UpdatePriceList(Mozu.Ap /// var priceList = await pricelist.UpdatePriceListAsync( priceList, priceListCode, responseFields); /// /// - public virtual async Task UpdatePriceListAsync(Mozu.Api.Contracts.ProductAdmin.PriceList priceList, string priceListCode, string responseFields = null) + public virtual async Task UpdatePriceListAsync(Mozu.Api.Contracts.ProductAdmin.PriceList priceList, string priceListCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.UpdatePriceListClient( priceList, priceListCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified price list from the tenant. - /// - /// Specifies whether to deletes all price list entries associated with the price list. - /// The unique, user-defined code of the price list. - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// pricelist.DeletePriceList( priceListCode, cascadeDeleteEntries); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeletePriceList(string priceListCode, bool? cascadeDeleteEntries = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.DeletePriceListClient( priceListCode, cascadeDeleteEntries); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified price list from the tenant. + /// /// - /// Specifies whether to deletes all price list entries associated with the price list. - /// The unique, user-defined code of the price list. + /// + /// /// /// /// @@ -426,12 +232,12 @@ public virtual void DeletePriceList(string priceListCode, bool? cascadeDeleteEnt /// await pricelist.DeletePriceListAsync( priceListCode, cascadeDeleteEntries); /// /// - public virtual async Task DeletePriceListAsync(string priceListCode, bool? cascadeDeleteEntries = null) + public virtual async Task DeletePriceListAsync(string priceListCode, bool? cascadeDeleteEntries = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PriceListClient.DeletePriceListClient( priceListCode, cascadeDeleteEntries); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Pricelists/PriceListEntryResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Pricelists/PriceListEntryResource.cs old mode 100644 new mode 100755 index 50948744..0808e21e --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Pricelists/PriceListEntryResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Pricelists/PriceListEntryResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Pricelists { /// - /// Use the Entries sub-resource to interact with price list entries. Price list entries enable you to override product pricing as well as control what products shoppers can view and purchase when the price list is exclusive. Refer to the [Price Lists](../../../guides/catalog/price-lists.htm) guides topic for more information. + /// /// public partial class PriceListEntryResource { /// @@ -37,42 +38,15 @@ public PriceListEntryResource CloneWithApiContext(Action contextMod } - /// - /// Retrieves the details of a price list entry. - /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique code of the price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The start date of the price list entry. - /// - /// - /// - /// - /// - /// var pricelistentry = new PriceListEntry(); - /// var priceListEntry = pricelistentry.GetPriceListEntry( priceListCode, productCode, currencyCode, startDate, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PriceListEntry GetPriceListEntry(string priceListCode, string productCode, string currencyCode, DateTime? startDate = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.GetPriceListEntryClient( priceListCode, productCode, currencyCode, startDate, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a price list entry. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique code of the price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The start date of the price list entry. + /// + /// + /// + /// + /// /// /// /// @@ -82,54 +56,26 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PriceListEntry GetPriceListEntry( /// var priceListEntry = await pricelistentry.GetPriceListEntryAsync( priceListCode, productCode, currencyCode, startDate, responseFields); /// /// - public virtual async Task GetPriceListEntryAsync(string priceListCode, string productCode, string currencyCode, DateTime? startDate = null, string responseFields = null) + public virtual async Task GetPriceListEntryAsync(string priceListCode, string productCode, string currencyCode, DateTime? startDate = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.GetPriceListEntryClient( priceListCode, productCode, currencyCode, startDate, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of price list entries associated with the specified price list according to any specified facets, filter criteria, and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// The unique code of the price list associated with the price list entry. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var pricelistentry = new PriceListEntry(); - /// var priceListEntryCollection = pricelistentry.GetPriceListEntries( priceListCode, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PriceListEntryCollection GetPriceListEntries(string priceListCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.GetPriceListEntriesClient( priceListCode, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of price list entries associated with the specified price list according to any specified facets, filter criteria, and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// The unique code of the price list associated with the price list entry. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// /// @@ -139,48 +85,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PriceListEntryCollection GetPrice /// var priceListEntryCollection = await pricelistentry.GetPriceListEntriesAsync( priceListCode, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetPriceListEntriesAsync(string priceListCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetPriceListEntriesAsync(string priceListCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.GetPriceListEntriesClient( priceListCode, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a new price list entry to the specified price list. - /// - /// The specified price list to which you want to add the price list entry. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new price list entry. - /// - /// - /// - /// - /// - /// var pricelistentry = new PriceListEntry(); - /// var priceListEntry = pricelistentry.AddPriceListEntry( priceListEntryIn, priceListCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PriceListEntry AddPriceListEntry(Mozu.Api.Contracts.ProductAdmin.PriceListEntry priceListEntryIn, string priceListCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.AddPriceListEntryClient( priceListEntryIn, priceListCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a new price list entry to the specified price list. + /// /// - /// The specified price list to which you want to add the price list entry. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new price list entry. + /// + /// + /// /// /// /// @@ -190,54 +111,26 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PriceListEntry AddPriceListEntry( /// var priceListEntry = await pricelistentry.AddPriceListEntryAsync( priceListEntryIn, priceListCode, responseFields); /// /// - public virtual async Task AddPriceListEntryAsync(Mozu.Api.Contracts.ProductAdmin.PriceListEntry priceListEntryIn, string priceListCode, string responseFields = null) + public virtual async Task AddPriceListEntryAsync(Mozu.Api.Contracts.ProductAdmin.PriceListEntry priceListEntryIn, string priceListCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.AddPriceListEntryClient( priceListEntryIn, priceListCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the details of a price list entry. - /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique code of the price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The start date of the price list entry. - /// The updated details of the price list entry. - /// - /// - /// - /// - /// - /// var pricelistentry = new PriceListEntry(); - /// var priceListEntry = pricelistentry.UpdatePriceListEntry( priceListEntryIn, priceListCode, productCode, currencyCode, startDate, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PriceListEntry UpdatePriceListEntry(Mozu.Api.Contracts.ProductAdmin.PriceListEntry priceListEntryIn, string priceListCode, string productCode, string currencyCode, DateTime? startDate = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.UpdatePriceListEntryClient( priceListEntryIn, priceListCode, productCode, currencyCode, startDate, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of a price list entry. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique code of the price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The start date of the price list entry. - /// The updated details of the price list entry. + /// + /// + /// + /// + /// + /// /// /// /// @@ -247,49 +140,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PriceListEntry UpdatePriceListEnt /// var priceListEntry = await pricelistentry.UpdatePriceListEntryAsync( priceListEntryIn, priceListCode, productCode, currencyCode, startDate, responseFields); /// /// - public virtual async Task UpdatePriceListEntryAsync(Mozu.Api.Contracts.ProductAdmin.PriceListEntry priceListEntryIn, string priceListCode, string productCode, string currencyCode, DateTime? startDate = null, string responseFields = null) + public virtual async Task UpdatePriceListEntryAsync(Mozu.Api.Contracts.ProductAdmin.PriceListEntry priceListEntryIn, string priceListCode, string productCode, string currencyCode, DateTime? startDate = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.UpdatePriceListEntryClient( priceListEntryIn, priceListCode, productCode, currencyCode, startDate, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a price list entry. - /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The code of the specified price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The start date of the price list entry. - /// - /// - /// - /// - /// - /// var pricelistentry = new PriceListEntry(); - /// pricelistentry.DeletePriceListEntry( priceListCode, productCode, currencyCode, startDate); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeletePriceListEntry(string priceListCode, string productCode, string currencyCode, DateTime? startDate = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.DeletePriceListEntryClient( priceListCode, productCode, currencyCode, startDate); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a price list entry. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The code of the specified price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The start date of the price list entry. + /// + /// + /// + /// /// /// /// @@ -299,12 +167,12 @@ public virtual void DeletePriceListEntry(string priceListCode, string productCod /// await pricelistentry.DeletePriceListEntryAsync( priceListCode, productCode, currencyCode, startDate); /// /// - public virtual async Task DeletePriceListEntryAsync(string priceListCode, string productCode, string currencyCode, DateTime? startDate = null) + public virtual async Task DeletePriceListEntryAsync(string priceListCode, string productCode, string currencyCode, DateTime? startDate = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Pricelists.PriceListEntryClient.DeletePriceListEntryClient( priceListCode, productCode, currencyCode, startDate); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/ProductReservationResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/ProductReservationResource.cs old mode 100644 new mode 100755 index aea48228..17c15caf --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/ProductReservationResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/ProductReservationResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { /// - /// Use the Product Reservations resource to temporarily hold a product from inventory while a shopper is filling out payment information. You can create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete. + /// Temporarily hold a product from inventory while a shopper is filling out payment information. Create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete. /// public partial class ProductReservationResource { /// @@ -44,42 +45,14 @@ public ProductReservationResource(IApiContext apiContext, DataViewMode dataViewM _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of product reservations according to any specified filter criteria and sort options. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// - /// - /// {} - /// - /// - /// - /// - /// - /// var productreservation = new ProductReservation(); - /// var productReservationCollection = productreservation.GetProductReservations(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductReservationCollection GetProductReservations(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.GetProductReservationsClient(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of product reservations according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// + /// + /// Used to page results from a query. Indicates the maximum number of entities to return from a query. Default value: 20. Max value: 200. + /// + /// The element to sort the results by and the order in which the results appear. Either ascending order (a-z) which accepts 'asc' or 'asc' or descending order (z-a) which accepts 'desc' or 'desc'. The sortBy parameter follows an available property. /// /// {} /// @@ -91,47 +64,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductReservationCollection GetP /// var productReservationCollection = await productreservation.GetProductReservationsAsync(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetProductReservationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetProductReservationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.GetProductReservationsClient(_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a product reservation. - /// - /// Unique identifier of the product reservation. - /// Use this field to include those fields which are not included by default. - /// {} - /// - /// - /// - /// - /// - /// var productreservation = new ProductReservation(); - /// var productReservation = productreservation.GetProductReservation(_dataViewMode, productReservationId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductReservation GetProductReservation(int productReservationId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.GetProductReservationClient(_dataViewMode, productReservationId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a product reservation. + /// /// /// Unique identifier of the product reservation. - /// Use this field to include those fields which are not included by default. + /// /// {} /// /// @@ -142,48 +90,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductReservation GetProductRese /// var productReservation = await productreservation.GetProductReservationAsync(_dataViewMode, productReservationId, responseFields); /// /// - public virtual async Task GetProductReservationAsync(int productReservationId, string responseFields = null) + public virtual async Task GetProductReservationAsync(int productReservationId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.GetProductReservationClient(_dataViewMode, productReservationId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new product reservation for a product. This action places a hold on the product inventory for the quantity specified during the ordering process. - /// - /// If true, skip the process to validate inventory when creating this product reservation. - /// {} - /// A hold placed on product inventory for a particular product so that the quantity specified is set aside and available for purchase during the ordering process. - /// - /// List{} - /// - /// - /// - /// var productreservation = new ProductReservation(); - /// var productReservation = productreservation.AddProductReservations(_dataViewMode, productReservations, skipInventoryCheck); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List AddProductReservations(List productReservations, bool? skipInventoryCheck = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.AddProductReservationsClient(_dataViewMode, productReservations, skipInventoryCheck); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new product reservation for a product. This action places a hold on the product inventory for the quantity specified during the ordering process. + /// /// /// If true, skip the process to validate inventory when creating this product reservation. /// {} - /// A hold placed on product inventory for a particular product so that the quantity specified is set aside and available for purchase during the ordering process. + /// Details of the product reservations to add. /// /// List{} /// @@ -193,45 +116,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductReservation GetProductRese /// var productReservation = await productreservation.AddProductReservationsAsync(_dataViewMode, productReservations, skipInventoryCheck); /// /// - public virtual async Task> AddProductReservationsAsync(List productReservations, bool? skipInventoryCheck = null) + public virtual async Task> AddProductReservationsAsync(List productReservations, bool? skipInventoryCheck = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.AddProductReservationsClient(_dataViewMode, productReservations, skipInventoryCheck); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Commits a product reservation to decrement the product's inventory by the quantity specified then release the reservation once the order process completed successfully. - /// - /// {} - /// A hold placed on product inventory for a particular product so that the quantity specified is set aside and available for purchase during the ordering process. - /// - /// - /// - /// - /// - /// var productreservation = new ProductReservation(); - /// productreservation.CommitReservations(_dataViewMode, productReservations); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void CommitReservations(List productReservations) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.CommitReservationsClient(_dataViewMode, productReservations); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Commits a product reservation to decrement the product's inventory by the quantity specified then release the reservation once the order process completed successfully. + /// /// /// {} - /// A hold placed on product inventory for a particular product so that the quantity specified is set aside and available for purchase during the ordering process. + /// List of unique identifiers of the reservations to commit. /// /// /// @@ -241,47 +141,22 @@ public virtual void CommitReservations(List /// - public virtual async Task CommitReservationsAsync(List productReservations) + public virtual async Task CommitReservationsAsync(List productReservations, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.CommitReservationsClient(_dataViewMode, productReservations); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates an existing product reservation for a product. - /// - /// If true, skip the process to validate inventory when creating this product reservation. - /// {} - /// A hold placed on product inventory for a particular product so that the quantity specified is set aside and available for purchase during the ordering process. - /// - /// List{} - /// - /// - /// - /// var productreservation = new ProductReservation(); - /// var productReservation = productreservation.UpdateProductReservations(_dataViewMode, productReservations, skipInventoryCheck); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateProductReservations(List productReservations, bool? skipInventoryCheck = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.UpdateProductReservationsClient(_dataViewMode, productReservations, skipInventoryCheck); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates an existing product reservation for a product. + /// /// - /// If true, skip the process to validate inventory when creating this product reservation. + /// If true, skip the inventory validation process when updating this product reservation. /// {} - /// A hold placed on product inventory for a particular product so that the quantity specified is set aside and available for purchase during the ordering process. + /// Properties of the product reservations to update. /// /// List{} /// @@ -291,44 +166,21 @@ public virtual async Task CommitReservationsAsync(List /// - public virtual async Task> UpdateProductReservationsAsync(List productReservations, bool? skipInventoryCheck = null) + public virtual async Task> UpdateProductReservationsAsync(List productReservations, bool? skipInventoryCheck = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.UpdateProductReservationsClient(_dataViewMode, productReservations, skipInventoryCheck); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a product reservation. For example, delete a reservation when an order is not processed to return the product quantity back to inventory. - /// - /// Unique identifier of the product reservation. - /// {} - /// - /// - /// - /// - /// - /// var productreservation = new ProductReservation(); - /// productreservation.DeleteProductReservation(_dataViewMode, productReservationId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProductReservation(int productReservationId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.DeleteProductReservationClient(_dataViewMode, productReservationId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a product reservation. For example, delete a reservation when an order is not processed to return the product quantity back to inventory. + /// /// - /// Unique identifier of the product reservation. + /// Unique identifier of the reservation. /// {} /// /// @@ -339,12 +191,12 @@ public virtual void DeleteProductReservation(int productReservationId) /// await productreservation.DeleteProductReservationAsync(_dataViewMode, productReservationId); /// /// - public virtual async Task DeleteProductReservationAsync(int productReservationId) + public virtual async Task DeleteProductReservationAsync(int productReservationId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductReservationClient.DeleteProductReservationClient(_dataViewMode, productReservationId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/ProductResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/ProductResource.cs old mode 100644 new mode 100755 index 13fd79c0..13c8366e --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/ProductResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/ProductResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { @@ -44,46 +45,16 @@ public ProductResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of products according to any specified facets, filter criteria, and sort options. - /// - /// 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" - /// If true, the operation does not return the TotalCount number of results. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. - /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var productCollection = product.GetProducts(_dataViewMode, startIndex, pageSize, sortBy, filter, q, qLimit, noCount, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductCollection GetProducts(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, bool? noCount = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.GetProductsClient(_dataViewMode, startIndex, pageSize, sortBy, filter, q, qLimit, noCount, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of products according to any specified facets, filter criteria, and sort options. + /// /// - /// 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" + /// /// If true, the operation does not return the TotalCount number of results. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// + /// A list of product search terms to use in the query when searching across product code and product name. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -95,44 +66,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductCollection GetProducts(int /// var productCollection = await product.GetProductsAsync(_dataViewMode, startIndex, pageSize, sortBy, filter, q, qLimit, noCount, responseFields); /// /// - public virtual async Task GetProductsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, bool? noCount = null, string responseFields = null) + public virtual async Task GetProductsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, bool? noCount = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.GetProductsClient(_dataViewMode, startIndex, pageSize, sortBy, filter, q, qLimit, noCount, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a product that is associated with one or more specific catalogs. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// - /// List{} - /// - /// - /// - /// var product = new Product(); - /// var productInCatalogInfo = product.GetProductInCatalogs(_dataViewMode, productCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetProductInCatalogs(string productCode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.GetProductInCatalogsClient(_dataViewMode, productCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a product that is associated with one or more specific catalogs. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// List{} /// @@ -142,48 +90,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductCollection GetProducts(int /// var productInCatalogInfo = await product.GetProductInCatalogsAsync(_dataViewMode, productCode); /// /// - public virtual async Task> GetProductInCatalogsAsync(string productCode) + public virtual async Task> GetProductInCatalogsAsync(string productCode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.GetProductInCatalogsClient(_dataViewMode, productCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a product associated with a specific catalog. - /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var productInCatalogInfo = product.GetProductInCatalog(_dataViewMode, productCode, catalogId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo GetProductInCatalog(string productCode, int catalogId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.GetProductInCatalogClient(_dataViewMode, productCode, catalogId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a product associated with a specific catalog. + /// /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -193,46 +116,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo GetProductIn /// var productInCatalogInfo = await product.GetProductInCatalogAsync(_dataViewMode, productCode, catalogId, responseFields); /// /// - public virtual async Task GetProductInCatalogAsync(string productCode, int catalogId, string responseFields = null) + public virtual async Task GetProductInCatalogAsync(string productCode, int catalogId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.GetProductInCatalogClient(_dataViewMode, productCode, catalogId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a product definition. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var product = product.GetProduct(_dataViewMode, productCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Product GetProduct(string productCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.GetProductClient(_dataViewMode, productCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a product definition. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// @@ -242,46 +141,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Product GetProduct(string product /// var product = await product.GetProductAsync(_dataViewMode, productCode, responseFields); /// /// - public virtual async Task GetProductAsync(string productCode, string responseFields = null) + public virtual async Task GetProductAsync(string productCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.GetProductClient(_dataViewMode, productCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new product definition in the specified master catalog. - /// - /// Use this field to include those fields which are not included by default. - /// The properties of a product, referenced and used by carts, orders, wish lists, and returns. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var product = product.AddProduct(_dataViewMode, product, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Product AddProduct(Mozu.Api.Contracts.ProductAdmin.Product product, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.AddProductClient(_dataViewMode, product, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new product definition in the specified master catalog. + /// /// - /// Use this field to include those fields which are not included by default. - /// The properties of a product, referenced and used by carts, orders, wish lists, and returns. + /// + /// Properties of the new product. You must supply values for the product code, product name, and price. /// /// /// @@ -291,48 +166,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Product AddProduct(Mozu.Api.Contr /// var product = await product.AddProductAsync(_dataViewMode, product, responseFields); /// /// - public virtual async Task AddProductAsync(Mozu.Api.Contracts.ProductAdmin.Product product, string responseFields = null) + public virtual async Task AddProductAsync(Mozu.Api.Contracts.ProductAdmin.Product product, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.AddProductClient(_dataViewMode, product, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Associates a new product defined in the master catalog with a specific catalog. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of a product associated with a specific catalog. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var productInCatalogInfo = product.AddProductInCatalog(_dataViewMode, productInCatalogInfoIn, productCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo AddProductInCatalog(Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo productInCatalogInfoIn, string productCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.AddProductInCatalogClient(_dataViewMode, productInCatalogInfoIn, productCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Associates a new product defined in the master catalog with a specific catalog. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of a product associated with a specific catalog. + /// + /// + /// Properties of the product to define for the specific catalog association. /// /// /// @@ -342,43 +192,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo AddProductIn /// var productInCatalogInfo = await product.AddProductInCatalogAsync(_dataViewMode, productInCatalogInfoIn, productCode, responseFields); /// /// - public virtual async Task AddProductInCatalogAsync(Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo productInCatalogInfoIn, string productCode, string responseFields = null) + public virtual async Task AddProductInCatalogAsync(Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo productInCatalogInfoIn, string productCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.AddProductInCatalogClient(_dataViewMode, productInCatalogInfoIn, productCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Performs an update to a product code by renaming or replacing the current product code with a new one. - /// - /// Properties for a product code current and changed content. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// product.RenameProductCodes( productCodeRenames); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void RenameProductCodes(List productCodeRenames) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.RenameProductCodesClient( productCodeRenames); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Performs an update to a product code by renaming or replacing the current product code with a new one. + /// /// - /// Properties for a product code current and changed content. + /// /// /// /// @@ -388,45 +216,21 @@ public virtual void RenameProductCodes(List /// - public virtual async Task RenameProductCodesAsync(List productCodeRenames) + public virtual async Task RenameProductCodesAsync(List productCodeRenames, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.RenameProductCodesClient( productCodeRenames); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates the properties of a product specific to each catalog associated with the product. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Properties of a product associated with a specific catalog. - /// - /// List{} - /// - /// - /// - /// var product = new Product(); - /// var productInCatalogInfo = product.UpdateProductInCatalogs(_dataViewMode, productInCatalogsIn, productCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateProductInCatalogs(List productInCatalogsIn, string productCode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.UpdateProductInCatalogsClient(_dataViewMode, productInCatalogsIn, productCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the properties of a product specific to each catalog associated with the product. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Properties of a product associated with a specific catalog. + /// + /// Properties of the product to update for each associated catalog. /// /// List{} /// @@ -436,50 +240,24 @@ public virtual async Task RenameProductCodesAsync(List /// - public virtual async Task> UpdateProductInCatalogsAsync(List productInCatalogsIn, string productCode) + public virtual async Task> UpdateProductInCatalogsAsync(List productInCatalogsIn, string productCode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.UpdateProductInCatalogsClient(_dataViewMode, productInCatalogsIn, productCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of a product associated with a specific catalog. - /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of a product associated with a specific catalog. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var productInCatalogInfo = product.UpdateProductInCatalog(_dataViewMode, productInCatalogInfoIn, productCode, catalogId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo UpdateProductInCatalog(Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo productInCatalogInfoIn, string productCode, int catalogId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.UpdateProductInCatalogClient(_dataViewMode, productInCatalogInfoIn, productCode, catalogId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a product associated with a specific catalog. + /// /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of a product associated with a specific catalog. + /// + /// + /// + /// Properties of the product associated with the catalog specified in the request. /// /// /// @@ -489,48 +267,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo UpdateProduc /// var productInCatalogInfo = await product.UpdateProductInCatalogAsync(_dataViewMode, productInCatalogInfoIn, productCode, catalogId, responseFields); /// /// - public virtual async Task UpdateProductInCatalogAsync(Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo productInCatalogInfoIn, string productCode, int catalogId, string responseFields = null) + public virtual async Task UpdateProductInCatalogAsync(Mozu.Api.Contracts.ProductAdmin.ProductInCatalogInfo productInCatalogInfoIn, string productCode, int catalogId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.UpdateProductInCatalogClient(_dataViewMode, productInCatalogInfoIn, productCode, catalogId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of a product definition in a master catalog. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// The properties of a product, referenced and used by carts, orders, wish lists, and returns. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var product = product.UpdateProduct(_dataViewMode, product, productCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Product UpdateProduct(Mozu.Api.Contracts.ProductAdmin.Product product, string productCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.UpdateProductClient(_dataViewMode, product, productCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a product definition in a master catalog. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// The properties of a product, referenced and used by carts, orders, wish lists, and returns. + /// + /// + /// Properties of the product definition to update in the master catalog. /// /// /// @@ -540,43 +293,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Product UpdateProduct(Mozu.Api.Co /// var product = await product.UpdateProductAsync(_dataViewMode, product, productCode, responseFields); /// /// - public virtual async Task UpdateProductAsync(Mozu.Api.Contracts.ProductAdmin.Product product, string productCode, string responseFields = null) + public virtual async Task UpdateProductAsync(Mozu.Api.Contracts.ProductAdmin.Product product, string productCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.UpdateProductClient(_dataViewMode, product, productCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified product from a master catalog. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// product.DeleteProduct(_dataViewMode, productCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProduct(string productCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.DeleteProductClient(_dataViewMode, productCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified product from a master catalog. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// /// /// /// @@ -586,44 +317,21 @@ public virtual void DeleteProduct(string productCode) /// await product.DeleteProductAsync(_dataViewMode, productCode); /// /// - public virtual async Task DeleteProductAsync(string productCode) + public virtual async Task DeleteProductAsync(string productCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.DeleteProductClient(_dataViewMode, productCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Removes the product association defined for a specific catalog. - /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// product.DeleteProductInCatalog(_dataViewMode, productCode, catalogId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProductInCatalog(string productCode, int catalogId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.DeleteProductInCatalogClient(_dataViewMode, productCode, catalogId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes the product association defined for a specific catalog. + /// /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// + /// /// /// /// @@ -633,12 +341,12 @@ public virtual void DeleteProductInCatalog(string productCode, int catalogId) /// await product.DeleteProductInCatalogAsync(_dataViewMode, productCode, catalogId); /// /// - public virtual async Task DeleteProductInCatalogAsync(string productCode, int catalogId) + public virtual async Task DeleteProductInCatalogAsync(string productCode, int catalogId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.ProductClient.DeleteProductInCatalogClient(_dataViewMode, productCode, catalogId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/LocationInventoryResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/LocationInventoryResource.cs old mode 100644 new mode 100755 index 0fe0b576..32c984cc --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/LocationInventoryResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/LocationInventoryResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Products { @@ -44,44 +45,16 @@ public LocationInventoryResource(IApiContext apiContext, DataViewMode dataViewMo _dataViewMode = dataViewMode; } - /// - /// Retrieves all locations for which a product has inventory defined and displays the inventory definition properties of each location. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// var locationInventoryCollection = locationinventory.GetLocationInventories(_dataViewMode, productCode, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLocationInventories(string productCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.GetLocationInventoriesClient(_dataViewMode, productCode, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves all locations for which a product has inventory defined and displays the inventory definition properties of each location. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// /// @@ -91,48 +64,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventoryCollection GetLo /// var locationInventoryCollection = await locationinventory.GetLocationInventoriesAsync(_dataViewMode, productCode, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetLocationInventoriesAsync(string productCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetLocationInventoriesAsync(string productCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.GetLocationInventoriesClient(_dataViewMode, productCode, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the inventory of the product in the location specified in the request. - /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// var locationInventory = locationinventory.GetLocationInventory(_dataViewMode, productCode, locationCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInventory(string productCode, string locationCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.GetLocationInventoryClient(_dataViewMode, productCode, locationCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the inventory of the product in the location specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the location. + /// + /// /// /// /// @@ -142,48 +90,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInve /// var locationInventory = await locationinventory.GetLocationInventoryAsync(_dataViewMode, productCode, locationCode, responseFields); /// /// - public virtual async Task GetLocationInventoryAsync(string productCode, string locationCode, string responseFields = null) + public virtual async Task GetLocationInventoryAsync(string productCode, string locationCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.GetLocationInventoryClient(_dataViewMode, productCode, locationCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new location inventory definition for the product code specified in the request. - /// - /// Query string parameter lets the service perform an update for a new or existing record. When run, the update occurs without throwing a conflict exception that the record exists. If true, the updates completes regardless of the record currently existing. By default, if no value is specified, the service assumes this value is false. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Properties of an inventory definition that defines the level of inventory for a specific product at a given location. - /// - /// List{} - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// var locationInventory = locationinventory.AddLocationInventory(_dataViewMode, locationInventoryList, productCode, performUpserts); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List AddLocationInventory(List locationInventoryList, string productCode, bool? performUpserts = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.AddLocationInventoryClient(_dataViewMode, locationInventoryList, productCode, performUpserts); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new location inventory definition for the product code specified in the request. + /// /// - /// Query string parameter lets the service perform an update for a new or existing record. When run, the update occurs without throwing a conflict exception that the record exists. If true, the updates completes regardless of the record currently existing. By default, if no value is specified, the service assumes this value is false. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Properties of an inventory definition that defines the level of inventory for a specific product at a given location. + /// The performUpserts query string parameter lets the service perform an update if the record already exists instead of throwing an already exists conflict exception. PerformUpserts=true means it updates if the record already exists. By default, no value specified means that the service assumes PerformUpserts=false. + /// + /// Array list of the location inventory definitions associated with the product code specified in the request. For each location, you must define the locationCode value and the stockOnHand value. All other properties in the array are system-supplied and read only. /// /// List{} /// @@ -193,46 +116,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInve /// var locationInventory = await locationinventory.AddLocationInventoryAsync(_dataViewMode, locationInventoryList, productCode, performUpserts); /// /// - public virtual async Task> AddLocationInventoryAsync(List locationInventoryList, string productCode, bool? performUpserts = null) + public virtual async Task> AddLocationInventoryAsync(List locationInventoryList, string productCode, bool? performUpserts = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.AddLocationInventoryClient(_dataViewMode, locationInventoryList, productCode, performUpserts); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the current level of stock at each location associated with the product code specified in the request. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Properties of an adjustment to the active product inventory of a specific location. - /// - /// List{} - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// var locationInventory = locationinventory.UpdateLocationInventory(_dataViewMode, locationInventoryAdjustments, productCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateLocationInventory(List locationInventoryAdjustments, string productCode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.UpdateLocationInventoryClient(_dataViewMode, locationInventoryAdjustments, productCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the current level of stock at each location associated with the product code specified in the request. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Properties of an adjustment to the active product inventory of a specific location. + /// The product code of the product for which to update active stock on hand inventory at a specified location. + /// Properties of the inventory adjustments to perform for the specified location. /// /// List{} /// @@ -242,45 +141,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.LocationInventory GetLocationInve /// var locationInventory = await locationinventory.UpdateLocationInventoryAsync(_dataViewMode, locationInventoryAdjustments, productCode); /// /// - public virtual async Task> UpdateLocationInventoryAsync(List locationInventoryAdjustments, string productCode) + public virtual async Task> UpdateLocationInventoryAsync(List locationInventoryAdjustments, string productCode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.UpdateLocationInventoryClient(_dataViewMode, locationInventoryAdjustments, productCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the location inventory definition for the product code specified in the request. - /// - /// The unique, user-defined code that identifies a location. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// - /// - /// - /// - /// - /// var locationinventory = new LocationInventory(); - /// locationinventory.DeleteLocationInventory(_dataViewMode, productCode, locationCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteLocationInventory(string productCode, string locationCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.DeleteLocationInventoryClient(_dataViewMode, productCode, locationCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the location inventory definition for the product code specified in the request. + /// /// - /// The unique, user-defined code that identifies a location. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// The code that identifies the location for which to delete product inventory. + /// The product code for which to delete a location's inventory. /// /// /// @@ -290,12 +166,12 @@ public virtual void DeleteLocationInventory(string productCode, string locationC /// await locationinventory.DeleteLocationInventoryAsync(_dataViewMode, productCode, locationCode); /// /// - public virtual async Task DeleteLocationInventoryAsync(string productCode, string locationCode) + public virtual async Task DeleteLocationInventoryAsync(string productCode, string locationCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.LocationInventoryClient.DeleteLocationInventoryClient(_dataViewMode, productCode, locationCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductExtraResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductExtraResource.cs old mode 100644 new mode 100755 index 3e95b6aa..bc5f41c1 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductExtraResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductExtraResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Products { @@ -44,34 +45,11 @@ public ProductExtraResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of extras configured for the product according to any defined filter and sort criteria. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// - /// List{} - /// - /// - /// - /// var productextra = new ProductExtra(); - /// var productExtra = productextra.GetExtras(_dataViewMode, productCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetExtras(string productCode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.GetExtrasClient(_dataViewMode, productCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of extras configured for the product according to any defined filter and sort criteria. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// List{} /// @@ -81,48 +59,23 @@ public ProductExtraResource(IApiContext apiContext, DataViewMode dataViewMode) /// var productExtra = await productextra.GetExtrasAsync(_dataViewMode, productCode); /// /// - public virtual async Task> GetExtrasAsync(string productCode) + public virtual async Task> GetExtrasAsync(string productCode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.GetExtrasClient(_dataViewMode, productCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. - /// - /// List{} - /// - /// - /// - /// var productextra = new ProductExtra(); - /// var productExtraValueDeltaPrice = productextra.GetExtraValueLocalizedDeltaPrices(_dataViewMode, productCode, attributeFQN, value); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetExtraValueLocalizedDeltaPrices(string productCode, string attributeFQN, string value) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.GetExtraValueLocalizedDeltaPricesClient(_dataViewMode, productCode, attributeFQN, value); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// /// /// List{} /// @@ -132,52 +85,25 @@ public ProductExtraResource(IApiContext apiContext, DataViewMode dataViewMode) /// var productExtraValueDeltaPrice = await productextra.GetExtraValueLocalizedDeltaPricesAsync(_dataViewMode, productCode, attributeFQN, value); /// /// - public virtual async Task> GetExtraValueLocalizedDeltaPricesAsync(string productCode, string attributeFQN, string value) + public virtual async Task> GetExtraValueLocalizedDeltaPricesAsync(string productCode, string attributeFQN, string value, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.GetExtraValueLocalizedDeltaPricesClient(_dataViewMode, productCode, attributeFQN, value); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// - /// - /// - /// - /// - /// var productextra = new ProductExtra(); - /// var productExtraValueDeltaPrice = productextra.GetExtraValueLocalizedDeltaPrice(_dataViewMode, productCode, attributeFQN, value, currencyCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice GetExtraValueLocalizedDeltaPrice(string productCode, string attributeFQN, string value, string currencyCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.GetExtraValueLocalizedDeltaPriceClient(_dataViewMode, productCode, attributeFQN, value, currencyCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// + /// /// /// /// @@ -187,48 +113,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice GetEx /// var productExtraValueDeltaPrice = await productextra.GetExtraValueLocalizedDeltaPriceAsync(_dataViewMode, productCode, attributeFQN, value, currencyCode, responseFields); /// /// - public virtual async Task GetExtraValueLocalizedDeltaPriceAsync(string productCode, string attributeFQN, string value, string currencyCode, string responseFields = null) + public virtual async Task GetExtraValueLocalizedDeltaPriceAsync(string productCode, string attributeFQN, string value, string currencyCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.GetExtraValueLocalizedDeltaPriceClient(_dataViewMode, productCode, attributeFQN, value, currencyCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of an extra attribute configuration for the product specified in the request. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var productextra = new ProductExtra(); - /// var productExtra = productextra.GetExtra(_dataViewMode, productCode, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtra GetExtra(string productCode, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.GetExtraClient(_dataViewMode, productCode, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of an extra attribute configuration for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -238,52 +139,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtra GetExtra(string prod /// var productExtra = await productextra.GetExtraAsync(_dataViewMode, productCode, attributeFQN, responseFields); /// /// - public virtual async Task GetExtraAsync(string productCode, string attributeFQN, string responseFields = null) + public virtual async Task GetExtraAsync(string productCode, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.GetExtraClient(_dataViewMode, productCode, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// The properties of the price difference between the product extra and the base product. - /// - /// - /// - /// - /// - /// var productextra = new ProductExtra(); - /// var productExtraValueDeltaPrice = productextra.AddExtraValueLocalizedDeltaPrice(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice AddExtraValueLocalizedDeltaPrice(Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice localizedDeltaPrice, string productCode, string attributeFQN, string value, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.AddExtraValueLocalizedDeltaPriceClient(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// The properties of the price difference between the product extra and the base product. + /// + /// + /// + /// + /// /// /// /// @@ -293,48 +167,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice AddEx /// var productExtraValueDeltaPrice = await productextra.AddExtraValueLocalizedDeltaPriceAsync(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value, responseFields); /// /// - public virtual async Task AddExtraValueLocalizedDeltaPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice localizedDeltaPrice, string productCode, string attributeFQN, string value, string responseFields = null) + public virtual async Task AddExtraValueLocalizedDeltaPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice localizedDeltaPrice, string productCode, string attributeFQN, string value, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.AddExtraValueLocalizedDeltaPriceClient(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Configure an extra attribute for the product specified in the request. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of an extra attribute to defined for a product that is associated with a product type that uses the extra. Setting up extras for a product enables shopper-entered information, such as initials for a monogram. - /// - /// - /// - /// - /// - /// var productextra = new ProductExtra(); - /// var productExtra = productextra.AddExtra(_dataViewMode, productExtra, productCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtra AddExtra(Mozu.Api.Contracts.ProductAdmin.ProductExtra productExtra, string productCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.AddExtraClient(_dataViewMode, productExtra, productCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Configure an extra attribute for the product specified in the request. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of an extra attribute to defined for a product that is associated with a product type that uses the extra. Setting up extras for a product enables shopper-entered information, such as initials for a monogram. + /// + /// + /// Properties of the product extra to configure for the specified product. /// /// /// @@ -344,50 +193,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtra AddExtra(Mozu.Api.Co /// var productExtra = await productextra.AddExtraAsync(_dataViewMode, productExtra, productCode, responseFields); /// /// - public virtual async Task AddExtraAsync(Mozu.Api.Contracts.ProductAdmin.ProductExtra productExtra, string productCode, string responseFields = null) + public virtual async Task AddExtraAsync(Mozu.Api.Contracts.ProductAdmin.ProductExtra productExtra, string productCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.AddExtraClient(_dataViewMode, productExtra, productCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. - /// The properties of the price difference between the product extra and the base product. - /// - /// List{} - /// - /// - /// - /// var productextra = new ProductExtra(); - /// var productExtraValueDeltaPrice = productextra.UpdateExtraValueLocalizedDeltaPrices(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateExtraValueLocalizedDeltaPrices(List localizedDeltaPrice, string productCode, string attributeFQN, string value) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.UpdateExtraValueLocalizedDeltaPricesClient(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. - /// The properties of the price difference between the product extra and the base product. + /// + /// + /// + /// /// /// List{} /// @@ -397,54 +220,26 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtra AddExtra(Mozu.Api.Co /// var productExtraValueDeltaPrice = await productextra.UpdateExtraValueLocalizedDeltaPricesAsync(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value); /// /// - public virtual async Task> UpdateExtraValueLocalizedDeltaPricesAsync(List localizedDeltaPrice, string productCode, string attributeFQN, string value) + public virtual async Task> UpdateExtraValueLocalizedDeltaPricesAsync(List localizedDeltaPrice, string productCode, string attributeFQN, string value, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.UpdateExtraValueLocalizedDeltaPricesClient(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// The properties of the price difference between the product extra and the base product. - /// - /// - /// - /// - /// - /// var productextra = new ProductExtra(); - /// var productExtraValueDeltaPrice = productextra.UpdateExtraValueLocalizedDeltaPrice(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value, currencyCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice UpdateExtraValueLocalizedDeltaPrice(Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice localizedDeltaPrice, string productCode, string attributeFQN, string value, string currencyCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.UpdateExtraValueLocalizedDeltaPriceClient(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value, currencyCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// The properties of the price difference between the product extra and the base product. + /// + /// + /// + /// + /// + /// /// /// /// @@ -454,50 +249,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice Updat /// var productExtraValueDeltaPrice = await productextra.UpdateExtraValueLocalizedDeltaPriceAsync(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value, currencyCode, responseFields); /// /// - public virtual async Task UpdateExtraValueLocalizedDeltaPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice localizedDeltaPrice, string productCode, string attributeFQN, string value, string currencyCode, string responseFields = null) + public virtual async Task UpdateExtraValueLocalizedDeltaPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductExtraValueDeltaPrice localizedDeltaPrice, string productCode, string attributeFQN, string value, string currencyCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.UpdateExtraValueLocalizedDeltaPriceClient(_dataViewMode, localizedDeltaPrice, productCode, attributeFQN, value, currencyCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the configuration of an extra attribute for the product specified in the request. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of an extra attribute to defined for a product that is associated with a product type that uses the extra. Setting up extras for a product enables shopper-entered information, such as initials for a monogram. - /// - /// - /// - /// - /// - /// var productextra = new ProductExtra(); - /// var productExtra = productextra.UpdateExtra(_dataViewMode, productExtra, productCode, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtra UpdateExtra(Mozu.Api.Contracts.ProductAdmin.ProductExtra productExtra, string productCode, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.UpdateExtraClient(_dataViewMode, productExtra, productCode, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the configuration of an extra attribute for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of an extra attribute to defined for a product that is associated with a product type that uses the extra. Setting up extras for a product enables shopper-entered information, such as initials for a monogram. + /// + /// + /// + /// Properties of the extra attribute to update for the specified product. /// /// /// @@ -507,45 +276,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductExtra UpdateExtra(Mozu.Api /// var productExtra = await productextra.UpdateExtraAsync(_dataViewMode, productExtra, productCode, attributeFQN, responseFields); /// /// - public virtual async Task UpdateExtraAsync(Mozu.Api.Contracts.ProductAdmin.ProductExtra productExtra, string productCode, string attributeFQN, string responseFields = null) + public virtual async Task UpdateExtraAsync(Mozu.Api.Contracts.ProductAdmin.ProductExtra productExtra, string productCode, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.UpdateExtraClient(_dataViewMode, productExtra, productCode, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Delete a product extra configuration for the product specified in the request. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// - /// - /// - /// - /// - /// var productextra = new ProductExtra(); - /// productextra.DeleteExtra(_dataViewMode, productCode, attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteExtra(string productCode, string attributeFQN) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.DeleteExtraClient(_dataViewMode, productCode, attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Delete a product extra configuration for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// + /// /// /// /// @@ -555,48 +301,23 @@ public virtual void DeleteExtra(string productCode, string attributeFQN) /// await productextra.DeleteExtraAsync(_dataViewMode, productCode, attributeFQN); /// /// - public virtual async Task DeleteExtraAsync(string productCode, string attributeFQN) + public virtual async Task DeleteExtraAsync(string productCode, string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.DeleteExtraClient(_dataViewMode, productCode, attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var productextra = new ProductExtra(); - /// productextra.DeleteExtraValueLocalizedDeltaPrice(_dataViewMode, productCode, attributeFQN, value, currencyCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteExtraValueLocalizedDeltaPrice(string productCode, string attributeFQN, string value, string currencyCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.DeleteExtraValueLocalizedDeltaPriceClient(_dataViewMode, productCode, attributeFQN, value, currencyCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. + /// + /// + /// + /// /// /// /// @@ -606,12 +327,12 @@ public virtual void DeleteExtraValueLocalizedDeltaPrice(string productCode, stri /// await productextra.DeleteExtraValueLocalizedDeltaPriceAsync(_dataViewMode, productCode, attributeFQN, value, currencyCode); /// /// - public virtual async Task DeleteExtraValueLocalizedDeltaPriceAsync(string productCode, string attributeFQN, string value, string currencyCode) + public virtual async Task DeleteExtraValueLocalizedDeltaPriceAsync(string productCode, string attributeFQN, string value, string currencyCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductExtraClient.DeleteExtraValueLocalizedDeltaPriceClient(_dataViewMode, productCode, attributeFQN, value, currencyCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductOptionResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductOptionResource.cs old mode 100644 new mode 100755 index 5544f889..f3839b30 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductOptionResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductOptionResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Products { @@ -44,34 +45,11 @@ public ProductOptionResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of all option attributes configured for the product specified in the request. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// - /// List{} - /// - /// - /// - /// var productoption = new ProductOption(); - /// var productOption = productoption.GetOptions(_dataViewMode, productCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetOptions(string productCode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.GetOptionsClient(_dataViewMode, productCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of all option attributes configured for the product specified in the request. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// List{} /// @@ -81,48 +59,23 @@ public ProductOptionResource(IApiContext apiContext, DataViewMode dataViewMode) /// var productOption = await productoption.GetOptionsAsync(_dataViewMode, productCode); /// /// - public virtual async Task> GetOptionsAsync(string productCode) + public virtual async Task> GetOptionsAsync(string productCode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.GetOptionsClient(_dataViewMode, productCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of an option attribute configuration for the specified product. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var productoption = new ProductOption(); - /// var productOption = productoption.GetOption(_dataViewMode, productCode, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductOption GetOption(string productCode, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.GetOptionClient(_dataViewMode, productCode, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of an option attribute configuration for the specified product. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -132,48 +85,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductOption GetOption(string pr /// var productOption = await productoption.GetOptionAsync(_dataViewMode, productCode, attributeFQN, responseFields); /// /// - public virtual async Task GetOptionAsync(string productCode, string attributeFQN, string responseFields = null) + public virtual async Task GetOptionAsync(string productCode, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.GetOptionClient(_dataViewMode, productCode, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Configures an option attribute for the product specified in the request. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. - /// - /// - /// - /// - /// - /// var productoption = new ProductOption(); - /// var productOption = productoption.AddOption(_dataViewMode, productOption, productCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductOption AddOption(Mozu.Api.Contracts.ProductAdmin.ProductOption productOption, string productCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.AddOptionClient(_dataViewMode, productOption, productCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Configures an option attribute for the product specified in the request. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. + /// + /// + /// Properties of the option attribute to define for the product. /// /// /// @@ -183,50 +111,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductOption AddOption(Mozu.Api. /// var productOption = await productoption.AddOptionAsync(_dataViewMode, productOption, productCode, responseFields); /// /// - public virtual async Task AddOptionAsync(Mozu.Api.Contracts.ProductAdmin.ProductOption productOption, string productCode, string responseFields = null) + public virtual async Task AddOptionAsync(Mozu.Api.Contracts.ProductAdmin.ProductOption productOption, string productCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.AddOptionClient(_dataViewMode, productOption, productCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of an option attribute configured for a product. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. - /// - /// - /// - /// - /// - /// var productoption = new ProductOption(); - /// var productOption = productoption.UpdateOption(_dataViewMode, productOption, productCode, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductOption UpdateOption(Mozu.Api.Contracts.ProductAdmin.ProductOption productOption, string productCode, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.UpdateOptionClient(_dataViewMode, productOption, productCode, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of an option attribute configured for a product. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// Properties of the product option to create such as attribute detail, fully qualified name, and list of product option values. + /// + /// + /// + /// Properties of the product option attribute configuration to update. /// /// /// @@ -236,45 +138,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductOption UpdateOption(Mozu.A /// var productOption = await productoption.UpdateOptionAsync(_dataViewMode, productOption, productCode, attributeFQN, responseFields); /// /// - public virtual async Task UpdateOptionAsync(Mozu.Api.Contracts.ProductAdmin.ProductOption productOption, string productCode, string attributeFQN, string responseFields = null) + public virtual async Task UpdateOptionAsync(Mozu.Api.Contracts.ProductAdmin.ProductOption productOption, string productCode, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.UpdateOptionClient(_dataViewMode, productOption, productCode, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the configuration of an option attribute for the product specified in the request. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// - /// - /// - /// - /// - /// var productoption = new ProductOption(); - /// productoption.DeleteOption(_dataViewMode, productCode, attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteOption(string productCode, string attributeFQN) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.DeleteOptionClient(_dataViewMode, productCode, attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the configuration of an option attribute for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// + /// /// /// /// @@ -284,12 +163,12 @@ public virtual void DeleteOption(string productCode, string attributeFQN) /// await productoption.DeleteOptionAsync(_dataViewMode, productCode, attributeFQN); /// /// - public virtual async Task DeleteOptionAsync(string productCode, string attributeFQN) + public virtual async Task DeleteOptionAsync(string productCode, string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductOptionClient.DeleteOptionClient(_dataViewMode, productCode, attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductPropertyResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductPropertyResource.cs old mode 100644 new mode 100755 index 71d33c2f..dd656563 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductPropertyResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductPropertyResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Products { @@ -44,34 +45,11 @@ public ProductPropertyResource(IApiContext apiContext, DataViewMode dataViewMode _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of the property attributes configured for the product specified in the request. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// - /// List{} - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// var productProperty = productproperty.GetProperties(_dataViewMode, productCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetProperties(string productCode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.GetPropertiesClient(_dataViewMode, productCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the property attributes configured for the product specified in the request. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// /// /// List{} /// @@ -81,48 +59,23 @@ public ProductPropertyResource(IApiContext apiContext, DataViewMode dataViewMode /// var productProperty = await productproperty.GetPropertiesAsync(_dataViewMode, productCode); /// /// - public virtual async Task> GetPropertiesAsync(string productCode) + public virtual async Task> GetPropertiesAsync(string productCode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.GetPropertiesClient(_dataViewMode, productCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of property values for localized content. This content is set by the locale code. - /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. - /// - /// List{} - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// var productPropertyValueLocalizedContent = productproperty.GetPropertyValueLocalizedContents(_dataViewMode, productCode, attributeFQN, value); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetPropertyValueLocalizedContents(string productCode, string attributeFQN, string value) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.GetPropertyValueLocalizedContentsClient(_dataViewMode, productCode, attributeFQN, value); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of property values for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// /// /// List{} /// @@ -132,52 +85,25 @@ public ProductPropertyResource(IApiContext apiContext, DataViewMode dataViewMode /// var productPropertyValueLocalizedContent = await productproperty.GetPropertyValueLocalizedContentsAsync(_dataViewMode, productCode, attributeFQN, value); /// /// - public virtual async Task> GetPropertyValueLocalizedContentsAsync(string productCode, string attributeFQN, string value) + public virtual async Task> GetPropertyValueLocalizedContentsAsync(string productCode, string attributeFQN, string value, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.GetPropertyValueLocalizedContentsClient(_dataViewMode, productCode, attributeFQN, value); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the property value for localized content. This content is set by the locale code. - /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// - /// - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// var productPropertyValueLocalizedContent = productproperty.GetPropertyValueLocalizedContent(_dataViewMode, productCode, attributeFQN, value, localeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedContent GetPropertyValueLocalizedContent(string productCode, string attributeFQN, string value, string localeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.GetPropertyValueLocalizedContentClient(_dataViewMode, productCode, attributeFQN, value, localeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the property value for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// + /// /// /// /// @@ -187,48 +113,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedCont /// var productPropertyValueLocalizedContent = await productproperty.GetPropertyValueLocalizedContentAsync(_dataViewMode, productCode, attributeFQN, value, localeCode, responseFields); /// /// - public virtual async Task GetPropertyValueLocalizedContentAsync(string productCode, string attributeFQN, string value, string localeCode, string responseFields = null) + public virtual async Task GetPropertyValueLocalizedContentAsync(string productCode, string attributeFQN, string value, string localeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.GetPropertyValueLocalizedContentClient(_dataViewMode, productCode, attributeFQN, value, localeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a property attribute configuration for the product specified in the request. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// var productProperty = productproperty.GetProperty(_dataViewMode, productCode, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductProperty GetProperty(string productCode, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.GetPropertyClient(_dataViewMode, productCode, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a property attribute configuration for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -238,52 +139,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductProperty GetProperty(strin /// var productProperty = await productproperty.GetPropertyAsync(_dataViewMode, productCode, attributeFQN, responseFields); /// /// - public virtual async Task GetPropertyAsync(string productCode, string attributeFQN, string responseFields = null) + public virtual async Task GetPropertyAsync(string productCode, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.GetPropertyClient(_dataViewMode, productCode, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a property value for localized content. This content is set by the locale code. - /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// var productPropertyValueLocalizedContent = productproperty.AddPropertyValueLocalizedContent(_dataViewMode, localizedContent, productCode, attributeFQN, value, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedContent AddPropertyValueLocalizedContent(Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedContent localizedContent, string productCode, string attributeFQN, string value, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.AddPropertyValueLocalizedContentClient(_dataViewMode, localizedContent, productCode, attributeFQN, value, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a property value for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// Use this field to include those fields which are not included by default. + /// + /// + /// + /// + /// /// /// /// @@ -293,48 +167,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedCont /// var productPropertyValueLocalizedContent = await productproperty.AddPropertyValueLocalizedContentAsync(_dataViewMode, localizedContent, productCode, attributeFQN, value, responseFields); /// /// - public virtual async Task AddPropertyValueLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedContent localizedContent, string productCode, string attributeFQN, string value, string responseFields = null) + public virtual async Task AddPropertyValueLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedContent localizedContent, string productCode, string attributeFQN, string value, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.AddPropertyValueLocalizedContentClient(_dataViewMode, localizedContent, productCode, attributeFQN, value, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Configures a property attribute for the product specified in the request. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// Details of a property defined for a product. - /// - /// - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// var productProperty = productproperty.AddProperty(_dataViewMode, productProperty, productCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductProperty AddProperty(Mozu.Api.Contracts.ProductAdmin.ProductProperty productProperty, string productCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.AddPropertyClient(_dataViewMode, productProperty, productCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Configures a property attribute for the product specified in the request. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// Details of a property defined for a product. + /// + /// + /// Properties of the property attribute to configure for a product. /// /// /// @@ -344,50 +193,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductProperty AddProperty(Mozu. /// var productProperty = await productproperty.AddPropertyAsync(_dataViewMode, productProperty, productCode, responseFields); /// /// - public virtual async Task AddPropertyAsync(Mozu.Api.Contracts.ProductAdmin.ProductProperty productProperty, string productCode, string responseFields = null) + public virtual async Task AddPropertyAsync(Mozu.Api.Contracts.ProductAdmin.ProductProperty productProperty, string productCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.AddPropertyClient(_dataViewMode, productProperty, productCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates all property values for localized content. This content is set by the locale code. - /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. - /// Content of the product property value in the language defined for the locale code. - /// - /// List{} - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// var productPropertyValueLocalizedContent = productproperty.UpdatePropertyValueLocalizedContents(_dataViewMode, localizedContent, productCode, attributeFQN, value); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdatePropertyValueLocalizedContents(List localizedContent, string productCode, string attributeFQN, string value) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.UpdatePropertyValueLocalizedContentsClient(_dataViewMode, localizedContent, productCode, attributeFQN, value); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates all property values for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. - /// Content of the product property value in the language defined for the locale code. + /// + /// + /// + /// /// /// List{} /// @@ -397,54 +220,26 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductProperty AddProperty(Mozu. /// var productPropertyValueLocalizedContent = await productproperty.UpdatePropertyValueLocalizedContentsAsync(_dataViewMode, localizedContent, productCode, attributeFQN, value); /// /// - public virtual async Task> UpdatePropertyValueLocalizedContentsAsync(List localizedContent, string productCode, string attributeFQN, string value) + public virtual async Task> UpdatePropertyValueLocalizedContentsAsync(List localizedContent, string productCode, string attributeFQN, string value, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.UpdatePropertyValueLocalizedContentsClient(_dataViewMode, localizedContent, productCode, attributeFQN, value); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the property value for localized content. This content is set by the locale code. - /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// Content of the product property value in the language defined for the locale code. - /// - /// - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// var productPropertyValueLocalizedContent = productproperty.UpdatePropertyValueLocalizedContent(_dataViewMode, localizedContent, productCode, attributeFQN, value, localeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedContent UpdatePropertyValueLocalizedContent(Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedContent localizedContent, string productCode, string attributeFQN, string value, string localeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.UpdatePropertyValueLocalizedContentClient(_dataViewMode, localizedContent, productCode, attributeFQN, value, localeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the property value for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. - /// Content of the product property value in the language defined for the locale code. + /// + /// + /// + /// + /// + /// /// /// /// @@ -454,50 +249,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedCont /// var productPropertyValueLocalizedContent = await productproperty.UpdatePropertyValueLocalizedContentAsync(_dataViewMode, localizedContent, productCode, attributeFQN, value, localeCode, responseFields); /// /// - public virtual async Task UpdatePropertyValueLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedContent localizedContent, string productCode, string attributeFQN, string value, string localeCode, string responseFields = null) + public virtual async Task UpdatePropertyValueLocalizedContentAsync(Mozu.Api.Contracts.ProductAdmin.ProductPropertyValueLocalizedContent localizedContent, string productCode, string attributeFQN, string value, string localeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.UpdatePropertyValueLocalizedContentClient(_dataViewMode, localizedContent, productCode, attributeFQN, value, localeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update one or more details of a property attribute configuration for the product specified in the request. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// Details of a property defined for a product. - /// - /// - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// var productProperty = productproperty.UpdateProperty(_dataViewMode, productProperty, productCode, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductProperty UpdateProperty(Mozu.Api.Contracts.ProductAdmin.ProductProperty productProperty, string productCode, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.UpdatePropertyClient(_dataViewMode, productProperty, productCode, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update one or more details of a property attribute configuration for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// Details of a property defined for a product. + /// + /// + /// + /// Details of the property attribute to update for the product configuration. /// /// /// @@ -507,45 +276,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductProperty UpdateProperty(Mo /// var productProperty = await productproperty.UpdatePropertyAsync(_dataViewMode, productProperty, productCode, attributeFQN, responseFields); /// /// - public virtual async Task UpdatePropertyAsync(Mozu.Api.Contracts.ProductAdmin.ProductProperty productProperty, string productCode, string attributeFQN, string responseFields = null) + public virtual async Task UpdatePropertyAsync(Mozu.Api.Contracts.ProductAdmin.ProductProperty productProperty, string productCode, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.UpdatePropertyClient(_dataViewMode, productProperty, productCode, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the configuration of a property attribute for the product specified in the request. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// - /// - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// productproperty.DeleteProperty(_dataViewMode, productCode, attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProperty(string productCode, string attributeFQN) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.DeletePropertyClient(_dataViewMode, productCode, attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the configuration of a property attribute for the product specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// + /// /// /// /// @@ -555,48 +301,23 @@ public virtual void DeleteProperty(string productCode, string attributeFQN) /// await productproperty.DeletePropertyAsync(_dataViewMode, productCode, attributeFQN); /// /// - public virtual async Task DeletePropertyAsync(string productCode, string attributeFQN) + public virtual async Task DeletePropertyAsync(string productCode, string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.DeletePropertyClient(_dataViewMode, productCode, attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the property value for localized content. This content is set by the locale code. - /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. - /// - /// - /// - /// - /// - /// var productproperty = new ProductProperty(); - /// productproperty.DeletePropertyValueLocalizedContent(_dataViewMode, productCode, attributeFQN, value, localeCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeletePropertyValueLocalizedContent(string productCode, string attributeFQN, string value, string localeCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.DeletePropertyValueLocalizedContentClient(_dataViewMode, productCode, attributeFQN, value, localeCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the property value for localized content. This content is set by the locale code. + /// /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// + /// /// /// /// @@ -606,12 +327,12 @@ public virtual void DeletePropertyValueLocalizedContent(string productCode, stri /// await productproperty.DeletePropertyValueLocalizedContentAsync(_dataViewMode, productCode, attributeFQN, value, localeCode); /// /// - public virtual async Task DeletePropertyValueLocalizedContentAsync(string productCode, string attributeFQN, string value, string localeCode) + public virtual async Task DeletePropertyValueLocalizedContentAsync(string productCode, string attributeFQN, string value, string localeCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductPropertyClient.DeletePropertyValueLocalizedContentClient(_dataViewMode, productCode, attributeFQN, value, localeCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductVariationResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductVariationResource.cs old mode 100644 new mode 100755 index 0a6e1992..163d13b7 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductVariationResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/Products/ProductVariationResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin.Products { @@ -44,36 +45,12 @@ public ProductVariationResource(IApiContext apiContext, DataViewMode dataViewMod _dataViewMode = dataViewMode; } - /// - /// Retrieves a collection of the localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// - /// List{} - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationDeltaPrice = productvariation.GetProductVariationLocalizedDeltaPrices(_dataViewMode, productCode, variationKey); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetProductVariationLocalizedDeltaPrices(string productCode, string variationKey) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationLocalizedDeltaPricesClient(_dataViewMode, productCode, variationKey); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of the localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// /// /// List{} /// @@ -83,50 +60,24 @@ public ProductVariationResource(IApiContext apiContext, DataViewMode dataViewMod /// var productVariationDeltaPrice = await productvariation.GetProductVariationLocalizedDeltaPricesAsync(_dataViewMode, productCode, variationKey); /// /// - public virtual async Task> GetProductVariationLocalizedDeltaPricesAsync(string productCode, string variationKey) + public virtual async Task> GetProductVariationLocalizedDeltaPricesAsync(string productCode, string variationKey, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationLocalizedDeltaPricesClient(_dataViewMode, productCode, variationKey); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationDeltaPrice = productvariation.GetProductVariationLocalizedDeltaPrice(_dataViewMode, productCode, variationKey, currencyCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice GetProductVariationLocalizedDeltaPrice(string productCode, string variationKey, string currencyCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationLocalizedDeltaPriceClient(_dataViewMode, productCode, variationKey, currencyCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// + /// /// /// /// @@ -136,46 +87,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice GetPro /// var productVariationDeltaPrice = await productvariation.GetProductVariationLocalizedDeltaPriceAsync(_dataViewMode, productCode, variationKey, currencyCode, responseFields); /// /// - public virtual async Task GetProductVariationLocalizedDeltaPriceAsync(string productCode, string variationKey, string currencyCode, string responseFields = null) + public virtual async Task GetProductVariationLocalizedDeltaPriceAsync(string productCode, string variationKey, string currencyCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationLocalizedDeltaPriceClient(_dataViewMode, productCode, variationKey, currencyCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of details of the localized price values for a product variation. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// - /// List{} - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationFixedPrice = productvariation.GetProductVariationLocalizedPrices(_dataViewMode, productCode, variationKey); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetProductVariationLocalizedPrices(string productCode, string variationKey) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationLocalizedPricesClient(_dataViewMode, productCode, variationKey); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of details of the localized price values for a product variation. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// /// /// List{} /// @@ -185,50 +112,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice GetPro /// var productVariationFixedPrice = await productvariation.GetProductVariationLocalizedPricesAsync(_dataViewMode, productCode, variationKey); /// /// - public virtual async Task> GetProductVariationLocalizedPricesAsync(string productCode, string variationKey) + public virtual async Task> GetProductVariationLocalizedPricesAsync(string productCode, string variationKey, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationLocalizedPricesClient(_dataViewMode, productCode, variationKey); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the localized price value for a product variation and a specific localized currency. - /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationFixedPrice = productvariation.GetProductVariationLocalizedPrice(_dataViewMode, productCode, variationKey, currencyCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice GetProductVariationLocalizedPrice(string productCode, string variationKey, string currencyCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationLocalizedPriceClient(_dataViewMode, productCode, variationKey, currencyCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the localized price value for a product variation and a specific localized currency. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// + /// /// /// /// @@ -238,47 +139,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice GetPro /// var productVariationFixedPrice = await productvariation.GetProductVariationLocalizedPriceAsync(_dataViewMode, productCode, variationKey, currencyCode, responseFields); /// /// - public virtual async Task GetProductVariationLocalizedPriceAsync(string productCode, string variationKey, string currencyCode, string responseFields = null) + public virtual async Task GetProductVariationLocalizedPriceAsync(string productCode, string variationKey, string currencyCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationLocalizedPriceClient(_dataViewMode, productCode, variationKey, currencyCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a product variation based on the supplied product code and variation key. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariation = productvariation.GetProductVariation(_dataViewMode, productCode, variationKey, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariation GetProductVariation(string productCode, string variationKey, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationClient(_dataViewMode, productCode, variationKey, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a product variation based on the supplied product code and variation key. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// System-generated key that represents the attribute values that uniquely identify a specific product variation. /// /// @@ -289,54 +165,26 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariation GetProductVariat /// var productVariation = await productvariation.GetProductVariationAsync(_dataViewMode, productCode, variationKey, responseFields); /// /// - public virtual async Task GetProductVariationAsync(string productCode, string variationKey, string responseFields = null) + public virtual async Task GetProductVariationAsync(string productCode, string variationKey, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationClient(_dataViewMode, productCode, variationKey, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of the product variations configured for the specified product code. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationPagedCollection = productvariation.GetProductVariations(_dataViewMode, productCode, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationPagedCollection GetProductVariations(string productCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationsClient(_dataViewMode, productCode, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the product variations configured for the specified product code. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// /// @@ -346,50 +194,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationPagedCollection G /// var productVariationPagedCollection = await productvariation.GetProductVariationsAsync(_dataViewMode, productCode, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetProductVariationsAsync(string productCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetProductVariationsAsync(string productCode, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.GetProductVariationsClient(_dataViewMode, productCode, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2". - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationDeltaPrice = productvariation.AddProductVariationLocalizedDeltaPrice(_dataViewMode, localizedDeltaPrice, productCode, variationKey, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice AddProductVariationLocalizedDeltaPrice(Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice localizedDeltaPrice, string productCode, string variationKey, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.AddProductVariationLocalizedDeltaPriceClient(_dataViewMode, localizedDeltaPrice, productCode, variationKey, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2". + /// + /// + /// + /// /// /// /// @@ -399,50 +221,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice AddPro /// var productVariationDeltaPrice = await productvariation.AddProductVariationLocalizedDeltaPriceAsync(_dataViewMode, localizedDeltaPrice, productCode, variationKey, responseFields); /// /// - public virtual async Task AddProductVariationLocalizedDeltaPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice localizedDeltaPrice, string productCode, string variationKey, string responseFields = null) + public virtual async Task AddProductVariationLocalizedDeltaPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice localizedDeltaPrice, string productCode, string variationKey, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.AddProductVariationLocalizedDeltaPriceClient(_dataViewMode, localizedDeltaPrice, productCode, variationKey, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds the localized price value for a product variation and a specific localized currency. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The details of the product variation localized price. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationFixedPrice = productvariation.AddProductVariationLocalizedPrice(_dataViewMode, localizedPrice, productCode, variationKey, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice AddProductVariationLocalizedPrice(Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice localizedPrice, string productCode, string variationKey, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.AddProductVariationLocalizedPriceClient(_dataViewMode, localizedPrice, productCode, variationKey, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds the localized price value for a product variation and a specific localized currency. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The details of the product variation localized price. + /// + /// + /// + /// /// /// /// @@ -452,48 +248,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice AddPro /// var productVariationFixedPrice = await productvariation.AddProductVariationLocalizedPriceAsync(_dataViewMode, localizedPrice, productCode, variationKey, responseFields); /// /// - public virtual async Task AddProductVariationLocalizedPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice localizedPrice, string productCode, string variationKey, string responseFields = null) + public virtual async Task AddProductVariationLocalizedPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice localizedPrice, string productCode, string variationKey, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.AddProductVariationLocalizedPriceClient(_dataViewMode, localizedPrice, productCode, variationKey, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates all localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2". - /// - /// List{} - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationDeltaPrice = productvariation.UpdateProductVariationLocalizedDeltaPrices(_dataViewMode, localizedDeltaPrice, productCode, variationKey); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateProductVariationLocalizedDeltaPrices(List localizedDeltaPrice, string productCode, string variationKey) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationLocalizedDeltaPricesClient(_dataViewMode, localizedDeltaPrice, productCode, variationKey); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates all localized delta price values for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2". + /// + /// + /// /// /// List{} /// @@ -503,52 +274,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice AddPro /// var productVariationDeltaPrice = await productvariation.UpdateProductVariationLocalizedDeltaPricesAsync(_dataViewMode, localizedDeltaPrice, productCode, variationKey); /// /// - public virtual async Task> UpdateProductVariationLocalizedDeltaPricesAsync(List localizedDeltaPrice, string productCode, string variationKey) + public virtual async Task> UpdateProductVariationLocalizedDeltaPricesAsync(List localizedDeltaPrice, string productCode, string variationKey, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationLocalizedDeltaPricesClient(_dataViewMode, localizedDeltaPrice, productCode, variationKey); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2". - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationDeltaPrice = productvariation.UpdateProductVariationLocalizedDeltaPrice(_dataViewMode, localizedDeltaPrice, productCode, variationKey, currencyCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice UpdateProductVariationLocalizedDeltaPrice(Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice localizedDeltaPrice, string productCode, string variationKey, string currencyCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationLocalizedDeltaPriceClient(_dataViewMode, localizedDeltaPrice, productCode, variationKey, currencyCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2". + /// + /// + /// + /// + /// /// /// /// @@ -558,48 +302,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice Update /// var productVariationDeltaPrice = await productvariation.UpdateProductVariationLocalizedDeltaPriceAsync(_dataViewMode, localizedDeltaPrice, productCode, variationKey, currencyCode, responseFields); /// /// - public virtual async Task UpdateProductVariationLocalizedDeltaPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice localizedDeltaPrice, string productCode, string variationKey, string currencyCode, string responseFields = null) + public virtual async Task UpdateProductVariationLocalizedDeltaPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice localizedDeltaPrice, string productCode, string variationKey, string currencyCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationLocalizedDeltaPriceClient(_dataViewMode, localizedDeltaPrice, productCode, variationKey, currencyCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a list of localized price values for a product variation. - /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The details of the product variation localized price. - /// - /// List{} - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationFixedPrice = productvariation.UpdateProductVariationLocalizedPrices(_dataViewMode, localizedPrice, productCode, variationKey); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateProductVariationLocalizedPrices(List localizedPrice, string productCode, string variationKey) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationLocalizedPricesClient(_dataViewMode, localizedPrice, productCode, variationKey); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a list of localized price values for a product variation. + /// /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The details of the product variation localized price. + /// + /// + /// /// /// List{} /// @@ -609,52 +328,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationDeltaPrice Update /// var productVariationFixedPrice = await productvariation.UpdateProductVariationLocalizedPricesAsync(_dataViewMode, localizedPrice, productCode, variationKey); /// /// - public virtual async Task> UpdateProductVariationLocalizedPricesAsync(List localizedPrice, string productCode, string variationKey) + public virtual async Task> UpdateProductVariationLocalizedPricesAsync(List localizedPrice, string productCode, string variationKey, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationLocalizedPricesClient(_dataViewMode, localizedPrice, productCode, variationKey); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the localized price value for a product variation and a specific localized currency. - /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The details of the product variation localized price. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationFixedPrice = productvariation.UpdateProductVariationLocalizedPrice(_dataViewMode, localizedPrice, productCode, variationKey, currencyCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice UpdateProductVariationLocalizedPrice(Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice localizedPrice, string productCode, string variationKey, string currencyCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationLocalizedPriceClient(_dataViewMode, localizedPrice, productCode, variationKey, currencyCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the localized price value for a product variation and a specific localized currency. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// The details of the product variation localized price. + /// + /// + /// + /// + /// /// /// /// @@ -664,50 +356,24 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice Update /// var productVariationFixedPrice = await productvariation.UpdateProductVariationLocalizedPriceAsync(_dataViewMode, localizedPrice, productCode, variationKey, currencyCode, responseFields); /// /// - public virtual async Task UpdateProductVariationLocalizedPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice localizedPrice, string productCode, string variationKey, string currencyCode, string responseFields = null) + public virtual async Task UpdateProductVariationLocalizedPriceAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationFixedPrice localizedPrice, string productCode, string variationKey, string currencyCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationLocalizedPriceClient(_dataViewMode, localizedPrice, productCode, variationKey, currencyCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Modifies the details of a variation, based on the supplied variation key, for the specified product code. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// Properties of a specific product variation. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariation = productvariation.UpdateProductVariation(_dataViewMode, productVariation, productCode, variationKey, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariation UpdateProductVariation(Mozu.Api.Contracts.ProductAdmin.ProductVariation productVariation, string productCode, string variationKey, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationClient(_dataViewMode, productVariation, productCode, variationKey, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Modifies the details of a variation, based on the supplied variation key, for the specified product code. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// Properties of a specific product variation. + /// Wrapper for the properties of the specified product variation. /// /// /// @@ -717,48 +383,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariation UpdateProductVar /// var productVariation = await productvariation.UpdateProductVariationAsync(_dataViewMode, productVariation, productCode, variationKey, responseFields); /// /// - public virtual async Task UpdateProductVariationAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariation productVariation, string productCode, string variationKey, string responseFields = null) + public virtual async Task UpdateProductVariationAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariation productVariation, string productCode, string variationKey, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationClient(_dataViewMode, productVariation, productCode, variationKey, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Modifies the collection of variations for the specified product code. Because this PUT replaces the existing resource, supply all information necessary to maintain for the product variation. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Collection of variations configured for a product. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// var productVariationCollection = productvariation.UpdateProductVariations(_dataViewMode, productVariations, productCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationCollection UpdateProductVariations(Mozu.Api.Contracts.ProductAdmin.ProductVariationCollection productVariations, string productCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationsClient(_dataViewMode, productVariations, productCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Modifies the collection of variations for the specified product code. Because this PUT replaces the existing resource, supply all information necessary to maintain for the product variation. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Collection of variations configured for a product. + /// + /// + /// Wrapper for the collection of variations configured for the specified product code. /// /// /// @@ -768,44 +409,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.ProductVariationCollection Update /// var productVariationCollection = await productvariation.UpdateProductVariationsAsync(_dataViewMode, productVariations, productCode, responseFields); /// /// - public virtual async Task UpdateProductVariationsAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationCollection productVariations, string productCode, string responseFields = null) + public virtual async Task UpdateProductVariationsAsync(Mozu.Api.Contracts.ProductAdmin.ProductVariationCollection productVariations, string productCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.UpdateProductVariationsClient(_dataViewMode, productVariations, productCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a variation, based on the supplied variation key, for the specified product code. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// productvariation.DeleteProductVariation(_dataViewMode, productCode, variationKey); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProductVariation(string productCode, string variationKey) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.DeleteProductVariationClient(_dataViewMode, productCode, variationKey); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a variation, based on the supplied variation key, for the specified product code. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// System-generated key that represents the attribute values that uniquely identify a specific product variation. /// /// @@ -816,46 +434,22 @@ public virtual void DeleteProductVariation(string productCode, string variationK /// await productvariation.DeleteProductVariationAsync(_dataViewMode, productCode, variationKey); /// /// - public virtual async Task DeleteProductVariationAsync(string productCode, string variationKey) + public virtual async Task DeleteProductVariationAsync(string productCode, string variationKey, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.DeleteProductVariationClient(_dataViewMode, productCode, variationKey); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. - /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// productvariation.DeleteProductVariationLocalizedDeltaPrice(_dataViewMode, productCode, variationKey, currencyCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProductVariationLocalizedDeltaPrice(string productCode, string variationKey, string currencyCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.DeleteProductVariationLocalizedDeltaPriceClient(_dataViewMode, productCode, variationKey, currencyCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// /// /// /// @@ -865,46 +459,22 @@ public virtual void DeleteProductVariationLocalizedDeltaPrice(string productCode /// await productvariation.DeleteProductVariationLocalizedDeltaPriceAsync(_dataViewMode, productCode, variationKey, currencyCode); /// /// - public virtual async Task DeleteProductVariationLocalizedDeltaPriceAsync(string productCode, string variationKey, string currencyCode) + public virtual async Task DeleteProductVariationLocalizedDeltaPriceAsync(string productCode, string variationKey, string currencyCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.DeleteProductVariationLocalizedDeltaPriceClient(_dataViewMode, productCode, variationKey, currencyCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the localized price value for a product variation and a specific localized currency. - /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. - /// - /// - /// - /// - /// - /// var productvariation = new ProductVariation(); - /// productvariation.DeleteProductVariationLocalizedPrice(_dataViewMode, productCode, variationKey, currencyCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProductVariationLocalizedPrice(string productCode, string variationKey, string currencyCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.DeleteProductVariationLocalizedPriceClient(_dataViewMode, productCode, variationKey, currencyCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the localized price value for a product variation and a specific localized currency. + /// /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// /// /// /// @@ -914,12 +484,12 @@ public virtual void DeleteProductVariationLocalizedPrice(string productCode, str /// await productvariation.DeleteProductVariationLocalizedPriceAsync(_dataViewMode, productCode, variationKey, currencyCode); /// /// - public virtual async Task DeleteProductVariationLocalizedPriceAsync(string productCode, string variationKey, string currencyCode) + public virtual async Task DeleteProductVariationLocalizedPriceAsync(string productCode, string variationKey, string currencyCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.Products.ProductVariationClient.DeleteProductVariationLocalizedPriceClient(_dataViewMode, productCode, variationKey, currencyCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/PublishingScopeResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/PublishingScopeResource.cs old mode 100644 new mode 100755 index 50787440..b58bab58 --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/PublishingScopeResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/PublishingScopeResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { /// - /// Use the Product Publishing resource to publish or discard pending changes to products in a master catalog, or to add or remove pending changes to and from product publish sets.You can use product publish sets to group pending product changes together and publish them all at the same time. + /// Use the Product Publishing resource to publish or discard pending changes to product definitions in the master catalog. /// public partial class PublishingScopeResource { /// @@ -44,37 +45,12 @@ public PublishingScopeResource(IApiContext apiContext, DataViewMode dataViewMode _dataViewMode = dataViewMode; } - /// - /// Retrieves the details of the specified product publish set. - /// - /// The unique identifier of the publish set. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var publishingscope = new PublishingScope(); - /// var publishSet = publishingscope.GetPublishSet( publishSetCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PublishSet GetPublishSet(string publishSetCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.GetPublishSetClient( publishSetCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified product publish set. + /// /// - /// The unique identifier of the publish set. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} /// /// @@ -85,45 +61,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PublishSet GetPublishSet(string p /// var publishSet = await publishingscope.GetPublishSetAsync( publishSetCode, responseFields); /// /// - public virtual async Task GetPublishSetAsync(string publishSetCode, string responseFields = null) + public virtual async Task GetPublishSetAsync(string publishSetCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.GetPublishSetClient( publishSetCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of product publish sets and their properties, including the amount of pending product changes that are included in each one. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var publishingscope = new PublishingScope(); - /// var publishSetCollection = publishingscope.GetPublishSets( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PublishSetCollection GetPublishSets(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.GetPublishSetsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of product publish sets and their properties, including the amount of pending product changes that are included in each one. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// {} /// /// @@ -134,45 +86,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PublishSetCollection GetPublishSe /// var publishSetCollection = await publishingscope.GetPublishSetsAsync( responseFields); /// /// - public virtual async Task GetPublishSetsAsync(string responseFields = null) + public virtual async Task GetPublishSetsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.GetPublishSetsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the draft version of product changes (pending product changes) for each product code specified in the request. - /// - /// {} - /// Describes the scope of the product publishing update, which can include individual product codes or all pending changes. - /// - /// - /// - /// - /// - /// var publishingscope = new PublishingScope(); - /// publishingscope.DiscardDrafts(_dataViewMode, publishScope); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DiscardDrafts(Mozu.Api.Contracts.ProductAdmin.PublishingScope publishScope) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.DiscardDraftsClient(_dataViewMode, publishScope); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the draft version of product changes (pending product changes) for each product code specified in the request. + /// /// /// {} - /// Describes the scope of the product publishing update, which can include individual product codes or all pending changes. + /// Properties of the pending product changes to include in this operation. /// /// /// @@ -182,44 +111,21 @@ public virtual void DiscardDrafts(Mozu.Api.Contracts.ProductAdmin.PublishingScop /// await publishingscope.DiscardDraftsAsync(_dataViewMode, publishScope); /// /// - public virtual async Task DiscardDraftsAsync(Mozu.Api.Contracts.ProductAdmin.PublishingScope publishScope) + public virtual async Task DiscardDraftsAsync(Mozu.Api.Contracts.ProductAdmin.PublishingScope publishScope, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.DiscardDraftsClient(_dataViewMode, publishScope); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Publishes the draft version of product changes (pending product changes) for each product code specified in the request, and changes the product publish state to "live". - /// - /// {} - /// Describes the scope of the product publishing update, which can include individual product codes or all pending changes. - /// - /// - /// - /// - /// - /// var publishingscope = new PublishingScope(); - /// publishingscope.PublishDrafts(_dataViewMode, publishScope); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void PublishDrafts(Mozu.Api.Contracts.ProductAdmin.PublishingScope publishScope) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.PublishDraftsClient(_dataViewMode, publishScope); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Publishes the draft version of product changes (pending product changes) for each product code specified in the request, and changes the product publish state to "live". + /// /// /// {} - /// Describes the scope of the product publishing update, which can include individual product codes or all pending changes. + /// Properties of the pending product changes to include in this operation. /// /// /// @@ -229,47 +135,22 @@ public virtual void PublishDrafts(Mozu.Api.Contracts.ProductAdmin.PublishingScop /// await publishingscope.PublishDraftsAsync(_dataViewMode, publishScope); /// /// - public virtual async Task PublishDraftsAsync(Mozu.Api.Contracts.ProductAdmin.PublishingScope publishScope) + public virtual async Task PublishDraftsAsync(Mozu.Api.Contracts.ProductAdmin.PublishingScope publishScope, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.PublishDraftsClient(_dataViewMode, publishScope); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Assigns pending product changes to a specified product publish set. Use the code field to specify the product publish set. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// The details of the publish to which you want to assign products. - /// - /// - /// - /// - /// - /// var publishingscope = new PublishingScope(); - /// var publishSet = publishingscope.AssignProductsToPublishSet( publishSet, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.PublishSet AssignProductsToPublishSet(Mozu.Api.Contracts.ProductAdmin.PublishSet publishSet, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.AssignProductsToPublishSetClient( publishSet, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Assigns pending product changes to a specified product publish set. Use the code field to specify the product publish set. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// {} - /// The details of the publish to which you want to assign products. + /// /// /// /// @@ -279,46 +160,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.PublishSet AssignProductsToPublis /// var publishSet = await publishingscope.AssignProductsToPublishSetAsync( publishSet, responseFields); /// /// - public virtual async Task AssignProductsToPublishSetAsync(Mozu.Api.Contracts.ProductAdmin.PublishSet publishSet, string responseFields = null) + public virtual async Task AssignProductsToPublishSetAsync(Mozu.Api.Contracts.ProductAdmin.PublishSet publishSet, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.AssignProductsToPublishSetClient( publishSet, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified product publish set. If you set the discardDrafts parameter to true, this operation also deletes the product drafts assigned to the publish set. - /// - /// Specifies whether to discard all the drafts assigned to the publish set when the publish set is deleted. - /// The unique identifier of the publish set. - /// {} - /// - /// - /// - /// - /// - /// var publishingscope = new PublishingScope(); - /// publishingscope.DeletePublishSet( publishSetCode, discardDrafts); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeletePublishSet(string publishSetCode, bool? discardDrafts = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.DeletePublishSetClient( publishSetCode, discardDrafts); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified product publish set. If you set the discardDrafts parameter to true, this operation also deletes the product drafts assigned to the publish set. + /// /// - /// Specifies whether to discard all the drafts assigned to the publish set when the publish set is deleted. - /// The unique identifier of the publish set. + /// + /// /// {} /// /// @@ -329,12 +186,12 @@ public virtual void DeletePublishSet(string publishSetCode, bool? discardDrafts /// await publishingscope.DeletePublishSetAsync( publishSetCode, discardDrafts); /// /// - public virtual async Task DeletePublishSetAsync(string publishSetCode, bool? discardDrafts = null) + public virtual async Task DeletePublishSetAsync(string publishSetCode, bool? discardDrafts = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.PublishingScopeClient.DeletePublishSetClient( publishSetCode, discardDrafts); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/SearchResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/SearchResource.cs old mode 100644 new mode 100755 index b2efb707..4812c15d --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/SearchResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/SearchResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { /// - /// Use the Search resource to manage all settings and options for providing product search on your site, as well as search tuning rules. + /// /// public partial class SearchResource { /// @@ -37,36 +38,12 @@ public SearchResource CloneWithApiContext(Action contextModificatio } - /// - /// Retrieves the details of the specified search tuning rule. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the search tuning rule. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var searchTuningRule = search.GetSearchTuningRule( searchTuningRuleCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule GetSearchTuningRule(string searchTuningRuleCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSearchTuningRuleClient( searchTuningRuleCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified search tuning rule. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the search tuning rule. + /// + /// /// /// /// @@ -76,52 +53,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule GetSearch /// var searchTuningRule = await search.GetSearchTuningRuleAsync( searchTuningRuleCode, responseFields); /// /// - public virtual async Task GetSearchTuningRuleAsync(string searchTuningRuleCode, string responseFields = null) + public virtual async Task GetSearchTuningRuleAsync(string searchTuningRuleCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSearchTuningRuleClient( searchTuningRuleCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of search tuning rules and their properties. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var searchTuningRuleCollection = search.GetSearchTuningRules( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleCollection GetSearchTuningRules(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSearchTuningRulesClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of search tuning rules and their properties. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// /// @@ -131,44 +81,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleCollection /// var searchTuningRuleCollection = await search.GetSearchTuningRulesAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetSearchTuningRulesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetSearchTuningRulesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSearchTuningRulesClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the specified search tuning rule sort fields. Sort fields allow you to control the product relevance whenver shoppers sort products on a page. For more information about sort relevance, refer to [Search Tuning Rules and Sorting](../../../developer/api-guides/search-tuning-rules.htm#search_tuning_rules_and_sorting). - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var searchTuningRuleSortFields = search.GetSearchTuningRuleSortFields( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields GetSearchTuningRuleSortFields(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSearchTuningRuleSortFieldsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified search tuning rule sort fields. Sort fields allow you to control the product relevance whenver shoppers sort products on a page. For more information about sort relevance, refer to [Search Tuning Rules and Sorting](../../../developer/api-guides/search-tuning-rules.htm#search_tuning_rules_and_sorting). + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -178,44 +105,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields /// var searchTuningRuleSortFields = await search.GetSearchTuningRuleSortFieldsAsync( responseFields); /// /// - public virtual async Task GetSearchTuningRuleSortFieldsAsync(string responseFields = null) + public virtual async Task GetSearchTuningRuleSortFieldsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSearchTuningRuleSortFieldsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the search settings for the specified site.Refer to [Search Settings API Overview](../../../../developer/api-guides/search-settings.htm) for more information about 's search settings. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var searchSettings = search.GetSettings( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.SearchSettings GetSettings(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSettingsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the search settings for the specified site.Refer to [Search Settings API Overview](../../../../developer/api-guides/search-settings.htm) for more information about 's search settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -225,46 +129,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.SearchSettings GetSettings(string /// var searchSettings = await search.GetSettingsAsync( responseFields); /// /// - public virtual async Task GetSettingsAsync(string responseFields = null) + public virtual async Task GetSettingsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSettingsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of synonyms definitions for product searches.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. - /// - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var synonymDefinitionCollection = search.GetSynonymDefinitionCollection( localeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollection GetSynonymDefinitionCollection(string localeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSynonymDefinitionCollectionClient( localeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of synonyms definitions for product searches.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -274,52 +154,25 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollectio /// var synonymDefinitionCollection = await search.GetSynonymDefinitionCollectionAsync( localeCode, responseFields); /// /// - public virtual async Task GetSynonymDefinitionCollectionAsync(string localeCode, string responseFields = null) + public virtual async Task GetSynonymDefinitionCollectionAsync(string localeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSynonymDefinitionCollectionClient( localeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of synonym definitions according to any specified filter criteria and sort options.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var synonymDefinitionPagedCollection = search.GetSynonymDefinitions( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionPagedCollection GetSynonymDefinitions(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSynonymDefinitionsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of synonym definitions according to any specified filter criteria and sort options.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// /// @@ -329,46 +182,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionPagedColl /// var synonymDefinitionPagedCollection = await search.GetSynonymDefinitionsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetSynonymDefinitionsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetSynonymDefinitionsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSynonymDefinitionsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the specified synonym defintion.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the synonym definition. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var synonymDefinition = search.GetSynonymDefinition( synonymId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition GetSynonymDefinition(int synonymId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSynonymDefinitionClient( synonymId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified synonym defintion.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the synonym definition. + /// + /// /// /// /// @@ -378,46 +207,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition GetSynon /// var synonymDefinition = await search.GetSynonymDefinitionAsync( synonymId, responseFields); /// /// - public virtual async Task GetSynonymDefinitionAsync(int synonymId, string responseFields = null) + public virtual async Task GetSynonymDefinitionAsync(int synonymId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.GetSynonymDefinitionClient( synonymId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a search tuning rule for your site. You can use search tuning rules to fine tune the product search results that appear when a shopper searches for a specific keyword, or navigates to a category page.For more information on search tuning rules, refer to [Search Tuning Rules](../../../../developer/api-guides/search-tuning-rules.htm). - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new search tuning rule. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var searchTuningRule = search.AddSearchTuningRule( searchTuningRuleIn, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule AddSearchTuningRule(Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule searchTuningRuleIn, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.AddSearchTuningRuleClient( searchTuningRuleIn, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a search tuning rule for your site. You can use search tuning rules to fine tune the product search results that appear when a shopper searches for a specific keyword, or navigates to a category page.For more information on search tuning rules, refer to [Search Tuning Rules](../../../../developer/api-guides/search-tuning-rules.htm). + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new search tuning rule. + /// + /// /// /// /// @@ -427,46 +232,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule AddSearch /// var searchTuningRule = await search.AddSearchTuningRuleAsync( searchTuningRuleIn, responseFields); /// /// - public virtual async Task AddSearchTuningRuleAsync(Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule searchTuningRuleIn, string responseFields = null) + public virtual async Task AddSearchTuningRuleAsync(Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule searchTuningRuleIn, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.AddSearchTuningRuleClient( searchTuningRuleIn, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the details of the search tuning rule sort fields. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the updated search tuning rule sort fields. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var searchTuningRuleSortFields = search.UpdateSearchTuningRuleSortFields( searchTuningRuleSortFieldsIn, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields UpdateSearchTuningRuleSortFields(Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields searchTuningRuleSortFieldsIn, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSearchTuningRuleSortFieldsClient( searchTuningRuleSortFieldsIn, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of the search tuning rule sort fields. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the updated search tuning rule sort fields. + /// + /// /// /// /// @@ -476,48 +257,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields /// var searchTuningRuleSortFields = await search.UpdateSearchTuningRuleSortFieldsAsync( searchTuningRuleSortFieldsIn, responseFields); /// /// - public virtual async Task UpdateSearchTuningRuleSortFieldsAsync(Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields searchTuningRuleSortFieldsIn, string responseFields = null) + public virtual async Task UpdateSearchTuningRuleSortFieldsAsync(Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRuleSortFields searchTuningRuleSortFieldsIn, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSearchTuningRuleSortFieldsClient( searchTuningRuleSortFieldsIn, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a collection of synonym definitions.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. - /// - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The updated details of the synonym definition collection. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var synonymDefinitionCollection = search.UpdateSynonymDefinitionCollection( collection, localeCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollection UpdateSynonymDefinitionCollection(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollection collection, string localeCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSynonymDefinitionCollectionClient( collection, localeCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a collection of synonym definitions.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The updated details of the synonym definition collection. + /// + /// + /// /// /// /// @@ -527,46 +283,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollectio /// var synonymDefinitionCollection = await search.UpdateSynonymDefinitionCollectionAsync( collection, localeCode, responseFields); /// /// - public virtual async Task UpdateSynonymDefinitionCollectionAsync(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollection collection, string localeCode, string responseFields = null) + public virtual async Task UpdateSynonymDefinitionCollectionAsync(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinitionCollection collection, string localeCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSynonymDefinitionCollectionClient( collection, localeCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new synonym definition. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var synonymDefinition = search.AddSynonymDefinition( synonymDefinition, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition AddSynonymDefinition(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition synonymDefinition, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.AddSynonymDefinitionClient( synonymDefinition, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new synonym definition. + /// + /// /// /// /// @@ -576,48 +308,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition AddSynon /// var synonymDefinition = await search.AddSynonymDefinitionAsync( synonymDefinition, responseFields); /// /// - public virtual async Task AddSynonymDefinitionAsync(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition synonymDefinition, string responseFields = null) + public virtual async Task AddSynonymDefinitionAsync(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition synonymDefinition, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.AddSynonymDefinitionClient( synonymDefinition, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the details of the specified search tuning rule. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the search tuning rule. - /// The details of the updated search tuning rule. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var searchTuningRule = search.UpdateSearchTuningRule( searchTuningRuleIn, searchTuningRuleCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule UpdateSearchTuningRule(Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule searchTuningRuleIn, string searchTuningRuleCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSearchTuningRuleClient( searchTuningRuleIn, searchTuningRuleCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of the specified search tuning rule. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the search tuning rule. - /// The details of the updated search tuning rule. + /// + /// + /// /// /// /// @@ -627,46 +334,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule UpdateSea /// var searchTuningRule = await search.UpdateSearchTuningRuleAsync( searchTuningRuleIn, searchTuningRuleCode, responseFields); /// /// - public virtual async Task UpdateSearchTuningRuleAsync(Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule searchTuningRuleIn, string searchTuningRuleCode, string responseFields = null) + public virtual async Task UpdateSearchTuningRuleAsync(Mozu.Api.Contracts.ProductAdmin.Search.SearchTuningRule searchTuningRuleIn, string searchTuningRuleCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSearchTuningRuleClient( searchTuningRuleIn, searchTuningRuleCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the search setting properties for a specific site.Refer to [Search Settings API Overview](../../../../developer/api-guides/search-settings.htm) for more information about 's search settings. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The search settings to update. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var searchSettings = search.UpdateSettings( settings, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.SearchSettings UpdateSettings(Mozu.Api.Contracts.ProductAdmin.SearchSettings settings, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSettingsClient( settings, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the search setting properties for a specific site.Refer to [Search Settings API Overview](../../../../developer/api-guides/search-settings.htm) for more information about 's search settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The search settings to update. + /// + /// /// /// /// @@ -676,48 +359,23 @@ public virtual Mozu.Api.Contracts.ProductAdmin.SearchSettings UpdateSettings(Moz /// var searchSettings = await search.UpdateSettingsAsync( settings, responseFields); /// /// - public virtual async Task UpdateSettingsAsync(Mozu.Api.Contracts.ProductAdmin.SearchSettings settings, string responseFields = null) + public virtual async Task UpdateSettingsAsync(Mozu.Api.Contracts.ProductAdmin.SearchSettings settings, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSettingsClient( settings, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the details of a synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the synonym definition. - /// The updated synonym definition details. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// var synonymDefinition = search.UpdateSynonymDefinition( synonymDefinition, synonymId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition UpdateSynonymDefinition(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition synonymDefinition, int synonymId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSynonymDefinitionClient( synonymDefinition, synonymId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of a synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the synonym definition. - /// The updated synonym definition details. + /// + /// + /// /// /// /// @@ -727,43 +385,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition UpdateSy /// var synonymDefinition = await search.UpdateSynonymDefinitionAsync( synonymDefinition, synonymId, responseFields); /// /// - public virtual async Task UpdateSynonymDefinitionAsync(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition synonymDefinition, int synonymId, string responseFields = null) + public virtual async Task UpdateSynonymDefinitionAsync(Mozu.Api.Contracts.ProductAdmin.Search.SynonymDefinition synonymDefinition, int synonymId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.UpdateSynonymDefinitionClient( synonymDefinition, synonymId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified search tuning rule from the site. - /// - /// The unique identifier of the search tuning rule. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// search.DeleteSearchTuningRule( searchTuningRuleCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteSearchTuningRule(string searchTuningRuleCode) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.DeleteSearchTuningRuleClient( searchTuningRuleCode); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified search tuning rule from the site. + /// /// - /// The unique identifier of the search tuning rule. + /// /// /// /// @@ -773,42 +409,20 @@ public virtual void DeleteSearchTuningRule(string searchTuningRuleCode) /// await search.DeleteSearchTuningRuleAsync( searchTuningRuleCode); /// /// - public virtual async Task DeleteSearchTuningRuleAsync(string searchTuningRuleCode) + public virtual async Task DeleteSearchTuningRuleAsync(string searchTuningRuleCode, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.DeleteSearchTuningRuleClient( searchTuningRuleCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the specified synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. - /// - /// The unique identifier of the synonym definition. - /// - /// - /// - /// - /// - /// var search = new Search(); - /// search.DeleteSynonymDefinition( synonymId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteSynonymDefinition(int synonymId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.DeleteSynonymDefinitionClient( synonymId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified synonym definition.Refer to [Search Synonyms](../../../../developer/api-guides/search-settings.htm#search_synonyms) for more information about search synonyms. + /// /// - /// The unique identifier of the synonym definition. + /// /// /// /// @@ -818,12 +432,12 @@ public virtual void DeleteSynonymDefinition(int synonymId) /// await search.DeleteSynonymDefinitionAsync( synonymId); /// /// - public virtual async Task DeleteSynonymDefinitionAsync(int synonymId) + public virtual async Task DeleteSynonymDefinitionAsync(int synonymId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SearchClient.DeleteSynonymDefinitionClient( synonymId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Admin/SoftAllocationResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Admin/SoftAllocationResource.cs old mode 100644 new mode 100755 index cf6f54df..b87e3bca --- a/Mozu.Api/Resources/Commerce/Catalog/Admin/SoftAllocationResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Admin/SoftAllocationResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Admin { /// - /// The Soft Allocations resource allows you to temporarily hold a product from inventory while a shopper is filling out payment information. You create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete. + /// /// public partial class SoftAllocationResource { /// @@ -37,43 +38,15 @@ public SoftAllocationResource CloneWithApiContext(Action contextMod } - /// - /// Retrieves a list of sof allocations according to any specified filter criteria and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// {} - /// - /// - /// - /// - /// - /// var softallocation = new SoftAllocation(); - /// var softAllocationCollection = softallocation.GetSoftAllocations( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.SoftAllocationCollection GetSoftAllocations(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.GetSoftAllocationsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of sof allocations according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// {} /// /// @@ -84,47 +57,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.SoftAllocationCollection GetSoftA /// var softAllocationCollection = await softallocation.GetSoftAllocationsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetSoftAllocationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetSoftAllocationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.GetSoftAllocationsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a soft allocation. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the soft allocation. - /// {} - /// - /// - /// - /// - /// - /// var softallocation = new SoftAllocation(); - /// var softAllocation = softallocation.GetSoftAllocation( softAllocationId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation(int softAllocationId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.GetSoftAllocationClient( softAllocationId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a soft allocation. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the soft allocation. + /// + /// /// {} /// /// @@ -135,46 +83,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation( /// var softAllocation = await softallocation.GetSoftAllocationAsync( softAllocationId, responseFields); /// /// - public virtual async Task GetSoftAllocationAsync(int softAllocationId, string responseFields = null) + public virtual async Task GetSoftAllocationAsync(int softAllocationId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.GetSoftAllocationClient( softAllocationId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new soft allocation for a product. This places a hold on the product inventory for the quantity specified during the ordering process. - /// - /// {} - /// The details of the new soft allocation. - /// - /// List{} - /// - /// - /// - /// var softallocation = new SoftAllocation(); - /// var softAllocation = softallocation.AddSoftAllocations( softAllocationsIn); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List AddSoftAllocations(List softAllocationsIn) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.AddSoftAllocationsClient( softAllocationsIn); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new soft allocation for a product. This places a hold on the product inventory for the quantity specified during the ordering process. + /// /// /// {} - /// The details of the new soft allocation. + /// /// /// List{} /// @@ -184,46 +108,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation( /// var softAllocation = await softallocation.AddSoftAllocationsAsync( softAllocationsIn); /// /// - public virtual async Task> AddSoftAllocationsAsync(List softAllocationsIn) + public virtual async Task> AddSoftAllocationsAsync(List softAllocationsIn, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.AddSoftAllocationsClient( softAllocationsIn); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Converts a set of existing soft product allocations into product reservations. - /// - /// {} - /// The details of the soft allocation which you want to convert into product reservations. - /// - /// List{} - /// - /// - /// - /// var softallocation = new SoftAllocation(); - /// var productReservation = softallocation.ConvertToProductReservation( softAllocations); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List ConvertToProductReservation(List softAllocations) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.ConvertToProductReservationClient( softAllocations); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Converts a set of existing soft product allocations into product reservations. + /// /// /// {} - /// The details of the soft allocation which you want to convert into product reservations. + /// /// /// List{} /// @@ -233,46 +133,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation( /// var productReservation = await softallocation.ConvertToProductReservationAsync( softAllocations); /// /// - public virtual async Task> ConvertToProductReservationAsync(List softAllocations) + public virtual async Task> ConvertToProductReservationAsync(List softAllocations, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.ConvertToProductReservationClient( softAllocations); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the expiration time for a set of soft allocations in a non-transactional batch. - /// - /// {} - /// The details of the soft allocation that you want to renew. - /// - /// List{} - /// - /// - /// - /// var softallocation = new SoftAllocation(); - /// var softAllocation = softallocation.RenewSoftAllocations( softAllocationRenew); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List RenewSoftAllocations(Mozu.Api.Contracts.ProductAdmin.SoftAllocationRenew softAllocationRenew) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.RenewSoftAllocationsClient( softAllocationRenew); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the expiration time for a set of soft allocations in a non-transactional batch. + /// /// /// {} - /// The details of the soft allocation that you want to renew. + /// /// /// List{} /// @@ -282,46 +158,22 @@ public virtual Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation( /// var softAllocation = await softallocation.RenewSoftAllocationsAsync( softAllocationRenew); /// /// - public virtual async Task> RenewSoftAllocationsAsync(Mozu.Api.Contracts.ProductAdmin.SoftAllocationRenew softAllocationRenew) + public virtual async Task> RenewSoftAllocationsAsync(Mozu.Api.Contracts.ProductAdmin.SoftAllocationRenew softAllocationRenew, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.RenewSoftAllocationsClient( softAllocationRenew); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a soft allocation. This updates a hold on the product inventory for the quantity specified during the ordering process. - /// - /// {} - /// The details of the updated soft allocations. - /// - /// List{} - /// - /// - /// - /// var softallocation = new SoftAllocation(); - /// var softAllocation = softallocation.UpdateSoftAllocations( softAllocations); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateSoftAllocations(List softAllocations) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.UpdateSoftAllocationsClient( softAllocations); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a soft allocation. This updates a hold on the product inventory for the quantity specified during the ordering process. + /// /// /// {} - /// The details of the updated soft allocations. + /// /// /// List{} /// @@ -331,44 +183,21 @@ public virtual Mozu.Api.Contracts.ProductAdmin.SoftAllocation GetSoftAllocation( /// var softAllocation = await softallocation.UpdateSoftAllocationsAsync( softAllocations); /// /// - public virtual async Task> UpdateSoftAllocationsAsync(List softAllocations) + public virtual async Task> UpdateSoftAllocationsAsync(List softAllocations, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.UpdateSoftAllocationsClient( softAllocations); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a soft allocation. You might delete a soft allocation when an order or cart is not processed in order to return the product quantity back to inventory. - /// - /// The unique identifier of the soft allocation. - /// {} - /// - /// - /// - /// - /// - /// var softallocation = new SoftAllocation(); - /// softallocation.DeleteSoftAllocation( softAllocationId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteSoftAllocation(int softAllocationId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.DeleteSoftAllocationClient( softAllocationId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a soft allocation. You might delete a soft allocation when an order or cart is not processed in order to return the product quantity back to inventory. + /// /// - /// The unique identifier of the soft allocation. + /// /// {} /// /// @@ -379,12 +208,12 @@ public virtual void DeleteSoftAllocation(int softAllocationId) /// await softallocation.DeleteSoftAllocationAsync( softAllocationId); /// /// - public virtual async Task DeleteSoftAllocationAsync(int softAllocationId) + public virtual async Task DeleteSoftAllocationAsync(int softAllocationId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Admin.SoftAllocationClient.DeleteSoftAllocationClient( softAllocationId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Storefront/CategoryResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Storefront/CategoryResource.cs old mode 100644 new mode 100755 index cc51c086..fce70bc2 --- a/Mozu.Api/Resources/Commerce/Catalog/Storefront/CategoryResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Storefront/CategoryResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Storefront { @@ -44,40 +45,13 @@ public CategoryResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of categories according to any specified filter criteria and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var categoryPagedCollection = category.GetCategories(_dataViewMode, filter, startIndex, pageSize, sortBy, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.CategoryPagedCollection GetCategories(string filter = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.CategoryClient.GetCategoriesClient(_dataViewMode, filter, startIndex, pageSize, sortBy, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of categories according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product category search results by any of its properties, including its position in the category hierarchy. 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" + /// + /// /// /// /// @@ -89,48 +63,23 @@ public virtual Mozu.Api.Contracts.ProductRuntime.CategoryPagedCollection GetCate /// var categoryPagedCollection = await category.GetCategoriesAsync(_dataViewMode, filter, startIndex, pageSize, sortBy, responseFields); /// /// - public virtual async Task GetCategoriesAsync(string filter = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null) + public virtual async Task GetCategoriesAsync(string filter = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.CategoryClient.GetCategoriesClient(_dataViewMode, filter, startIndex, pageSize, sortBy, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a single category. - /// - /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// Unique identifier for the storefront container used to organize products. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var category = category.GetCategory(_dataViewMode, categoryId, allowInactive, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.Category GetCategory(int categoryId, bool? allowInactive = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.CategoryClient.GetCategoryClient(_dataViewMode, categoryId, allowInactive, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a single category. + /// /// /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// Unique identifier for the storefront container used to organize products. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// Unique identifier of the product category. + /// /// /// /// @@ -140,44 +89,21 @@ public virtual Mozu.Api.Contracts.ProductRuntime.Category GetCategory(int catego /// var category = await category.GetCategoryAsync(_dataViewMode, categoryId, allowInactive, responseFields); /// /// - public virtual async Task GetCategoryAsync(int categoryId, bool? allowInactive = null, string responseFields = null) + public virtual async Task GetCategoryAsync(int categoryId, bool? allowInactive = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.CategoryClient.GetCategoryClient(_dataViewMode, categoryId, allowInactive, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the list of product categories that appear on the storefront organized in a hierarchical format. Hidden categories do not appear in the list. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var category = new Category(); - /// var categoryCollection = category.GetCategoryTree(_dataViewMode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.CategoryCollection GetCategoryTree(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.CategoryClient.GetCategoryTreeClient(_dataViewMode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the list of product categories that appear on the storefront organized in a hierarchical format. Hidden categories do not appear in the list. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -187,12 +113,12 @@ public virtual Mozu.Api.Contracts.ProductRuntime.CategoryCollection GetCategoryT /// var categoryCollection = await category.GetCategoryTreeAsync(_dataViewMode, responseFields); /// /// - public virtual async Task GetCategoryTreeAsync(string responseFields = null) + public virtual async Task GetCategoryTreeAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.CategoryClient.GetCategoryTreeClient(_dataViewMode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Storefront/OrderTaxContextResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Storefront/OrderTaxContextResource.cs old mode 100644 new mode 100755 index 3df22ee7..50265a40 --- a/Mozu.Api/Resources/Commerce/Catalog/Storefront/OrderTaxContextResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Storefront/OrderTaxContextResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Storefront { /// - /// Use the Storefront Tax resource to retrieve tax information from the storefront. + /// /// public partial class OrderTaxContextResource { /// @@ -37,35 +38,11 @@ public OrderTaxContextResource CloneWithApiContext(Action contextMo } - /// - /// Retrieves tax information applicable to the site. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// - /// var ordertaxcontext = new OrderTaxContext(); - /// var orderTaxContext = ordertaxcontext.EstimateTaxes( taxableOrder, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.PricingRuntime.OrderTaxContext EstimateTaxes(Mozu.Api.Contracts.PricingRuntime.TaxableOrder taxableOrder, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.OrderTaxContextClient.EstimateTaxesClient( taxableOrder, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves tax information applicable to the site. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -76,12 +53,12 @@ public virtual Mozu.Api.Contracts.PricingRuntime.OrderTaxContext EstimateTaxes(M /// var orderTaxContext = await ordertaxcontext.EstimateTaxesAsync( taxableOrder, responseFields); /// /// - public virtual async Task EstimateTaxesAsync(Mozu.Api.Contracts.PricingRuntime.TaxableOrder taxableOrder, string responseFields = null) + public virtual async Task EstimateTaxesAsync(Mozu.Api.Contracts.PricingRuntime.TaxableOrder taxableOrder, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.OrderTaxContextClient.EstimateTaxesClient( taxableOrder, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Storefront/PriceListResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Storefront/PriceListResource.cs old mode 100644 new mode 100755 index f51cda16..f887b992 --- a/Mozu.Api/Resources/Commerce/Catalog/Storefront/PriceListResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Storefront/PriceListResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Storefront { /// - /// Retrieves the details of a price list. The details may contain a hierarchy of ancestor and/or descendant price lists dependening on your configuration. + /// /// public partial class PriceListResource { /// @@ -37,36 +38,12 @@ public PriceListResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves the details of the specified price list. - /// - /// The unique code of the price list for which you want to retrieve the details. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// var priceList = pricelist.GetPriceList( priceListCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.PriceList GetPriceList(string priceListCode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.PriceListClient.GetPriceListClient( priceListCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified price list. + /// /// - /// The unique code of the price list for which you want to retrieve the details. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -76,46 +53,22 @@ public virtual Mozu.Api.Contracts.ProductRuntime.PriceList GetPriceList(string p /// var priceList = await pricelist.GetPriceListAsync( priceListCode, responseFields); /// /// - public virtual async Task GetPriceListAsync(string priceListCode, string responseFields = null) + public virtual async Task GetPriceListAsync(string priceListCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.PriceListClient.GetPriceListClient( priceListCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a price list to which the specified customer resolves. This is primarly used when creating an offline order for a shopper.You can use this operation alongside custom Arc.js actions to alter the price list to which a shopper resolves. - /// - /// The unique identifier of the customer account for which to retrieve wish lists. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var pricelist = new PriceList(); - /// var resolvedPriceList = pricelist.GetResolvedPriceList( customerAccountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.ResolvedPriceList GetResolvedPriceList(int? customerAccountId = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.PriceListClient.GetResolvedPriceListClient( customerAccountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a price list to which the specified customer resolves. This is primarly used when creating an offline order for a shopper.You can use this operation alongside custom Arc.js actions to alter the price list to which a shopper resolves. + /// /// - /// The unique identifier of the customer account for which to retrieve wish lists. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -125,12 +78,12 @@ public virtual Mozu.Api.Contracts.ProductRuntime.ResolvedPriceList GetResolvedPr /// var resolvedPriceList = await pricelist.GetResolvedPriceListAsync( customerAccountId, responseFields); /// /// - public virtual async Task GetResolvedPriceListAsync(int? customerAccountId = null, string responseFields = null) + public virtual async Task GetResolvedPriceListAsync(int? customerAccountId = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.PriceListClient.GetResolvedPriceListClient( customerAccountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Storefront/ProductResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Storefront/ProductResource.cs old mode 100644 new mode 100755 index c4b57b4b..4b55ef93 --- a/Mozu.Api/Resources/Commerce/Catalog/Storefront/ProductResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Storefront/ProductResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Storefront { /// - /// Use the Storefront Products resource to manage the shopper product selection process during a visit to the web storefront. You can update product options as shoppers pick and choose their product choices. A shopper cannot add a product to a cart until all of its required options have been selected. + /// Use the Storefront Products resource to manage the shopper product selection process during a visit to the web storefront. You can update product options as shoppers pick and choose their product choices. A shopper cannot add a product to a cart until all of its required options have been selected. /// public partial class ProductResource { /// @@ -44,44 +45,15 @@ public ProductResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of products that appear on the web storefront according to any specified filter criteria and sort options. - /// - /// In your first deep paged request, set this parameter to . Then, in all subsequent requests, set this parameter to the subsequent values of that's returned in each response to continue paging through the results. Continue this pattern until is null, which signifies the end of the paged results. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Options you can specify for the response. This parameter is null by default.You can primarily use this parameter to return volume price band information in product details, which you can then display on category pages and search results depanding on your theme configuration. To return volume price band information, set this parameter to . - /// - /// - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var productCollection = product.GetProducts(_dataViewMode, filter, startIndex, pageSize, sortBy, responseOptions, cursorMark, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.ProductCollection GetProducts(string filter = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string responseOptions = null, string cursorMark = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductsClient(_dataViewMode, filter, startIndex, pageSize, sortBy, responseOptions, cursorMark, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of products that appear on the web storefront according to any specified filter criteria and sort options. + /// /// - /// In your first deep paged request, set this parameter to . Then, in all subsequent requests, set this parameter to the subsequent values of that's returned in each response to continue paging through the results. Continue this pattern until is null, which signifies the end of the paged results. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Options you can specify for the response. This parameter is null by default.You can primarily use this parameter to return volume price band information in product details, which you can then display on category pages and search results depanding on your theme configuration. To return volume price band information, set this parameter to . + /// + /// + /// Used to page results from a query. Indicates the maximum number of entities to return from a single query. Default value: 20. Maximum value: 200. + /// + /// /// /// /// @@ -93,48 +65,23 @@ public virtual Mozu.Api.Contracts.ProductRuntime.ProductCollection GetProducts(s /// var productCollection = await product.GetProductsAsync(_dataViewMode, filter, startIndex, pageSize, sortBy, responseOptions, cursorMark, responseFields); /// /// - public virtual async Task GetProductsAsync(string filter = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string responseOptions = null, string cursorMark = null, string responseFields = null) + public virtual async Task GetProductsAsync(string filter = null, int? startIndex = null, int? pageSize = null, string sortBy = null, string responseOptions = null, string cursorMark = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductsClient(_dataViewMode, filter, startIndex, pageSize, sortBy, responseOptions, cursorMark, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the active inventory level information associated with the product or location specified in the request. - /// - /// Array of location codes for which to retrieve product inventory information. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var locationInventoryCollection = product.GetProductInventory(_dataViewMode, productCode, locationCodes, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.LocationInventoryCollection GetProductInventory(string productCode, string locationCodes = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductInventoryClient(_dataViewMode, productCode, locationCodes, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the active inventory level information associated with the product or location specified in the request. + /// /// /// Array of location codes for which to retrieve product inventory information. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -144,57 +91,28 @@ public virtual Mozu.Api.Contracts.ProductRuntime.LocationInventoryCollection Get /// var locationInventoryCollection = await product.GetProductInventoryAsync(_dataViewMode, productCode, locationCodes, responseFields); /// /// - public virtual async Task GetProductInventoryAsync(string productCode, string locationCodes = null, string responseFields = null) + public virtual async Task GetProductInventoryAsync(string productCode, string locationCodes = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductInventoryClient(_dataViewMode, productCode, locationCodes, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves information about a single product given its product code. - /// - /// Specifies whether to accept a product variant's code as the .When you set this parameter to , you can pass in a product variant's code in the GetProduct call to retrieve the product variant details that are associated with the base product. - /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. - /// Specifies whether to supress the 404 error when the product is out of stock. - /// Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var product = product.GetProduct(_dataViewMode, productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.Product GetProduct(string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, int? quantity = null, bool? acceptVariantProductCode = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductClient(_dataViewMode, productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves information about a single product given its product code. + /// /// - /// Specifies whether to accept a product variant's code as the .When you set this parameter to , you can pass in a product variant's code in the GetProduct call to retrieve the product variant details that are associated with the base product. - /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. - /// Specifies whether to supress the 404 error when the product is out of stock. + /// + /// If true, returns an inactive product as part of the query. + /// + /// + /// + /// + /// If true, skip the inventory validation process for the specified product. + /// /// Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. /// /// @@ -202,53 +120,27 @@ public virtual Mozu.Api.Contracts.ProductRuntime.Product GetProduct(string produ /// /// /// var product = new Product(); - /// var product = await product.GetProductAsync(_dataViewMode, productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, responseFields); + /// var product = await product.GetProductAsync(_dataViewMode, productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, purchaseLocation, responseFields); /// /// - public virtual async Task GetProductAsync(string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, int? quantity = null, bool? acceptVariantProductCode = null, string responseFields = null) + public virtual async Task GetProductAsync(string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, int? quantity = null, bool? acceptVariantProductCode = null, string purchaseLocation = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductClient(_dataViewMode, productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, responseFields); + var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductClient(_dataViewMode, productCode, variationProductCode, allowInactive, skipInventoryCheck, supressOutOfStock404, quantity, acceptVariantProductCode, purchaseLocation, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves information about a single product given its product code for to index in the search engine - /// - /// The date when the product was last updated. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The product version. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var product = product.GetProductForIndexing(_dataViewMode, productCode, productVersion, lastModifiedDate, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.Product GetProductForIndexing(string productCode, long? productVersion = null, DateTime? lastModifiedDate = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductForIndexingClient(_dataViewMode, productCode, productVersion, lastModifiedDate, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves information about a single product given its product code for to index in the search engine + /// /// - /// The date when the product was last updated. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The product version. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// /// @@ -258,53 +150,26 @@ public virtual Mozu.Api.Contracts.ProductRuntime.Product GetProductForIndexing(s /// var product = await product.GetProductForIndexingAsync(_dataViewMode, productCode, productVersion, lastModifiedDate, responseFields); /// /// - public virtual async Task GetProductForIndexingAsync(string productCode, long? productVersion = null, DateTime? lastModifiedDate = null, string responseFields = null) + public virtual async Task GetProductForIndexingAsync(string productCode, long? productVersion = null, DateTime? lastModifiedDate = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductForIndexingClient(_dataViewMode, productCode, productVersion, lastModifiedDate, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new product configuration each time a shopper selects a product option value. After the shopper defines values for all required product options, the shopper can add the product configuration to a cart. - /// - /// If true, the response returns details about the product. If false, returns a product summary such as the product name, price, and sale price. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. - /// For a product with shopper-configurable options, the properties of the product options selected by the shopper. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var configuredProduct = product.ConfiguredProduct( productOptionSelections, productCode, includeOptionDetails, skipInventoryCheck, quantity, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.ConfiguredProduct ConfiguredProduct(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, int? quantity = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ConfiguredProductClient( productOptionSelections, productCode, includeOptionDetails, skipInventoryCheck, quantity, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new product configuration each time a shopper selects a product option value. After the shopper defines values for all required product options, the shopper can add the product configuration to a cart. + /// /// /// If true, the response returns details about the product. If false, returns a product summary such as the product name, price, and sale price. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. + /// + /// + /// + /// + /// If true, skip the inventory validation process for the specified product. /// For a product with shopper-configurable options, the properties of the product options selected by the shopper. /// /// @@ -312,56 +177,29 @@ public virtual Mozu.Api.Contracts.ProductRuntime.ConfiguredProduct ConfiguredPro /// /// /// var product = new Product(); - /// var configuredProduct = await product.ConfiguredProductAsync( productOptionSelections, productCode, includeOptionDetails, skipInventoryCheck, quantity, responseFields); + /// var configuredProduct = await product.ConfiguredProductAsync( productOptionSelections, productCode, includeOptionDetails, skipInventoryCheck, quantity, purchaseLocation, responseFields); /// /// - public virtual async Task ConfiguredProductAsync(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, int? quantity = null, string responseFields = null) + public virtual async Task ConfiguredProductAsync(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, int? quantity = null, string purchaseLocation = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ConfiguredProductClient( productOptionSelections, productCode, includeOptionDetails, skipInventoryCheck, quantity, responseFields); + var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ConfiguredProductClient( productOptionSelections, productCode, includeOptionDetails, skipInventoryCheck, quantity, purchaseLocation, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Validate the final state of shopper-selected options. - /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// Normally, product validation applies default extras to products that do not have options specified. If , product validation does not apply default extras to products. - /// If true, skip the process to validate inventory when creating this product reservation. - /// For a product with shopper-configurable options, the properties of the product options selected by the shopper. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var productValidationSummary = product.ValidateProduct( productOptionSelections, productCode, skipInventoryCheck, quantity, skipDefaults, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.ProductValidationSummary ValidateProduct(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? skipInventoryCheck = null, int? quantity = null, bool? skipDefaults = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ValidateProductClient( productOptionSelections, productCode, skipInventoryCheck, quantity, skipDefaults, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Validate the final state of shopper-selected options. + /// /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// Normally, product validation applies default extras to products that do not have options specified. If , product validation does not apply default extras to products. - /// If true, skip the process to validate inventory when creating this product reservation. + /// + /// + /// + /// + /// + /// If true, skip the inventory validation process for the specified product. /// For a product with shopper-configurable options, the properties of the product options selected by the shopper. /// /// @@ -369,59 +207,30 @@ public virtual Mozu.Api.Contracts.ProductRuntime.ProductValidationSummary Valida /// /// /// var product = new Product(); - /// var productValidationSummary = await product.ValidateProductAsync( productOptionSelections, productCode, skipInventoryCheck, quantity, skipDefaults, responseFields); + /// var productValidationSummary = await product.ValidateProductAsync( productOptionSelections, productCode, skipInventoryCheck, quantity, skipDefaults, purchaseLocation, responseFields); /// /// - public virtual async Task ValidateProductAsync(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? skipInventoryCheck = null, int? quantity = null, bool? skipDefaults = null, string responseFields = null) + public virtual async Task ValidateProductAsync(Mozu.Api.Contracts.ProductRuntime.ProductOptionSelections productOptionSelections, string productCode, bool? skipInventoryCheck = null, int? quantity = null, bool? skipDefaults = null, string purchaseLocation = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ValidateProductClient( productOptionSelections, productCode, skipInventoryCheck, quantity, skipDefaults, responseFields); + var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ValidateProductClient( productOptionSelections, productCode, skipInventoryCheck, quantity, skipDefaults, purchaseLocation, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Evaluates whether a collection of discounts specified in the request can be redeemed for the supplied product code. - /// - /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// The unique identifier of the customer account for which to retrieve wish lists. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. - /// Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// The discounts to evaluate for a specified product code at the time of purchase. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var discountValidationSummary = product.ValidateDiscounts( discountSelections, productCode, variationProductCode, customerAccountId, allowInactive, skipInventoryCheck, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.DiscountValidationSummary ValidateDiscounts(Mozu.Api.Contracts.ProductRuntime.DiscountSelections discountSelections, string productCode, string variationProductCode = null, int? customerAccountId = null, bool? allowInactive = null, bool? skipInventoryCheck = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ValidateDiscountsClient( discountSelections, productCode, variationProductCode, customerAccountId, allowInactive, skipInventoryCheck, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Evaluates whether a collection of discounts specified in the request can be redeemed for the supplied product code. + /// /// - /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// The unique identifier of the customer account for which to retrieve wish lists. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. + /// If true, this operation returns inactive product discounts as part of the POST. + /// Unique ID of the customer account associated with the shopper requesting the discount. + /// + /// + /// If true, do not validate the product inventory when evaluating the list of discounts. /// Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. - /// The discounts to evaluate for a specified product code at the time of purchase. + /// List of discount IDs to evaluate for the specified product. /// /// /// @@ -431,46 +240,22 @@ public virtual Mozu.Api.Contracts.ProductRuntime.DiscountValidationSummary Valid /// var discountValidationSummary = await product.ValidateDiscountsAsync( discountSelections, productCode, variationProductCode, customerAccountId, allowInactive, skipInventoryCheck, responseFields); /// /// - public virtual async Task ValidateDiscountsAsync(Mozu.Api.Contracts.ProductRuntime.DiscountSelections discountSelections, string productCode, string variationProductCode = null, int? customerAccountId = null, bool? allowInactive = null, bool? skipInventoryCheck = null, string responseFields = null) + public virtual async Task ValidateDiscountsAsync(Mozu.Api.Contracts.ProductRuntime.DiscountSelections discountSelections, string productCode, string variationProductCode = null, int? customerAccountId = null, bool? allowInactive = null, bool? skipInventoryCheck = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.ValidateDiscountsClient( discountSelections, productCode, variationProductCode, customerAccountId, allowInactive, skipInventoryCheck, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the product cost based on a list of product codes. The product cost is the amount the merchant pays for the product—it is not the price that the shopper sees on the storefront (which is usually higher). - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var productCostCollection = product.GetProductCosts(_dataViewMode, query, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.ProductCostCollection GetProductCosts(Mozu.Api.Contracts.ProductRuntime.ProductCostQuery query, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductCostsClient(_dataViewMode, query, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the product cost based on a list of product codes. The product cost is the amount the merchant pays for the product—it is not the price that the shopper sees on the storefront (which is usually higher). + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties for the product location inventory provided for queries to locate products by their location. + /// + /// /// /// /// @@ -480,46 +265,22 @@ public virtual Mozu.Api.Contracts.ProductRuntime.ProductCostCollection GetProduc /// var productCostCollection = await product.GetProductCostsAsync(_dataViewMode, query, responseFields); /// /// - public virtual async Task GetProductCostsAsync(Mozu.Api.Contracts.ProductRuntime.ProductCostQuery query, string responseFields = null) + public virtual async Task GetProductCostsAsync(Mozu.Api.Contracts.ProductRuntime.ProductCostQuery query, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductCostsClient(_dataViewMode, query, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves product inventories for the storefront displayed products. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// - /// - /// - /// - /// - /// var product = new Product(); - /// var locationInventoryCollection = product.GetProductInventories(_dataViewMode, query, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.LocationInventoryCollection GetProductInventories(Mozu.Api.Contracts.ProductRuntime.LocationInventoryQuery query, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductInventoriesClient(_dataViewMode, query, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves product inventories for the storefront displayed products. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties for the product location inventory provided for queries to locate products by their location. + /// + /// /// /// /// @@ -529,12 +290,12 @@ public virtual Mozu.Api.Contracts.ProductRuntime.LocationInventoryCollection Get /// var locationInventoryCollection = await product.GetProductInventoriesAsync(_dataViewMode, query, responseFields); /// /// - public virtual async Task GetProductInventoriesAsync(Mozu.Api.Contracts.ProductRuntime.LocationInventoryQuery query, string responseFields = null) + public virtual async Task GetProductInventoriesAsync(Mozu.Api.Contracts.ProductRuntime.LocationInventoryQuery query, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductClient.GetProductInventoriesClient(_dataViewMode, query, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Storefront/ProductSearchResultResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Storefront/ProductSearchResultResource.cs old mode 100644 new mode 100755 index c45c6701..0d2a56b5 --- a/Mozu.Api/Resources/Commerce/Catalog/Storefront/ProductSearchResultResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Storefront/ProductSearchResultResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Storefront { @@ -37,40 +38,14 @@ public ProductSearchResultResource CloneWithApiContext(Action conte } - /// - /// Random access paging computes a set of , which can each then be provided to the operation in the resource or the operation in the resource. You can provide the computed groups in any order to the operations, and can therefore parallelize calls to retrieve products more quickly. To generate the set of , call this () operation, in which you can optionally provide query and/or filter parameters to limit the products matched by the cursor. After executing this operation, pass one of the returned to the parameter of the or operations. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var productsearchresult = new ProductSearchResult(); - /// var productSearchRandomAccessCursor = productsearchresult.GetRandomAccessCursor( query, filter, pageSize, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.ProductSearchRandomAccessCursor GetRandomAccessCursor(string query = null, string filter = null, int? pageSize = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductSearchResultClient.GetRandomAccessCursorClient( query, filter, pageSize, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Random access paging computes a set of , which can each then be provided to the operation in the resource or the operation in the resource. You can provide the computed groups in any order to the operations, and can therefore parallelize calls to retrieve products more quickly. To generate the set of , call this () operation, in which you can optionally provide query and/or filter parameters to limit the products matched by the cursor. After executing this operation, pass one of the returned to the parameter of the or operations. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// /// @@ -80,93 +55,45 @@ public virtual Mozu.Api.Contracts.ProductRuntime.ProductSearchRandomAccessCursor /// var productSearchRandomAccessCursor = await productsearchresult.GetRandomAccessCursorAsync( query, filter, pageSize, responseFields); /// /// - public virtual async Task GetRandomAccessCursorAsync(string query = null, string filter = null, int? pageSize = null, string responseFields = null) + public virtual async Task GetRandomAccessCursorAsync(string query = null, string filter = null, int? pageSize = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductSearchResultClient.GetRandomAccessCursorClient( query, filter, pageSize, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Searches the categories displayed on the web storefront for products or product options that the shopper types in a search query. - /// - /// In your first deep paged request, set this parameter to . Then, in all subsequent requests, set this parameter to the subsequent values of that's returned in each response to continue paging through the results. Continue this pattern until is null, which signifies the end of the paged results. - /// Enables search tuning rules on your site. - /// Individually list the facet fields you want to display in a web storefront product search. - /// Display a range facet not specified in a template in a web storefront product search by listing the facet field and the range to display. - /// If filtering using category facets in a hierarchy, the number of category hierarchy levels to return for the facet. This option is only available for category facets. - /// If filtering using category facets in a hierarchy, the parent categories you want to skip in the storefront product search. This parameter is only available for category facets. - /// If filtering using category facets in a hierarchy, the category in the hierarchy to begin faceting on. This parameter is only available for category facets. - /// The number of facet values to return for one or more facets. - /// Use this parameter to filter facet values that are returned by an associated search result by a prefix.For example, to filter on colors that start with b, such as blue, black, or brown you can specify the following: - /// Settings reserved for future facet search functionality on a web storefront product search. - /// When paging through multiple facets, the startIndex value for each facet. - /// The facet template to use on the storefront. A template displays all facets associated with the template on the web storefront product search. Currently, only category-level facet templates are available. - /// A comma-separated list of the facets to exclude from the facetTemplate. - /// Display a subset of the facets defined in the template specified in facetTemplate parameter. - /// The facet values to apply to the filter. - /// Use this parameter to specify facet sorting outside the predefined facet definitions (which require a category). The most common options are:* (default)—Sorts by product count (highest count first).* —Sorts by lexicographic order. In most cases, this means alphabetical order.The following code demonstrates an example of sort: - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Use this field to include those fields which are not included by default. - /// Options you can specify for the response. This parameter is null by default.You can primarily use this parameter to return volume price band information in product details, which you can then display on category pages and search results depanding on your theme configuration. To return volume price band information, set this parameter to . - /// The settings to control product search and indexing behavior. - /// The unique identifier of the search tuning rule. - /// The category ID that the search tuning rule applies to. - /// - /// - /// - /// - /// - /// - /// - /// var productsearchresult = new ProductSearchResult(); - /// var productSearchResult = productsearchresult.Search( query, filter, facetTemplate, facetTemplateSubset, facet, facetFieldRangeQuery, facetHierPrefix, facetHierValue, facetHierDepth, facetStartIndex, facetPageSize, facetSettings, facetValueFilter, sortBy, pageSize, startIndex, searchSettings, enableSearchTuningRules, searchTuningRuleContext, searchTuningRuleCode, facetTemplateExclude, facetPrefix, responseOptions, cursorMark, facetValueSort, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.ProductSearchResult Search(string query = null, string filter = null, string facetTemplate = null, string facetTemplateSubset = null, string facet = null, string facetFieldRangeQuery = null, string facetHierPrefix = null, string facetHierValue = null, string facetHierDepth = null, string facetStartIndex = null, string facetPageSize = null, string facetSettings = null, string facetValueFilter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, string searchSettings = null, bool? enableSearchTuningRules = null, string searchTuningRuleContext = null, string searchTuningRuleCode = null, string facetTemplateExclude = null, string facetPrefix = null, string responseOptions = null, string cursorMark = null, string facetValueSort = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductSearchResultClient.SearchClient( query, filter, facetTemplate, facetTemplateSubset, facet, facetFieldRangeQuery, facetHierPrefix, facetHierValue, facetHierDepth, facetStartIndex, facetPageSize, facetSettings, facetValueFilter, sortBy, pageSize, startIndex, searchSettings, enableSearchTuningRules, searchTuningRuleContext, searchTuningRuleCode, facetTemplateExclude, facetPrefix, responseOptions, cursorMark, facetValueSort, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Searches the categories displayed on the web storefront for products or product options that the shopper types in a search query. + /// /// - /// In your first deep paged request, set this parameter to . Then, in all subsequent requests, set this parameter to the subsequent values of that's returned in each response to continue paging through the results. Continue this pattern until is null, which signifies the end of the paged results. - /// Enables search tuning rules on your site. + /// + /// /// Individually list the facet fields you want to display in a web storefront product search. /// Display a range facet not specified in a template in a web storefront product search by listing the facet field and the range to display. /// If filtering using category facets in a hierarchy, the number of category hierarchy levels to return for the facet. This option is only available for category facets. /// If filtering using category facets in a hierarchy, the parent categories you want to skip in the storefront product search. This parameter is only available for category facets. /// If filtering using category facets in a hierarchy, the category in the hierarchy to begin faceting on. This parameter is only available for category facets. /// The number of facet values to return for one or more facets. - /// Use this parameter to filter facet values that are returned by an associated search result by a prefix.For example, to filter on colors that start with b, such as blue, black, or brown you can specify the following: + /// /// Settings reserved for future facet search functionality on a web storefront product search. /// When paging through multiple facets, the startIndex value for each facet. /// The facet template to use on the storefront. A template displays all facets associated with the template on the web storefront product search. Currently, only category-level facet templates are available. - /// A comma-separated list of the facets to exclude from the facetTemplate. + /// /// Display a subset of the facets defined in the template specified in facetTemplate parameter. /// The facet values to apply to the filter. - /// Use this parameter to specify facet sorting outside the predefined facet definitions (which require a category). The most common options are:* (default)—Sorts by product count (highest count first).* —Sorts by lexicographic order. In most cases, this means alphabetical order.The following code demonstrates an example of sort: - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Use this field to include those fields which are not included by default. - /// Options you can specify for the response. This parameter is null by default.You can primarily use this parameter to return volume price band information in product details, which you can then display on category pages and search results depanding on your theme configuration. To return volume price band information, set this parameter to . - /// The settings to control product search and indexing behavior. - /// The unique identifier of the search tuning rule. - /// The category ID that the search tuning rule applies to. - /// + /// + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product search results by any of its properties, including product code, type, category, and name. 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=categoryId+eq+12" + /// Used to page results from a query. Indicates the maximum number of entities to return from a query. Default value: 12. Max value is 200. + /// The terms to search on. + /// + /// + /// + /// + /// + /// The element to sort the results by and the order in which the results appear. Either ascending order (a-z) which accepts 'asc' or 'asc' or descending order (z-a) which accepts 'desc' or 'desc'. The sortBy parameter follows an available property. /// /// /// @@ -177,50 +104,24 @@ public virtual Mozu.Api.Contracts.ProductRuntime.ProductSearchResult Search(stri /// var productSearchResult = await productsearchresult.SearchAsync( query, filter, facetTemplate, facetTemplateSubset, facet, facetFieldRangeQuery, facetHierPrefix, facetHierValue, facetHierDepth, facetStartIndex, facetPageSize, facetSettings, facetValueFilter, sortBy, pageSize, startIndex, searchSettings, enableSearchTuningRules, searchTuningRuleContext, searchTuningRuleCode, facetTemplateExclude, facetPrefix, responseOptions, cursorMark, facetValueSort, responseFields); /// /// - public virtual async Task SearchAsync(string query = null, string filter = null, string facetTemplate = null, string facetTemplateSubset = null, string facet = null, string facetFieldRangeQuery = null, string facetHierPrefix = null, string facetHierValue = null, string facetHierDepth = null, string facetStartIndex = null, string facetPageSize = null, string facetSettings = null, string facetValueFilter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, string searchSettings = null, bool? enableSearchTuningRules = null, string searchTuningRuleContext = null, string searchTuningRuleCode = null, string facetTemplateExclude = null, string facetPrefix = null, string responseOptions = null, string cursorMark = null, string facetValueSort = null, string responseFields = null) + public virtual async Task SearchAsync(string query = null, string filter = null, string facetTemplate = null, string facetTemplateSubset = null, string facet = null, string facetFieldRangeQuery = null, string facetHierPrefix = null, string facetHierValue = null, string facetHierDepth = null, string facetStartIndex = null, string facetPageSize = null, string facetSettings = null, string facetValueFilter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, string searchSettings = null, bool? enableSearchTuningRules = null, string searchTuningRuleContext = null, string searchTuningRuleCode = null, string facetTemplateExclude = null, string facetPrefix = null, string responseOptions = null, string cursorMark = null, string facetValueSort = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductSearchResultClient.SearchClient( query, filter, facetTemplate, facetTemplateSubset, facet, facetFieldRangeQuery, facetHierPrefix, facetHierValue, facetHierDepth, facetStartIndex, facetPageSize, facetSettings, facetValueFilter, sortBy, pageSize, startIndex, searchSettings, enableSearchTuningRules, searchTuningRuleContext, searchTuningRuleCode, facetTemplateExclude, facetPrefix, responseOptions, cursorMark, facetValueSort, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Suggests possible search terms as the shopper enters search text. - /// - /// Specifies the group that you want this operation to return in the response. This parameter accepts one or more values, separated by comma.For example, if you set this parameter to , then this operation returns a object that contains suggestions for products that match the user entered characters in the search field.The valid values for this parameter are the following:* — Indicates that products should be matched against and returned in the response. The search value is compared against product name and code. The response contains a with a name of and a collection of . Each collection item has a of Product and contains a equal to a complete product object.* — Indicates that categories should be matched against and returned in the response. The search value is compared to category name. The response contains a with a name of and a collection of . Each collection item has a of Category and contains a equal to a complete category object.* — Indicates that previously used search terms (keywords) should be matched against and returned in the response, sorted by frequency of use. Keep in mind that it is not currently possible to edit or remove search terms that may be considered undesirable via the API. The response contains a with a name of and a collection of . Each collection item has a of Term and contains a equal to a string value of the matched search term.The default value is ; however, the Core Theme only integrates and ignores the group.This operation only returns data that is then made available to your theme. If you set this paramter to multiple values, returns multiple in the response. Depending on your requirements, you can then customize your theme to display the groups together or as separate lists in the displayed search suggestions. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var productsearchresult = new ProductSearchResult(); - /// var searchSuggestionResult = productsearchresult.Suggest( query, groups, pageSize, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ProductRuntime.SearchSuggestionResult Suggest(string query = null, string groups = null, int? pageSize = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductSearchResultClient.SuggestClient( query, groups, pageSize, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Suggests possible search terms as the shopper enters search text. + /// /// - /// Specifies the group that you want this operation to return in the response. This parameter accepts one or more values, separated by comma.For example, if you set this parameter to , then this operation returns a object that contains suggestions for products that match the user entered characters in the search field.The valid values for this parameter are the following:* — Indicates that products should be matched against and returned in the response. The search value is compared against product name and code. The response contains a with a name of and a collection of . Each collection item has a of Product and contains a equal to a complete product object.* — Indicates that categories should be matched against and returned in the response. The search value is compared to category name. The response contains a with a name of and a collection of . Each collection item has a of Category and contains a equal to a complete category object.* — Indicates that previously used search terms (keywords) should be matched against and returned in the response, sorted by frequency of use. Keep in mind that it is not currently possible to edit or remove search terms that may be considered undesirable via the API. The response contains a with a name of and a collection of . Each collection item has a of Term and contains a equal to a string value of the matched search term.The default value is ; however, the Core Theme only integrates and ignores the group.This operation only returns data that is then made available to your theme. If you set this paramter to multiple values, returns multiple in the response. Depending on your requirements, you can then customize your theme to display the groups together or as separate lists in the displayed search suggestions. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Use this field to include those fields which are not included by default. + /// + /// Indicates the maximum number of entities to return from a query. Default value: 10. Max value: 200. + /// + /// /// /// /// @@ -230,12 +131,12 @@ public virtual Mozu.Api.Contracts.ProductRuntime.SearchSuggestionResult Suggest( /// var searchSuggestionResult = await productsearchresult.SuggestAsync( query, groups, pageSize, responseFields); /// /// - public virtual async Task SuggestAsync(string query = null, string groups = null, int? pageSize = null, string responseFields = null) + public virtual async Task SuggestAsync(string query = null, string groups = null, int? pageSize = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ProductSearchResultClient.SuggestClient( query, groups, pageSize, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Catalog/Storefront/ShippingResource.cs b/Mozu.Api/Resources/Commerce/Catalog/Storefront/ShippingResource.cs old mode 100644 new mode 100755 index 2bad2939..c65e33ef --- a/Mozu.Api/Resources/Commerce/Catalog/Storefront/ShippingResource.cs +++ b/Mozu.Api/Resources/Commerce/Catalog/Storefront/ShippingResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Catalog.Storefront { @@ -37,38 +38,38 @@ public ShippingResource CloneWithApiContext(Action contextModificat } + /// - /// Retrieves the shipping rates applicable for the site. + /// /// - /// Set this parameter to to retrieve the full raw JSON response from a shipping carrier (instead of just the shipping rate). - /// Use this field to include those fields which are not included by default. - /// Properties required to request a shipping rate calculation. + /// + /// /// - /// + /// List{} /// /// /// /// var shipping = new Shipping(); - /// var ratesResponse = shipping.GetRates( rateRequest, includeRawResponse, responseFields); + /// var ratesResponseGroup = await shipping.GetMultiRatesAsync( rateRequestGroupList, includeRawResponse); /// /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingRuntime.RatesResponse GetRates(Mozu.Api.Contracts.ShippingRuntime.RateRequest rateRequest, bool? includeRawResponse = null, string responseFields = null) + public virtual async Task> GetMultiRatesAsync(List rateRequestGroupList, bool? includeRawResponse = null, CancellationToken ct = default(CancellationToken)) { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ShippingClient.GetRatesClient( rateRequest, includeRawResponse, responseFields); + MozuClient> response; + var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ShippingClient.GetMultiRatesClient( rateRequestGroupList, includeRawResponse); client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); } + /// - /// Retrieves the shipping rates applicable for the site. + /// /// - /// Set this parameter to to retrieve the full raw JSON response from a shipping carrier (instead of just the shipping rate). - /// Use this field to include those fields which are not included by default. - /// Properties required to request a shipping rate calculation. + /// + /// + /// Properties of the shipping rate request sent on behalf of the storefront website. /// /// /// @@ -78,12 +79,12 @@ public virtual Mozu.Api.Contracts.ShippingRuntime.RatesResponse GetRates(Mozu.Ap /// var ratesResponse = await shipping.GetRatesAsync( rateRequest, includeRawResponse, responseFields); /// /// - public virtual async Task GetRatesAsync(Mozu.Api.Contracts.ShippingRuntime.RateRequest rateRequest, bool? includeRawResponse = null, string responseFields = null) + public virtual async Task GetRatesAsync(Mozu.Api.Contracts.ShippingRuntime.RateRequest rateRequest, bool? includeRawResponse = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Catalog.Storefront.ShippingClient.GetRatesClient( rateRequest, includeRawResponse, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/ChannelGroupResource.cs b/Mozu.Api/Resources/Commerce/ChannelGroupResource.cs old mode 100644 new mode 100755 index 3def0d27..3e296c75 --- a/Mozu.Api/Resources/Commerce/ChannelGroupResource.cs +++ b/Mozu.Api/Resources/Commerce/ChannelGroupResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce { @@ -37,42 +38,15 @@ public ChannelGroupResource CloneWithApiContext(Action contextModif } - /// - /// Retrieves a list of defined channel groups according to any filter and sort criteria specified in the request. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var channelgroup = new ChannelGroup(); - /// var channelGroupCollection = channelgroup.GetChannelGroups( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroupCollection GetChannelGroups(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.GetChannelGroupsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of defined channel groups according to any filter and sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroupCollectio /// var channelGroupCollection = await channelgroup.GetChannelGroupsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetChannelGroupsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetChannelGroupsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.GetChannelGroupsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a defined channel group. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var channelgroup = new ChannelGroup(); - /// var channelGroup = channelgroup.GetChannelGroup( code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup GetChannelGroup(string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.GetChannelGroupClient( code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a defined channel group. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// The code that uniquely identifies the channel group. + /// /// /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup GetChann /// var channelGroup = await channelgroup.GetChannelGroupAsync( code, responseFields); /// /// - public virtual async Task GetChannelGroupAsync(string code, string responseFields = null) + public virtual async Task GetChannelGroupAsync(string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.GetChannelGroupClient( code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new group of channels with common information. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of a group of channels that share common information. - /// - /// - /// - /// - /// - /// var channelgroup = new ChannelGroup(); - /// var channelGroup = channelgroup.CreateChannelGroup( channelGroup, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup CreateChannelGroup(Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup channelGroup, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.CreateChannelGroupClient( channelGroup, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new group of channels with common information. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a group of channels that share common information. + /// + /// Properties of the channel group to create. /// /// /// @@ -180,48 +106,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup CreateCh /// var channelGroup = await channelgroup.CreateChannelGroupAsync( channelGroup, responseFields); /// /// - public virtual async Task CreateChannelGroupAsync(Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup channelGroup, string responseFields = null) + public virtual async Task CreateChannelGroupAsync(Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup channelGroup, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.CreateChannelGroupClient( channelGroup, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of a defined channel group. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of a group of channels that share common information. - /// - /// - /// - /// - /// - /// var channelgroup = new ChannelGroup(); - /// var channelGroup = channelgroup.UpdateChannelGroup( channelGroup, code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup UpdateChannelGroup(Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup channelGroup, string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.UpdateChannelGroupClient( channelGroup, code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a defined channel group. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of a group of channels that share common information. + /// Code that identifies the channel group. + /// + /// Properties of the channel group to update. /// /// /// @@ -231,41 +132,19 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup UpdateCh /// var channelGroup = await channelgroup.UpdateChannelGroupAsync( channelGroup, code, responseFields); /// /// - public virtual async Task UpdateChannelGroupAsync(Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup channelGroup, string code, string responseFields = null) + public virtual async Task UpdateChannelGroupAsync(Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelGroup channelGroup, string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.UpdateChannelGroupClient( channelGroup, code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a defined group of channels, which removes the group association with each channel in the group but does not delete the channel definitions themselves. - /// - /// User-defined code that uniqely identifies the channel group. - /// - /// - /// - /// - /// - /// var channelgroup = new ChannelGroup(); - /// channelgroup.DeleteChannelGroup( code); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteChannelGroup(string code) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.DeleteChannelGroupClient( code); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a defined group of channels, which removes the group association with each channel in the group but does not delete the channel definitions themselves. + /// /// /// User-defined code that uniqely identifies the channel group. /// @@ -277,12 +156,12 @@ public virtual void DeleteChannelGroup(string code) /// await channelgroup.DeleteChannelGroupAsync( code); /// /// - public virtual async Task DeleteChannelGroupAsync(string code) + public virtual async Task DeleteChannelGroupAsync(string code, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelGroupClient.DeleteChannelGroupClient( code); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/ChannelResource.cs b/Mozu.Api/Resources/Commerce/ChannelResource.cs old mode 100644 new mode 100755 index b359514e..a5a97c5a --- a/Mozu.Api/Resources/Commerce/ChannelResource.cs +++ b/Mozu.Api/Resources/Commerce/ChannelResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce { @@ -37,42 +38,15 @@ public ChannelResource CloneWithApiContext(Action contextModificati } - /// - /// Retrieves a list of channels defined for a tenant according to any filter or sort criteria specified in the request. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var channel = new Channel(); - /// var channelCollection = channel.GetChannels( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelCollection GetChannels(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelClient.GetChannelsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of channels defined for a tenant according to any filter or sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.ChannelCollection Get /// var channelCollection = await channel.GetChannelsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetChannelsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetChannelsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelClient.GetChannelsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the channel specified in the request. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var channel = new Channel(); - /// var channel = channel.GetChannel( code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.Channel GetChannel(string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelClient.GetChannelClient( code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the channel specified in the request. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the channel to retrieve. + /// /// /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.Channel GetChannel(st /// var channel = await channel.GetChannelAsync( code, responseFields); /// /// - public virtual async Task GetChannelAsync(string code, string responseFields = null) + public virtual async Task GetChannelAsync(string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelClient.GetChannelClient( code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new channel that defines a new logical business division to use for financial reporting. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of a channel used to divide a company into logical business divisions, such as "US Retail," "US Online," or "Amazon." All sites and orders are associated with a channel. - /// - /// - /// - /// - /// - /// var channel = new Channel(); - /// var channel = channel.CreateChannel( channel, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.Channel CreateChannel(Mozu.Api.Contracts.CommerceRuntime.Channels.Channel channel, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelClient.CreateChannelClient( channel, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new channel that defines a new logical business division to use for financial reporting. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a channel used to divide a company into logical business divisions, such as "US Retail," "US Online," or "Amazon." All sites and orders are associated with a channel. + /// + /// Properties of the channel to create. /// /// /// @@ -180,48 +106,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.Channel CreateChannel /// var channel = await channel.CreateChannelAsync( channel, responseFields); /// /// - public virtual async Task CreateChannelAsync(Mozu.Api.Contracts.CommerceRuntime.Channels.Channel channel, string responseFields = null) + public virtual async Task CreateChannelAsync(Mozu.Api.Contracts.CommerceRuntime.Channels.Channel channel, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelClient.CreateChannelClient( channel, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more details of a defined channel, including the associated sites. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of a channel used to divide a company into logical business divisions, such as "US Retail," "US Online," or "Amazon." All sites and orders are associated with a channel. - /// - /// - /// - /// - /// - /// var channel = new Channel(); - /// var channel = channel.UpdateChannel( channel, code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.Channel UpdateChannel(Mozu.Api.Contracts.CommerceRuntime.Channels.Channel channel, string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelClient.UpdateChannelClient( channel, code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more details of a defined channel, including the associated sites. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of a channel used to divide a company into logical business divisions, such as "US Retail," "US Online," or "Amazon." All sites and orders are associated with a channel. + /// User-defined code that identifies the channel to update. + /// + /// Properties of a the channel to update. /// /// /// @@ -231,43 +132,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Channels.Channel UpdateChannel /// var channel = await channel.UpdateChannelAsync( channel, code, responseFields); /// /// - public virtual async Task UpdateChannelAsync(Mozu.Api.Contracts.CommerceRuntime.Channels.Channel channel, string code, string responseFields = null) + public virtual async Task UpdateChannelAsync(Mozu.Api.Contracts.CommerceRuntime.Channels.Channel channel, string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelClient.UpdateChannelClient( channel, code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a defined channel for the tenant and removes the defined site associations. After deleting this channel, assign its associated sites to another channel. - /// - /// User-defined code that uniqely identifies the channel group. - /// - /// - /// - /// - /// - /// var channel = new Channel(); - /// channel.DeleteChannel( code); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteChannel(string code) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ChannelClient.DeleteChannelClient( code); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a defined channel for the tenant and removes the defined site associations. After deleting this channel, assign its associated sites to another channel. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// User-defined code that identifies the channel to delete. /// /// /// @@ -277,12 +156,12 @@ public virtual void DeleteChannel(string code) /// await channel.DeleteChannelAsync( code); /// /// - public virtual async Task DeleteChannelAsync(string code) + public virtual async Task DeleteChannelAsync(string code, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ChannelClient.DeleteChannelClient( code); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/CheckoutResource.cs b/Mozu.Api/Resources/Commerce/CheckoutResource.cs new file mode 100755 index 00000000..96e79b78 --- /dev/null +++ b/Mozu.Api/Resources/Commerce/CheckoutResource.cs @@ -0,0 +1,328 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce +{ + /// + /// + /// + public partial class CheckoutResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public CheckoutResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public CheckoutResource CloneWithApiContext(Action contextModification) + { + return new CheckoutResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var checkout = new Checkout(); + /// var checkoutCollection = await checkout.GetCheckoutsAsync( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); + /// + /// + public virtual async Task GetCheckoutsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.GetCheckoutsClient( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// List{string} + /// + /// + /// + /// var checkout = new Checkout(); + /// var string = await checkout.GetAvailableActionsAsync( checkoutId); + /// + /// + public virtual async Task> GetAvailableActionsAsync(string checkoutId, CancellationToken ct = default(CancellationToken)) + { + MozuClient> response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.GetAvailableActionsClient( checkoutId); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// List{} + /// + /// + /// + /// var checkout = new Checkout(); + /// var checkoutGroupRates = await checkout.GetAvailableShippingMethodsAsync( checkoutId); + /// + /// + public virtual async Task> GetAvailableShippingMethodsAsync(string checkoutId, CancellationToken ct = default(CancellationToken)) + { + MozuClient> response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.GetAvailableShippingMethodsClient( checkoutId); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var checkout = new Checkout(); + /// var checkout = await checkout.GetCheckoutAsync( checkoutId, responseFields); + /// + /// + public virtual async Task GetCheckoutAsync(string checkoutId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.GetCheckoutClient( checkoutId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var checkout = new Checkout(); + /// var checkout = await checkout.CreateCheckoutFromCartAsync( cartId, responseFields); + /// + /// + public virtual async Task CreateCheckoutFromCartAsync(string cartId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.CreateCheckoutFromCartClient( cartId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var checkout = new Checkout(); + /// var checkout = await checkout.PerformCheckoutActionAsync( action, checkoutId, responseFields); + /// + /// + public virtual async Task PerformCheckoutActionAsync(Mozu.Api.Contracts.CommerceRuntime.Checkouts.CheckoutAction action, string checkoutId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.PerformCheckoutActionClient( action, checkoutId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var checkout = new Checkout(); + /// await checkout.ResendCheckoutConfirmationEmailAsync( checkoutId); + /// + /// + public virtual async Task ResendCheckoutConfirmationEmailAsync(string checkoutId, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.ResendCheckoutConfirmationEmailClient( checkoutId); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var checkout = new Checkout(); + /// var checkout = await checkout.SetShippingMethodsAsync( groupShippingMethods, checkoutId, responseFields); + /// + /// + public virtual async Task SetShippingMethodsAsync(List groupShippingMethods, string checkoutId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.SetShippingMethodsClient( groupShippingMethods, checkoutId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var checkout = new Checkout(); + /// var checkout = await checkout.UpdateCheckoutAsync( checkout, checkoutId, responseFields); + /// + /// + public virtual async Task UpdateCheckoutAsync(Mozu.Api.Contracts.CommerceRuntime.Checkouts.Checkout checkout, string checkoutId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.UpdateCheckoutClient( checkout, checkoutId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var checkout = new Checkout(); + /// var checkout = await checkout.ProcessDigitalWalletAsync( digitalWallet, checkoutId, digitalWalletType, responseFields); + /// + /// + public virtual async Task ProcessDigitalWalletAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.DigitalWallet digitalWallet, string checkoutId, string digitalWalletType, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.ProcessDigitalWalletClient( digitalWallet, checkoutId, digitalWalletType, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var checkout = new Checkout(); + /// var checkout = await checkout.ChangeCheckoutPriceListAsync( priceListCode, checkoutId, responseFields); + /// + /// + public virtual async Task ChangeCheckoutPriceListAsync(string priceListCode, string checkoutId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.CheckoutClient.ChangeCheckoutPriceListClient( priceListCode, checkoutId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/Checkouts/AppliedDiscountResource.cs b/Mozu.Api/Resources/Commerce/Checkouts/AppliedDiscountResource.cs new file mode 100755 index 00000000..30d7ab77 --- /dev/null +++ b/Mozu.Api/Resources/Commerce/Checkouts/AppliedDiscountResource.cs @@ -0,0 +1,121 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce.Checkouts +{ + /// + /// + /// + public partial class AppliedDiscountResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public AppliedDiscountResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public AppliedDiscountResource CloneWithApiContext(Action contextModification) + { + return new AppliedDiscountResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var applieddiscount = new AppliedDiscount(); + /// var checkout = await applieddiscount.ApplyCouponAsync( checkoutId, couponCode, responseFields); + /// + /// + public virtual async Task ApplyCouponAsync(string checkoutId, string couponCode, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.AppliedDiscountClient.ApplyCouponClient( checkoutId, couponCode, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var applieddiscount = new AppliedDiscount(); + /// var checkout = await applieddiscount.RemoveCouponsAsync( checkoutId); + /// + /// + public virtual async Task RemoveCouponsAsync(string checkoutId, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.AppliedDiscountClient.RemoveCouponsClient( checkoutId); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var applieddiscount = new AppliedDiscount(); + /// var checkout = await applieddiscount.RemoveCouponAsync( checkoutId, couponCode); + /// + /// + public virtual async Task RemoveCouponAsync(string checkoutId, string couponCode, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.AppliedDiscountClient.RemoveCouponClient( checkoutId, couponCode); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/Checkouts/DestinationResource.cs b/Mozu.Api/Resources/Commerce/Checkouts/DestinationResource.cs new file mode 100755 index 00000000..e01ddd1a --- /dev/null +++ b/Mozu.Api/Resources/Commerce/Checkouts/DestinationResource.cs @@ -0,0 +1,173 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce.Checkouts +{ + /// + /// + /// + public partial class DestinationResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public DestinationResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public DestinationResource CloneWithApiContext(Action contextModification) + { + return new DestinationResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// + /// + /// List{} + /// + /// + /// + /// var destination = new Destination(); + /// var destination = await destination.GetDestinationsAsync( checkoutId); + /// + /// + public virtual async Task> GetDestinationsAsync(string checkoutId, CancellationToken ct = default(CancellationToken)) + { + MozuClient> response; + var client = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.GetDestinationsClient( checkoutId); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var destination = new Destination(); + /// var destination = await destination.GetDestinationAsync( checkoutId, destinationId, responseFields); + /// + /// + public virtual async Task GetDestinationAsync(string checkoutId, string destinationId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.GetDestinationClient( checkoutId, destinationId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var destination = new Destination(); + /// var destination = await destination.AddDestinationAsync( destination, checkoutId, responseFields); + /// + /// + public virtual async Task AddDestinationAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Destination destination, string checkoutId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.AddDestinationClient( destination, checkoutId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var destination = new Destination(); + /// var destination = await destination.UpdateDestinationAsync( destination, checkoutId, destinationId, responseFields); + /// + /// + public virtual async Task UpdateDestinationAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Destination destination, string checkoutId, string destinationId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.UpdateDestinationClient( destination, checkoutId, destinationId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var destination = new Destination(); + /// await destination.RemoveDestinationAsync( checkoutId, destinationId); + /// + /// + public virtual async Task RemoveDestinationAsync(string checkoutId, string destinationId, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.DestinationClient.RemoveDestinationClient( checkoutId, destinationId); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/Checkouts/OrderAttributeResource.cs b/Mozu.Api/Resources/Commerce/Checkouts/OrderAttributeResource.cs new file mode 100755 index 00000000..253a8992 --- /dev/null +++ b/Mozu.Api/Resources/Commerce/Checkouts/OrderAttributeResource.cs @@ -0,0 +1,121 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce.Checkouts +{ + /// + /// + /// + public partial class OrderAttributeResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public OrderAttributeResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public OrderAttributeResource CloneWithApiContext(Action contextModification) + { + return new OrderAttributeResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// + /// + /// List{} + /// + /// + /// + /// var orderattribute = new OrderAttribute(); + /// var orderAttribute = await orderattribute.GetCheckoutAttributesAsync( checkoutId); + /// + /// + public virtual async Task> GetCheckoutAttributesAsync(string checkoutId, CancellationToken ct = default(CancellationToken)) + { + MozuClient> response; + var client = Mozu.Api.Clients.Commerce.Checkouts.OrderAttributeClient.GetCheckoutAttributesClient( checkoutId); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// List{} + /// + /// + /// + /// var orderattribute = new OrderAttribute(); + /// var orderAttribute = await orderattribute.CreateCheckoutAttributesAsync( checkoutAttributes, checkoutId); + /// + /// + public virtual async Task> CreateCheckoutAttributesAsync(List checkoutAttributes, string checkoutId, CancellationToken ct = default(CancellationToken)) + { + MozuClient> response; + var client = Mozu.Api.Clients.Commerce.Checkouts.OrderAttributeClient.CreateCheckoutAttributesClient( checkoutAttributes, checkoutId); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// List{} + /// + /// + /// + /// var orderattribute = new OrderAttribute(); + /// var orderAttribute = await orderattribute.UpdateCheckoutAttributeAsync( checkoutAttributes, checkoutId, removeMissing); + /// + /// + public virtual async Task> UpdateCheckoutAttributeAsync(List checkoutAttributes, string checkoutId, bool? removeMissing = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient> response; + var client = Mozu.Api.Clients.Commerce.Checkouts.OrderAttributeClient.UpdateCheckoutAttributeClient( checkoutAttributes, checkoutId, removeMissing); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/Checkouts/OrderItemResource.cs b/Mozu.Api/Resources/Commerce/Checkouts/OrderItemResource.cs new file mode 100755 index 00000000..270e4faf --- /dev/null +++ b/Mozu.Api/Resources/Commerce/Checkouts/OrderItemResource.cs @@ -0,0 +1,126 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce.Checkouts +{ + /// + /// + /// + public partial class OrderItemResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public OrderItemResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public OrderItemResource CloneWithApiContext(Action contextModification) + { + return new OrderItemResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var orderitem = new OrderItem(); + /// var checkout = await orderitem.SplitItemAsync( checkoutId, itemId, quantity, responseFields); + /// + /// + public virtual async Task SplitItemAsync(string checkoutId, string itemId, int? quantity = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.OrderItemClient.SplitItemClient( checkoutId, itemId, quantity, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var orderitem = new OrderItem(); + /// var checkout = await orderitem.BulkUpdateItemDestinationsAsync( itemsForDestination, checkoutId, responseFields); + /// + /// + public virtual async Task BulkUpdateItemDestinationsAsync(List itemsForDestination, string checkoutId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.OrderItemClient.BulkUpdateItemDestinationsClient( itemsForDestination, checkoutId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var orderitem = new OrderItem(); + /// var checkout = await orderitem.UpdateItemDestinationAsync( checkoutId, itemId, destinationId, responseFields); + /// + /// + public virtual async Task UpdateItemDestinationAsync(string checkoutId, string itemId, string destinationId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.OrderItemClient.UpdateItemDestinationClient( checkoutId, itemId, destinationId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/Checkouts/PaymentResource.cs b/Mozu.Api/Resources/Commerce/Checkouts/PaymentResource.cs new file mode 100755 index 00000000..eb79c99d --- /dev/null +++ b/Mozu.Api/Resources/Commerce/Checkouts/PaymentResource.cs @@ -0,0 +1,99 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce.Checkouts +{ + /// + /// + /// + public partial class PaymentResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public PaymentResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public PaymentResource CloneWithApiContext(Action contextModification) + { + return new PaymentResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var payment = new Payment(); + /// var checkout = await payment.PerformPaymentActionAsync( action, checkoutId, paymentId, responseFields); + /// + /// + public virtual async Task PerformPaymentActionAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string checkoutId, string paymentId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.PaymentClient.PerformPaymentActionClient( action, checkoutId, paymentId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var payment = new Payment(); + /// var checkout = await payment.CreatePaymentActionAsync( action, checkoutId, responseFields); + /// + /// + public virtual async Task CreatePaymentActionAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string checkoutId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Checkouts.PaymentClient.CreatePaymentActionClient( action, checkoutId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/Customer/Accounts/CardResource.cs b/Mozu.Api/Resources/Commerce/Customer/Accounts/CardResource.cs old mode 100644 new mode 100755 index a74dd3a9..9412a0e8 --- a/Mozu.Api/Resources/Commerce/Customer/Accounts/CardResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Accounts/CardResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Accounts { /// - /// Use the Cards subresource to manage stored credit cards for customer accounts. stores limited card data in the Customer service for expedited ordering purposes; however, the complete card data is stored in the Payment service. + /// Use the Cards subresource to manage stored credit cards for customer accounts. Mozu stores limited card data in the Customer service for expedited ordering purposes; however, the complete card data is stored in the Payment service. /// public partial class CardResource { /// @@ -37,38 +38,13 @@ public CardResource CloneWithApiContext(Action contextModification) } - /// - /// Retrieves the details of a credit card stored with a customer account billing contact. - /// - /// Unique identifier of the customer account. - /// Unique identifier of the card associated with the customer account billing contact. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var card = new Card(); - /// var card = card.GetAccountCard( accountId, cardId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Card GetAccountCard(int accountId, string cardId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.GetAccountCardClient( accountId, cardId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a credit card stored with a customer account billing contact. + /// /// /// Unique identifier of the customer account. /// Unique identifier of the card associated with the customer account billing contact. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -78,46 +54,22 @@ public virtual Mozu.Api.Contracts.Customer.Card GetAccountCard(int accountId, st /// var card = await card.GetAccountCardAsync( accountId, cardId, responseFields); /// /// - public virtual async Task GetAccountCardAsync(int accountId, string cardId, string responseFields = null) + public virtual async Task GetAccountCardAsync(int accountId, string cardId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.GetAccountCardClient( accountId, cardId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves all stored credit cards for the customer account. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var card = new Card(); - /// var cardCollection = card.GetAccountCards( accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CardCollection GetAccountCards(int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.GetAccountCardsClient( accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves all stored credit cards for the customer account. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -127,48 +79,23 @@ public virtual Mozu.Api.Contracts.Customer.CardCollection GetAccountCards(int ac /// var cardCollection = await card.GetAccountCardsAsync( accountId, responseFields); /// /// - public virtual async Task GetAccountCardsAsync(int accountId, string responseFields = null) + public virtual async Task GetAccountCardsAsync(int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.GetAccountCardsClient( accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new credit card record and stores it for the customer account. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of a credit card used to submit payment for an order. - /// - /// - /// - /// - /// - /// var card = new Card(); - /// var card = card.AddAccountCard( card, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Card AddAccountCard(Mozu.Api.Contracts.Customer.Card card, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.AddAccountCardClient( card, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new credit card record and stores it for the customer account. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of a credit card used to submit payment for an order. + /// + /// Properties of the customer credit card to add to the account. /// /// /// @@ -178,50 +105,24 @@ public virtual Mozu.Api.Contracts.Customer.Card AddAccountCard(Mozu.Api.Contract /// var card = await card.AddAccountCardAsync( card, accountId, responseFields); /// /// - public virtual async Task AddAccountCardAsync(Mozu.Api.Contracts.Customer.Card card, int accountId, string responseFields = null) + public virtual async Task AddAccountCardAsync(Mozu.Api.Contracts.Customer.Card card, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.AddAccountCardClient( card, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update one or more properties of a credit card defined for a customer account. - /// - /// Unique identifier of the customer account. - /// Unique identifier of the card associated with the customer account billing contact. - /// Use this field to include those fields which are not included by default. - /// Properties of a credit card used to submit payment for an order. - /// - /// - /// - /// - /// - /// var card = new Card(); - /// var card = card.UpdateAccountCard( card, accountId, cardId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Card UpdateAccountCard(Mozu.Api.Contracts.Customer.Card card, int accountId, string cardId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.UpdateAccountCardClient( card, accountId, cardId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update one or more properties of a credit card defined for a customer account. + /// /// /// Unique identifier of the customer account. - /// Unique identifier of the card associated with the customer account billing contact. - /// Use this field to include those fields which are not included by default. - /// Properties of a credit card used to submit payment for an order. + /// Unique identifier of the credit card. + /// + /// Properties of the customer account credit card to update. /// /// /// @@ -231,45 +132,22 @@ public virtual Mozu.Api.Contracts.Customer.Card UpdateAccountCard(Mozu.Api.Contr /// var card = await card.UpdateAccountCardAsync( card, accountId, cardId, responseFields); /// /// - public virtual async Task UpdateAccountCardAsync(Mozu.Api.Contracts.Customer.Card card, int accountId, string cardId, string responseFields = null) + public virtual async Task UpdateAccountCardAsync(Mozu.Api.Contracts.Customer.Card card, int accountId, string cardId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.UpdateAccountCardClient( card, accountId, cardId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes a stored credit card from a customer account. - /// - /// Unique identifier of the customer account. - /// Unique identifier of the card associated with the customer account billing contact. - /// - /// - /// - /// - /// - /// var card = new Card(); - /// card.DeleteAccountCard( accountId, cardId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteAccountCard(int accountId, string cardId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.DeleteAccountCardClient( accountId, cardId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes a stored credit card from a customer account. + /// /// /// Unique identifier of the customer account. - /// Unique identifier of the card associated with the customer account billing contact. + /// Unique identifier of the credit card to delete. /// /// /// @@ -279,12 +157,12 @@ public virtual void DeleteAccountCard(int accountId, string cardId) /// await card.DeleteAccountCardAsync( accountId, cardId); /// /// - public virtual async Task DeleteAccountCardAsync(int accountId, string cardId) + public virtual async Task DeleteAccountCardAsync(int accountId, string cardId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CardClient.DeleteAccountCardClient( accountId, cardId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerAttributeResource.cs b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerAttributeResource.cs old mode 100644 new mode 100755 index 37515536..48e7d561 --- a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerAttributeResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerAttributeResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Accounts { @@ -37,38 +38,13 @@ public CustomerAttributeResource CloneWithApiContext(Action context } - /// - /// Retrieves the contents of an attribute associated with the specified customer account. - /// - /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var customerattribute = new CustomerAttribute(); - /// var customerAttribute = customerattribute.GetAccountAttribute( accountId, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAttribute GetAccountAttribute(int accountId, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.GetAccountAttributeClient( accountId, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the contents of an attribute associated with the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// Identifier of the customer account associated with the attribute to retrieve. + /// + /// /// /// /// @@ -78,52 +54,24 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAttribute GetAccountAttribute /// var customerAttribute = await customerattribute.GetAccountAttributeAsync( accountId, attributeFQN, responseFields); /// /// - public virtual async Task GetAccountAttributeAsync(int accountId, string attributeFQN, string responseFields = null) + public virtual async Task GetAccountAttributeAsync(int accountId, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.GetAccountAttributeClient( accountId, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the list of customer account attributes. - /// - /// Unique identifier of the customer account. - /// - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// - /// - /// var customerattribute = new CustomerAttribute(); - /// var customerAttributeCollection = customerattribute.GetAccountAttributes( accountId, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAttributeCollection GetAccountAttributes(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.GetAccountAttributesClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the list of customer account attributes. + /// /// - /// Unique identifier of the customer account. + /// Identifier of the customer account associated with the attributes to retrieve. /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -135,48 +83,23 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAttributeCollection GetAccoun /// var customerAttributeCollection = await customerattribute.GetAccountAttributesAsync( accountId, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAccountAttributesAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAccountAttributesAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.GetAccountAttributesClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Applies a defined attribute to the customer account specified in the request and assigns a value to the customer attribute. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of an attribute associated with a customer account. - /// - /// - /// - /// - /// - /// var customerattribute = new CustomerAttribute(); - /// var customerAttribute = customerattribute.AddAccountAttribute( attribute, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAttribute AddAccountAttribute(Mozu.Api.Contracts.Customer.CustomerAttribute attribute, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.AddAccountAttributeClient( attribute, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Applies a defined attribute to the customer account specified in the request and assigns a value to the customer attribute. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of an attribute associated with a customer account. + /// + /// The attribute to add to the customer account. /// /// /// @@ -186,50 +109,24 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAttribute AddAccountAttribute /// var customerAttribute = await customerattribute.AddAccountAttributeAsync( attribute, accountId, responseFields); /// /// - public virtual async Task AddAccountAttributeAsync(Mozu.Api.Contracts.Customer.CustomerAttribute attribute, int accountId, string responseFields = null) + public virtual async Task AddAccountAttributeAsync(Mozu.Api.Contracts.Customer.CustomerAttribute attribute, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.AddAccountAttributeClient( attribute, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more details of a customer account attribute. - /// - /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// Properties of an attribute associated with a customer account. - /// - /// - /// - /// - /// - /// var customerattribute = new CustomerAttribute(); - /// var customerAttribute = customerattribute.UpdateAccountAttribute( attribute, accountId, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAttribute UpdateAccountAttribute(Mozu.Api.Contracts.Customer.CustomerAttribute attribute, int accountId, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.UpdateAccountAttributeClient( attribute, accountId, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more details of a customer account attribute. + /// /// - /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// Properties of an attribute associated with a customer account. + /// Identifier of the customer account associated with the attribute. + /// + /// + /// Properties of the customer account attribute to update. /// /// /// @@ -239,45 +136,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAttribute UpdateAccountAttrib /// var customerAttribute = await customerattribute.UpdateAccountAttributeAsync( attribute, accountId, attributeFQN, responseFields); /// /// - public virtual async Task UpdateAccountAttributeAsync(Mozu.Api.Contracts.Customer.CustomerAttribute attribute, int accountId, string attributeFQN, string responseFields = null) + public virtual async Task UpdateAccountAttributeAsync(Mozu.Api.Contracts.Customer.CustomerAttribute attribute, int accountId, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.UpdateAccountAttributeClient( attribute, accountId, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes the attribute specified in the request from the customer account. - /// - /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// - /// - /// - /// - /// - /// var customerattribute = new CustomerAttribute(); - /// customerattribute.DeleteAccountAttribute( accountId, attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteAccountAttribute(int accountId, string attributeFQN) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.DeleteAccountAttributeClient( accountId, attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes the attribute specified in the request from the customer account. + /// /// /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// /// @@ -287,12 +161,12 @@ public virtual void DeleteAccountAttribute(int accountId, string attributeFQN) /// await customerattribute.DeleteAccountAttributeAsync( accountId, attributeFQN); /// /// - public virtual async Task DeleteAccountAttributeAsync(int accountId, string attributeFQN) + public virtual async Task DeleteAccountAttributeAsync(int accountId, string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAttributeClient.DeleteAccountAttributeClient( accountId, attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerAuditEntryResource.cs b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerAuditEntryResource.cs old mode 100644 new mode 100755 index 911e0ac9..0b3dc0c8 --- a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerAuditEntryResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerAuditEntryResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Accounts { /// - /// Use the Audit Log resource to retrieve audit logs for customer accounts. + /// /// public partial class CustomerAuditEntryResource { /// @@ -37,44 +38,16 @@ public CustomerAuditEntryResource CloneWithApiContext(Action contex } - /// - /// Retrieves audit log entries for the specified customer account. - /// - /// Unique identifier of the customer account. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var customerauditentry = new CustomerAuditEntry(); - /// var customerAuditEntryCollection = customerauditentry.GetAccountAuditLog( accountId, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAuditEntryCollection GetAccountAuditLog(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAuditEntryClient.GetAccountAuditLogClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves audit log entries for the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// /// @@ -84,12 +57,12 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAuditEntryCollection GetAccou /// var customerAuditEntryCollection = await customerauditentry.GetAccountAuditLogAsync( accountId, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAccountAuditLogAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAccountAuditLogAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerAuditEntryClient.GetAccountAuditLogClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerContactResource.cs b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerContactResource.cs old mode 100644 new mode 100755 index c419665b..9efa1fb7 --- a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerContactResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerContactResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Accounts { @@ -37,38 +38,13 @@ public CustomerContactResource CloneWithApiContext(Action contextMo } - /// - /// Retrieves the specified contact for a customer account such as a billing or shipping contact. - /// - /// Unique identifier of the customer account. - /// Unique identifer of the customer account contact being updated. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var customercontact = new CustomerContact(); - /// var customerContact = customercontact.GetAccountContact( accountId, contactId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerContact GetAccountContact(int accountId, int contactId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.GetAccountContactClient( accountId, contactId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the specified contact for a customer account such as a billing or shipping contact. + /// /// - /// Unique identifier of the customer account. - /// Unique identifer of the customer account contact being updated. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account whose contact information is being retrieved. + /// Unique identifier of the customer account contact to retrieve. + /// /// /// /// @@ -78,52 +54,24 @@ public virtual Mozu.Api.Contracts.Customer.CustomerContact GetAccountContact(int /// var customerContact = await customercontact.GetAccountContactAsync( accountId, contactId, responseFields); /// /// - public virtual async Task GetAccountContactAsync(int accountId, int contactId, string responseFields = null) + public virtual async Task GetAccountContactAsync(int accountId, int contactId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.GetAccountContactClient( accountId, contactId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of contacts for a customer according to any specified filter criteria and sort options. - /// - /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// - /// - /// var customercontact = new CustomerContact(); - /// var customerContactCollection = customercontact.GetAccountContacts( accountId, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerContactCollection GetAccountContacts(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.GetAccountContactsClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of contacts for a customer according to any specified filter criteria and sort options. + /// /// - /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account associated with the contact information to retrieve. + /// + /// + /// /// /// /// @@ -135,48 +83,23 @@ public virtual Mozu.Api.Contracts.Customer.CustomerContactCollection GetAccountC /// var customerContactCollection = await customercontact.GetAccountContactsAsync( accountId, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAccountContactsAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAccountContactsAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.GetAccountContactsClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new contact for a customer account such as a new shipping address. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Contact information, including the contact's name, address, phone numbers, email addresses, and company (if supplied). Also indicates whether this is a billing, shipping, or billing and shipping contact. - /// - /// - /// - /// - /// - /// var customercontact = new CustomerContact(); - /// var customerContact = customercontact.AddAccountContact( contact, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerContact AddAccountContact(Mozu.Api.Contracts.Customer.CustomerContact contact, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.AddAccountContactClient( contact, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new contact for a customer account such as a new shipping address. + /// /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Contact information, including the contact's name, address, phone numbers, email addresses, and company (if supplied). Also indicates whether this is a billing, shipping, or billing and shipping contact. + /// Unique identifier of the customer account containing the new contact. + /// + /// Properties of the new contact. Required properties: Contact.Email, ContactType. /// /// /// @@ -186,50 +109,24 @@ public virtual Mozu.Api.Contracts.Customer.CustomerContact AddAccountContact(Moz /// var customerContact = await customercontact.AddAccountContactAsync( contact, accountId, responseFields); /// /// - public virtual async Task AddAccountContactAsync(Mozu.Api.Contracts.Customer.CustomerContact contact, int accountId, string responseFields = null) + public virtual async Task AddAccountContactAsync(Mozu.Api.Contracts.Customer.CustomerContact contact, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.AddAccountContactClient( contact, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a contact for a specified customer account such as to update addresses or change which contact is the primary contact for billing. - /// - /// Unique identifier of the customer account. - /// Unique identifer of the customer account contact being updated. - /// Use this field to include those fields which are not included by default. - /// Contact information, including the contact's name, address, phone numbers, email addresses, and company (if supplied). Also indicates whether this is a billing, shipping, or billing and shipping contact. - /// - /// - /// - /// - /// - /// var customercontact = new CustomerContact(); - /// var customerContact = customercontact.UpdateAccountContact( contact, accountId, contactId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerContact UpdateAccountContact(Mozu.Api.Contracts.Customer.CustomerContact contact, int accountId, int contactId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.UpdateAccountContactClient( contact, accountId, contactId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a contact for a specified customer account such as to update addresses or change which contact is the primary contact for billing. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account whose contact information is being updated. /// Unique identifer of the customer account contact being updated. - /// Use this field to include those fields which are not included by default. - /// Contact information, including the contact's name, address, phone numbers, email addresses, and company (if supplied). Also indicates whether this is a billing, shipping, or billing and shipping contact. + /// + /// All properties the updated contact will have. Required properties: Name and email address. /// /// /// @@ -239,45 +136,48 @@ public virtual Mozu.Api.Contracts.Customer.CustomerContact UpdateAccountContact( /// var customerContact = await customercontact.UpdateAccountContactAsync( contact, accountId, contactId, responseFields); /// /// - public virtual async Task UpdateAccountContactAsync(Mozu.Api.Contracts.Customer.CustomerContact contact, int accountId, int contactId, string responseFields = null) + public virtual async Task UpdateAccountContactAsync(Mozu.Api.Contracts.Customer.CustomerContact contact, int accountId, int contactId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.UpdateAccountContactClient( contact, accountId, contactId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } + /// - /// Deletes a contact for the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// Unique identifer of the customer account contact being updated. + /// + /// + /// /// - /// + /// /// /// /// /// var customercontact = new CustomerContact(); - /// customercontact.DeleteAccountContact( accountId, contactId); + /// var customerContactCollection = await customercontact.AddAccountContactListAsync( contactList, accountId, responseFields); /// /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteAccountContact(int accountId, int contactId) + public virtual async Task AddAccountContactListAsync(List contactList, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.DeleteAccountContactClient( accountId, contactId); + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.AddAccountContactListClient( contactList, accountId, responseFields); client.WithContext(_apiContext); - response = client.Execute(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); } + /// - /// Deletes a contact for the specified customer account. + /// /// /// Unique identifier of the customer account. - /// Unique identifer of the customer account contact being updated. + /// Unique identifier of the customer account contact to delete. /// /// /// @@ -287,12 +187,12 @@ public virtual void DeleteAccountContact(int accountId, int contactId) /// await customercontact.DeleteAccountContactAsync( accountId, contactId); /// /// - public virtual async Task DeleteAccountContactAsync(int accountId, int contactId) + public virtual async Task DeleteAccountContactAsync(int accountId, int contactId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerContactClient.DeleteAccountContactClient( accountId, contactId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerNoteResource.cs b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerNoteResource.cs old mode 100644 new mode 100755 index 57a4699a..584d90f2 --- a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerNoteResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerNoteResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Accounts { /// - /// This resources manages notes for a customer account. For example, a client can track a shopper's interests or complaints. Only clients can add and view notes. Shoppers cannot view these notes from the My Account page. + /// Tenant administrators can add and view internal notes for a customer account. For example, a client can track a shopper's interests or complaints. Only clients can add and view notes. Shoppers cannot view these notes from the My Account page. /// public partial class CustomerNoteResource { /// @@ -37,38 +38,13 @@ public CustomerNoteResource CloneWithApiContext(Action contextModif } - /// - /// Retrieves the contents of a particular note attached to a specified customer account. - /// - /// Unique identifier of the customer account. - /// Unique identifier of a particular note to retrieve. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var customernote = new CustomerNote(); - /// var customerNote = customernote.GetAccountNote( accountId, noteId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerNote GetAccountNote(int accountId, int noteId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.GetAccountNoteClient( accountId, noteId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the contents of a particular note attached to a specified customer account. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account that contains the note being retrieved. /// Unique identifier of a particular note to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -78,54 +54,26 @@ public virtual Mozu.Api.Contracts.Customer.CustomerNote GetAccountNote(int accou /// var customerNote = await customernote.GetAccountNoteAsync( accountId, noteId, responseFields); /// /// - public virtual async Task GetAccountNoteAsync(int accountId, int noteId, string responseFields = null) + public virtual async Task GetAccountNoteAsync(int accountId, int noteId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.GetAccountNoteClient( accountId, noteId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of notes added to a customer account according to any specified filter criteria and sort options. - /// - /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var customernote = new CustomerNote(); - /// var customerNoteCollection = customernote.GetAccountNotes( accountId, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerNoteCollection GetAccountNotes(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.GetAccountNotesClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of notes added to a customer account according to any specified filter criteria and sort options. + /// /// /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -135,48 +83,23 @@ public virtual Mozu.Api.Contracts.Customer.CustomerNoteCollection GetAccountNote /// var customerNoteCollection = await customernote.GetAccountNotesAsync( accountId, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAccountNotesAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAccountNotesAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.GetAccountNotesClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a new note to the specified customer account. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of a note configured for a customer account. - /// - /// - /// - /// - /// - /// var customernote = new CustomerNote(); - /// var customerNote = customernote.AddAccountNote( note, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerNote AddAccountNote(Mozu.Api.Contracts.Customer.CustomerNote note, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.AddAccountNoteClient( note, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a new note to the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of a note configured for a customer account. + /// Unique identifier of the customer account for which to create the note. + /// + /// Properties of the customer account note to create. /// /// /// @@ -186,50 +109,24 @@ public virtual Mozu.Api.Contracts.Customer.CustomerNote AddAccountNote(Mozu.Api. /// var customerNote = await customernote.AddAccountNoteAsync( note, accountId, responseFields); /// /// - public virtual async Task AddAccountNoteAsync(Mozu.Api.Contracts.Customer.CustomerNote note, int accountId, string responseFields = null) + public virtual async Task AddAccountNoteAsync(Mozu.Api.Contracts.Customer.CustomerNote note, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.AddAccountNoteClient( note, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Modifies an existing note for a customer account. - /// - /// Unique identifier of the customer account. - /// Unique identifier of a particular note to retrieve. - /// Use this field to include those fields which are not included by default. - /// Properties of a note configured for a customer account. - /// - /// - /// - /// - /// - /// var customernote = new CustomerNote(); - /// var customerNote = customernote.UpdateAccountNote( note, accountId, noteId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerNote UpdateAccountNote(Mozu.Api.Contracts.Customer.CustomerNote note, int accountId, int noteId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.UpdateAccountNoteClient( note, accountId, noteId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Modifies an existing note for a customer account. + /// /// - /// Unique identifier of the customer account. - /// Unique identifier of a particular note to retrieve. - /// Use this field to include those fields which are not included by default. - /// Properties of a note configured for a customer account. + /// Unique identifier of the customer account note to modify. + /// Unique identifier of the note to update. + /// + /// The new content to replace the existing note. /// /// /// @@ -239,45 +136,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerNote UpdateAccountNote(Mozu.A /// var customerNote = await customernote.UpdateAccountNoteAsync( note, accountId, noteId, responseFields); /// /// - public virtual async Task UpdateAccountNoteAsync(Mozu.Api.Contracts.Customer.CustomerNote note, int accountId, int noteId, string responseFields = null) + public virtual async Task UpdateAccountNoteAsync(Mozu.Api.Contracts.Customer.CustomerNote note, int accountId, int noteId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.UpdateAccountNoteClient( note, accountId, noteId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes a note from the specified customer account. - /// - /// Unique identifier of the customer account. - /// Unique identifier of a particular note to retrieve. - /// - /// - /// - /// - /// - /// var customernote = new CustomerNote(); - /// customernote.DeleteAccountNote( accountId, noteId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteAccountNote(int accountId, int noteId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.DeleteAccountNoteClient( accountId, noteId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes a note from the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// Unique identifier of a particular note to retrieve. + /// Unique identifier of the customer account that contains the note being deleted. + /// Unique identifier of the customer account note being deleted. /// /// /// @@ -287,12 +161,12 @@ public virtual void DeleteAccountNote(int accountId, int noteId) /// await customernote.DeleteAccountNoteAsync( accountId, noteId); /// /// - public virtual async Task DeleteAccountNoteAsync(int accountId, int noteId) + public virtual async Task DeleteAccountNoteAsync(int accountId, int noteId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerNoteClient.DeleteAccountNoteClient( accountId, noteId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountResource.cs b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountResource.cs old mode 100644 new mode 100755 index 4a04b1ef..9a519674 --- a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Accounts { /// - /// Use the Customer Account Purchase Order resource to manage purchase order details for specific customer acocunts. + /// /// public partial class CustomerPurchaseOrderAccountResource { /// @@ -37,36 +38,12 @@ public CustomerPurchaseOrderAccountResource CloneWithApiContext(Action - /// Retrieves the details of the specified customer purchase order account. - /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var customerpurchaseorderaccount = new CustomerPurchaseOrderAccount(); - /// var customerPurchaseOrderAccount = customerpurchaseorderaccount.GetCustomerPurchaseOrderAccount( accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount GetCustomerPurchaseOrderAccount(int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.GetCustomerPurchaseOrderAccountClient( accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified customer purchase order account. + /// /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -76,54 +53,26 @@ public virtual Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount GetCusto /// var customerPurchaseOrderAccount = await customerpurchaseorderaccount.GetCustomerPurchaseOrderAccountAsync( accountId, responseFields); /// /// - public virtual async Task GetCustomerPurchaseOrderAccountAsync(int accountId, string responseFields = null) + public virtual async Task GetCustomerPurchaseOrderAccountAsync(int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.GetCustomerPurchaseOrderAccountClient( accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of purchase order transactions for the specified customer account according to any specified sort options. - /// - /// Unique identifier of the customer account. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var customerpurchaseorderaccount = new CustomerPurchaseOrderAccount(); - /// var purchaseOrderTransactionCollection = customerpurchaseorderaccount.GetCustomerPurchaseOrderTransactions( accountId, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.PurchaseOrderTransactionCollection GetCustomerPurchaseOrderTransactions(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.GetCustomerPurchaseOrderTransactionsClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of purchase order transactions for the specified customer account according to any specified sort options. + /// /// - /// Unique identifier of the customer account. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// /// @@ -133,48 +82,23 @@ public virtual Mozu.Api.Contracts.Customer.PurchaseOrderTransactionCollection Ge /// var purchaseOrderTransactionCollection = await customerpurchaseorderaccount.GetCustomerPurchaseOrderTransactionsAsync( accountId, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetCustomerPurchaseOrderTransactionsAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetCustomerPurchaseOrderTransactionsAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.GetCustomerPurchaseOrderTransactionsClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a purchase order account to the specified customer account.This adds the ability for the specified customer account to use the purchase order payment method. - /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the customer purchase order account. - /// - /// - /// - /// - /// - /// var customerpurchaseorderaccount = new CustomerPurchaseOrderAccount(); - /// var customerPurchaseOrderAccount = customerpurchaseorderaccount.CreateCustomerPurchaseOrderAccount( customerPurchaseOrderAccount, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount CreateCustomerPurchaseOrderAccount(Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount customerPurchaseOrderAccount, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.CreateCustomerPurchaseOrderAccountClient( customerPurchaseOrderAccount, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a purchase order account to the specified customer account.This adds the ability for the specified customer account to use the purchase order payment method. + /// /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the customer purchase order account. + /// + /// + /// /// /// /// @@ -184,48 +108,23 @@ public virtual Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount CreateCu /// var customerPurchaseOrderAccount = await customerpurchaseorderaccount.CreateCustomerPurchaseOrderAccountAsync( customerPurchaseOrderAccount, accountId, responseFields); /// /// - public virtual async Task CreateCustomerPurchaseOrderAccountAsync(Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount customerPurchaseOrderAccount, int accountId, string responseFields = null) + public virtual async Task CreateCustomerPurchaseOrderAccountAsync(Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount customerPurchaseOrderAccount, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.CreateCustomerPurchaseOrderAccountClient( customerPurchaseOrderAccount, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a purchase order transaction on the specified customer purchase order account. - /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The purchase order transaction type to add to the specified customer account. - /// - /// - /// - /// - /// - /// var customerpurchaseorderaccount = new CustomerPurchaseOrderAccount(); - /// var purchaseOrderTransaction = customerpurchaseorderaccount.CreatePurchaseOrderTransaction( purchaseOrderTransaction, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.PurchaseOrderTransaction CreatePurchaseOrderTransaction(Mozu.Api.Contracts.Customer.PurchaseOrderTransaction purchaseOrderTransaction, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.CreatePurchaseOrderTransactionClient( purchaseOrderTransaction, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a purchase order transaction on the specified customer purchase order account. + /// /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The purchase order transaction type to add to the specified customer account. + /// + /// + /// /// /// /// @@ -235,48 +134,23 @@ public virtual Mozu.Api.Contracts.Customer.PurchaseOrderTransaction CreatePurcha /// var purchaseOrderTransaction = await customerpurchaseorderaccount.CreatePurchaseOrderTransactionAsync( purchaseOrderTransaction, accountId, responseFields); /// /// - public virtual async Task CreatePurchaseOrderTransactionAsync(Mozu.Api.Contracts.Customer.PurchaseOrderTransaction purchaseOrderTransaction, int accountId, string responseFields = null) + public virtual async Task CreatePurchaseOrderTransactionAsync(Mozu.Api.Contracts.Customer.PurchaseOrderTransaction purchaseOrderTransaction, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.CreatePurchaseOrderTransactionClient( purchaseOrderTransaction, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the details of the purchase order account for the specified customer account. - /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the customer purchase order account. - /// - /// - /// - /// - /// - /// var customerpurchaseorderaccount = new CustomerPurchaseOrderAccount(); - /// var customerPurchaseOrderAccount = customerpurchaseorderaccount.UpdateCustomerPurchaseOrderAccount( customerPurchaseOrderAccount, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount UpdateCustomerPurchaseOrderAccount(Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount customerPurchaseOrderAccount, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.UpdateCustomerPurchaseOrderAccountClient( customerPurchaseOrderAccount, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of the purchase order account for the specified customer account. + /// /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the customer purchase order account. + /// + /// + /// /// /// /// @@ -286,43 +160,21 @@ public virtual Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount UpdateCu /// var customerPurchaseOrderAccount = await customerpurchaseorderaccount.UpdateCustomerPurchaseOrderAccountAsync( customerPurchaseOrderAccount, accountId, responseFields); /// /// - public virtual async Task UpdateCustomerPurchaseOrderAccountAsync(Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount customerPurchaseOrderAccount, int accountId, string responseFields = null) + public virtual async Task UpdateCustomerPurchaseOrderAccountAsync(Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccount customerPurchaseOrderAccount, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.UpdateCustomerPurchaseOrderAccountClient( customerPurchaseOrderAccount, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified customer purchase order account.This removes the ability for the specified customer account to use the purchase order payment method. - /// - /// Unique identifier of the customer account. - /// - /// - /// - /// - /// - /// var customerpurchaseorderaccount = new CustomerPurchaseOrderAccount(); - /// customerpurchaseorderaccount.DeleteCustomerPurchaseOrderAccount( accountId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCustomerPurchaseOrderAccount(int accountId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.DeleteCustomerPurchaseOrderAccountClient( accountId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified customer purchase order account.This removes the ability for the specified customer account to use the purchase order payment method. + /// /// - /// Unique identifier of the customer account. + /// /// /// /// @@ -332,12 +184,12 @@ public virtual void DeleteCustomerPurchaseOrderAccount(int accountId) /// await customerpurchaseorderaccount.DeleteCustomerPurchaseOrderAccountAsync( accountId); /// /// - public virtual async Task DeleteCustomerPurchaseOrderAccountAsync(int accountId) + public virtual async Task DeleteCustomerPurchaseOrderAccountAsync(int accountId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerPurchaseOrderAccountClient.DeleteCustomerPurchaseOrderAccountClient( accountId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerSegmentResource.cs b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerSegmentResource.cs old mode 100644 new mode 100755 index 7a961e45..e99722d4 --- a/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerSegmentResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Accounts/CustomerSegmentResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Accounts { @@ -37,44 +38,16 @@ public CustomerSegmentResource CloneWithApiContext(Action contextMo } - /// - /// Retrieves the list of segments associated with a customer account. - /// - /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var customersegment = new CustomerSegment(); - /// var customerSegmentCollection = customersegment.GetAccountSegments( accountId, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerSegmentCollection GetAccountSegments(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerSegmentClient.GetAccountSegmentsClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the list of segments associated with a customer account. + /// /// /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -84,12 +57,12 @@ public virtual Mozu.Api.Contracts.Customer.CustomerSegmentCollection GetAccountS /// var customerSegmentCollection = await customersegment.GetAccountSegmentsAsync( accountId, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAccountSegmentsAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAccountSegmentsAsync(int accountId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.CustomerSegmentClient.GetAccountSegmentsClient( accountId, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Accounts/TransactionResource.cs b/Mozu.Api/Resources/Commerce/Customer/Accounts/TransactionResource.cs old mode 100644 new mode 100755 index a4632440..6512740f --- a/Mozu.Api/Resources/Commerce/Customer/Accounts/TransactionResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Accounts/TransactionResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Accounts { @@ -37,34 +38,11 @@ public TransactionResource CloneWithApiContext(Action contextModifi } - /// - /// Retrieves a list of transactions associated with the customer account specified in the request. - /// - /// Unique identifier of the customer account. - /// - /// List{} - /// - /// - /// - /// var transaction = new Transaction(); - /// var transaction = transaction.GetTransactions( accountId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetTransactions(int accountId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.TransactionClient.GetTransactionsClient( accountId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of transactions associated with the customer account specified in the request. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account for which to retrieve transactions. /// /// List{} /// @@ -74,48 +52,23 @@ public TransactionResource CloneWithApiContext(Action contextModifi /// var transaction = await transaction.GetTransactionsAsync( accountId); /// /// - public virtual async Task> GetTransactionsAsync(int accountId) + public virtual async Task> GetTransactionsAsync(int accountId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.TransactionClient.GetTransactionsClient( accountId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new transaction for the customer account specified in the request. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of a transaction performed by a customer account. The system creates a transaction each time the customer submits an order, returns an item, picks up items for an order, or manages items on a wish list. - /// - /// - /// - /// - /// - /// var transaction = new Transaction(); - /// var transaction = transaction.AddTransaction( transaction, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Transaction AddTransaction(Mozu.Api.Contracts.Customer.Transaction transaction, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.TransactionClient.AddTransactionClient( transaction, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new transaction for the customer account specified in the request. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of a transaction performed by a customer account. The system creates a transaction each time the customer submits an order, returns an item, picks up items for an order, or manages items on a wish list. + /// + /// Properties of the transaction to create for the customer account. /// /// /// @@ -125,44 +78,21 @@ public virtual Mozu.Api.Contracts.Customer.Transaction AddTransaction(Mozu.Api.C /// var transaction = await transaction.AddTransactionAsync( transaction, accountId, responseFields); /// /// - public virtual async Task AddTransactionAsync(Mozu.Api.Contracts.Customer.Transaction transaction, int accountId, string responseFields = null) + public virtual async Task AddTransactionAsync(Mozu.Api.Contracts.Customer.Transaction transaction, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.TransactionClient.AddTransactionClient( transaction, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a transaction from the customer account specified in the request. - /// - /// Unique identifier of the customer account. - /// Unique identifier of the transaction to delete. - /// - /// - /// - /// - /// - /// var transaction = new Transaction(); - /// transaction.RemoveTransaction( accountId, transactionId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void RemoveTransaction(int accountId, string transactionId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Accounts.TransactionClient.RemoveTransactionClient( accountId, transactionId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a transaction from the customer account specified in the request. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account from which to delete the transaction. /// Unique identifier of the transaction to delete. /// /// @@ -173,12 +103,12 @@ public virtual void RemoveTransaction(int accountId, string transactionId) /// await transaction.RemoveTransactionAsync( accountId, transactionId); /// /// - public virtual async Task RemoveTransactionAsync(int accountId, string transactionId) + public virtual async Task RemoveTransactionAsync(int accountId, string transactionId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Accounts.TransactionClient.RemoveTransactionClient( accountId, transactionId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Customer/AddressValidationRequestResource.cs b/Mozu.Api/Resources/Commerce/Customer/AddressValidationRequestResource.cs old mode 100644 new mode 100755 index 27a73692..2d9b7bc4 --- a/Mozu.Api/Resources/Commerce/Customer/AddressValidationRequestResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/AddressValidationRequestResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer { @@ -37,36 +38,12 @@ public AddressValidationRequestResource CloneWithApiContext(Action } - /// - /// Validates the customer address supplied in the request. - /// - /// Use this field to include those fields which are not included by default. - /// 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. - /// - /// - /// - /// - /// - /// var addressvalidationrequest = new AddressValidationRequest(); - /// var addressValidationResponse = addressvalidationrequest.ValidateAddress( addressValidationRequest, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.AddressValidationResponse ValidateAddress(Mozu.Api.Contracts.Customer.AddressValidationRequest addressValidationRequest, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.AddressValidationRequestClient.ValidateAddressClient( addressValidationRequest, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Validates the customer address supplied in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// 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. + /// + /// Properties of the address to validate. /// /// /// @@ -76,12 +53,12 @@ public virtual Mozu.Api.Contracts.Customer.AddressValidationResponse ValidateAdd /// var addressValidationResponse = await addressvalidationrequest.ValidateAddressAsync( addressValidationRequest, responseFields); /// /// - public virtual async Task ValidateAddressAsync(Mozu.Api.Contracts.Customer.AddressValidationRequest addressValidationRequest, string responseFields = null) + public virtual async Task ValidateAddressAsync(Mozu.Api.Contracts.Customer.AddressValidationRequest addressValidationRequest, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.AddressValidationRequestClient.ValidateAddressClient( addressValidationRequest, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Attributedefinition/AttributeResource.cs b/Mozu.Api/Resources/Commerce/Customer/Attributedefinition/AttributeResource.cs old mode 100644 new mode 100755 index 33bf7cf6..74ebae44 --- a/Mozu.Api/Resources/Commerce/Customer/Attributedefinition/AttributeResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Attributedefinition/AttributeResource.cs @@ -13,13 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Attributedefinition { /// - /// Attributes are used to add custom definitions and characteristics to the following objects: - - + /// Use the Customer Attribute Definition resource to manage the attributes to define for your shoppers. /// public partial class AttributeResource { /// @@ -39,42 +38,15 @@ public AttributeResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// var attributeCollection = attribute.GetAttributes( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttributes(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributesClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -84,108 +56,112 @@ public virtual Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttribu /// var attributeCollection = await attribute.GetAttributesAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAttributesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAttributesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributesClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } + /// - /// Retrieve a list of the vocabulary values defined for the customer attribute specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// List{} /// /// /// /// var attribute = new Attribute(); - /// var attributeVocabularyValue = attribute.GetAttributeVocabularyValues( attributeFQN); + /// var attributeVocabularyValue = await attribute.GetAttributeVocabularyValuesAsync( attributeFQN); /// /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAttributeVocabularyValues(string attributeFQN) + public virtual async Task> GetAttributeVocabularyValuesAsync(string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributeVocabularyValuesClient( attributeFQN); client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); } + /// - /// Retrieve a list of the vocabulary values defined for the customer attribute specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// + /// /// - /// List{} + /// /// /// /// /// var attribute = new Attribute(); - /// var attributeVocabularyValue = await attribute.GetAttributeVocabularyValuesAsync( attributeFQN); + /// var attribute = await attribute.GetAttributeAsync( attributeFQN, responseFields); /// /// - public virtual async Task> GetAttributeVocabularyValuesAsync(string attributeFQN) + public virtual async Task GetAttributeAsync(string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributeVocabularyValuesClient( attributeFQN); + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributeClient( attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } + /// - /// Retrieves the details of the specified product attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// /// /// /// var attribute = new Attribute(); - /// var attribute = attribute.GetAttribute( attributeFQN, responseFields); + /// var attribute = await attribute.CreateAttributeAsync( attribute, responseFields); /// /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.Extensible.Attribute GetAttribute(string attributeFQN, string responseFields = null) + public virtual async Task CreateAttributeAsync(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributeClient( attributeFQN, responseFields); + var client = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.CreateAttributeClient( attribute, responseFields); client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); } + /// - /// Retrieves the details of the specified product attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// /// /// /// var attribute = new Attribute(); - /// var attribute = await attribute.GetAttributeAsync( attributeFQN, responseFields); + /// var attribute = await attribute.UpdateAttributeAsync( attribute, attributeFQN, responseFields); /// /// - public virtual async Task GetAttributeAsync(string attributeFQN, string responseFields = null) + public virtual async Task UpdateAttributeAsync(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.GetAttributeClient( attributeFQN, responseFields); + var client = Mozu.Api.Clients.Commerce.Customer.Attributedefinition.AttributeClient.UpdateAttributeClient( attribute, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Customer/CreditResource.cs b/Mozu.Api/Resources/Commerce/Customer/CreditResource.cs old mode 100644 new mode 100755 index 73163668..752a13a4 --- a/Mozu.Api/Resources/Commerce/Customer/CreditResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/CreditResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer { @@ -37,42 +38,15 @@ public CreditResource CloneWithApiContext(Action contextModificatio } - /// - /// Retrieves a list of store credits applied to customer accounts, according any filter and sort criteria specified in the request. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var credit = new Credit(); - /// var creditCollection = credit.GetCredits( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Credit.CreditCollection GetCredits(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.GetCreditsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of store credits applied to customer accounts, according any filter and sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.Customer.Credit.CreditCollection GetCredits(in /// var creditCollection = await credit.GetCreditsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetCreditsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetCreditsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.GetCreditsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a store credit applied to a customer account. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var credit = new Credit(); - /// var credit = credit.GetCredit( code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Credit.Credit GetCredit(string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.GetCreditClient( code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a store credit applied to a customer account. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the store credit to retrieve. + /// /// /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.Customer.Credit.Credit GetCredit(string code, /// var credit = await credit.GetCreditAsync( code, responseFields); /// /// - public virtual async Task GetCreditAsync(string code, string responseFields = null) + public virtual async Task GetCreditAsync(string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.GetCreditClient( code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new store credit for the customer account specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of the store credit of gift card applied to a customer account. At this time, gift card functionality is reserved for future use. - /// - /// - /// - /// - /// - /// var credit = new Credit(); - /// var credit = credit.AddCredit( credit, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Credit.Credit AddCredit(Mozu.Api.Contracts.Customer.Credit.Credit credit, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.AddCreditClient( credit, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new store credit for the customer account specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the store credit of gift card applied to a customer account. At this time, gift card functionality is reserved for future use. + /// + /// Properties of the store credit to create. /// /// /// @@ -180,46 +106,22 @@ public virtual Mozu.Api.Contracts.Customer.Credit.Credit AddCredit(Mozu.Api.Cont /// var credit = await credit.AddCreditAsync( credit, responseFields); /// /// - public virtual async Task AddCreditAsync(Mozu.Api.Contracts.Customer.Credit.Credit credit, string responseFields = null) + public virtual async Task AddCreditAsync(Mozu.Api.Contracts.Customer.Credit.Credit credit, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.AddCreditClient( credit, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Associates an unclaimed customer credit with the shopper user authenticated in the request header. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var credit = new Credit(); - /// var credit = credit.AssociateCreditToShopper( code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Credit.Credit AssociateCreditToShopper(string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.AssociateCreditToShopperClient( code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Associates an unclaimed customer credit with the shopper user authenticated in the request header. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// The code that represents the credit to claim for the shopper. + /// /// /// /// @@ -229,43 +131,21 @@ public virtual Mozu.Api.Contracts.Customer.Credit.Credit AssociateCreditToShoppe /// var credit = await credit.AssociateCreditToShopperAsync( code, responseFields); /// /// - public virtual async Task AssociateCreditToShopperAsync(string code, string responseFields = null) + public virtual async Task AssociateCreditToShopperAsync(string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.AssociateCreditToShopperClient( code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Resend the notification email that informs a shopper that a credit has been created. - /// - /// User-defined code that uniqely identifies the channel group. - /// - /// - /// - /// - /// - /// var credit = new Credit(); - /// credit.ResendCreditCreatedEmail( code); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void ResendCreditCreatedEmail(string code) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.ResendCreditCreatedEmailClient( code); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Resend the notification email that informs a shopper that a credit has been created. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// /// /// /// @@ -275,47 +155,22 @@ public virtual void ResendCreditCreatedEmail(string code) /// await credit.ResendCreditCreatedEmailAsync( code); /// /// - public virtual async Task ResendCreditCreatedEmailAsync(string code) + public virtual async Task ResendCreditCreatedEmailAsync(string code, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.ResendCreditCreatedEmailClient( code); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates one or more properties of a defined store credit applied to a customer account. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of the store credit of gift card applied to a customer account. At this time, gift card functionality is reserved for future use. - /// - /// - /// - /// - /// - /// var credit = new Credit(); - /// var credit = credit.UpdateCredit( credit, code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Credit.Credit UpdateCredit(Mozu.Api.Contracts.Customer.Credit.Credit credit, string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.UpdateCreditClient( credit, code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a defined store credit applied to a customer account. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of the store credit of gift card applied to a customer account. At this time, gift card functionality is reserved for future use. + /// User-defined code of the store credit to update. + /// + /// Properties of the store credit to update. /// /// /// @@ -325,43 +180,21 @@ public virtual Mozu.Api.Contracts.Customer.Credit.Credit UpdateCredit(Mozu.Api.C /// var credit = await credit.UpdateCreditAsync( credit, code, responseFields); /// /// - public virtual async Task UpdateCreditAsync(Mozu.Api.Contracts.Customer.Credit.Credit credit, string code, string responseFields = null) + public virtual async Task UpdateCreditAsync(Mozu.Api.Contracts.Customer.Credit.Credit credit, string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.UpdateCreditClient( credit, code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a store credit previously applied to a customer account. - /// - /// User-defined code that uniqely identifies the channel group. - /// - /// - /// - /// - /// - /// var credit = new Credit(); - /// credit.DeleteCredit( code); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCredit(string code) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.DeleteCreditClient( code); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a store credit previously applied to a customer account. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// User-defined code of the store credit to delete. /// /// /// @@ -371,12 +204,12 @@ public virtual void DeleteCredit(string code) /// await credit.DeleteCreditAsync( code); /// /// - public virtual async Task DeleteCreditAsync(string code) + public virtual async Task DeleteCreditAsync(string code, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CreditClient.DeleteCreditClient( code); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Credits/CreditAuditEntryResource.cs b/Mozu.Api/Resources/Commerce/Customer/Credits/CreditAuditEntryResource.cs old mode 100644 new mode 100755 index bb1f9ff5..447cac2a --- a/Mozu.Api/Resources/Commerce/Customer/Credits/CreditAuditEntryResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Credits/CreditAuditEntryResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Credits { @@ -37,44 +38,16 @@ public CreditAuditEntryResource CloneWithApiContext(Action contextM } - /// - /// Retrieves the list of audit entries for the credit, according to any filter or sort criteria specified in the request. - /// - /// User-defined code that uniqely identifies the channel group. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var creditauditentry = new CreditAuditEntry(); - /// var creditAuditEntryCollection = creditauditentry.GetAuditEntries( code, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Credit.CreditAuditEntryCollection GetAuditEntries(string code, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Credits.CreditAuditEntryClient.GetAuditEntriesClient( code, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the list of audit entries for the credit, according to any filter or sort criteria specified in the request. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// User-defined code of the credit for which to retrieve audit entries. + /// + /// + /// + /// + /// /// /// /// @@ -84,12 +57,12 @@ public virtual Mozu.Api.Contracts.Customer.Credit.CreditAuditEntryCollection Get /// var creditAuditEntryCollection = await creditauditentry.GetAuditEntriesAsync( code, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAuditEntriesAsync(string code, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAuditEntriesAsync(string code, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Credits.CreditAuditEntryClient.GetAuditEntriesClient( code, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Customer/Credits/CreditTransactionResource.cs b/Mozu.Api/Resources/Commerce/Customer/Credits/CreditTransactionResource.cs old mode 100644 new mode 100755 index 7250ceff..e0b280fe --- a/Mozu.Api/Resources/Commerce/Customer/Credits/CreditTransactionResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/Credits/CreditTransactionResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer.Credits { @@ -37,44 +38,16 @@ public CreditTransactionResource CloneWithApiContext(Action context } - /// - /// Retrieves a list of the transactions performed using a customer credit that update the balance of the credit. - /// - /// User-defined code that uniqely identifies the channel group. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var credittransaction = new CreditTransaction(); - /// var creditTransactionCollection = credittransaction.GetTransactions( code, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Credit.CreditTransactionCollection GetTransactions(string code, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Credits.CreditTransactionClient.GetTransactionsClient( code, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the transactions performed using a customer credit that update the balance of the credit. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// User-defined code that identifies the customer credit. + /// + /// + /// + /// + /// /// /// /// @@ -84,48 +57,23 @@ public virtual Mozu.Api.Contracts.Customer.Credit.CreditTransactionCollection Ge /// var creditTransactionCollection = await credittransaction.GetTransactionsAsync( code, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetTransactionsAsync(string code, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetTransactionsAsync(string code, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Credits.CreditTransactionClient.GetTransactionsClient( code, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new transaction and updates the amount of a store credit or gift card. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of a transaction performed for a customer credit that update the remaining balance of the credit. - /// - /// - /// - /// - /// - /// var credittransaction = new CreditTransaction(); - /// var creditTransaction = credittransaction.AddTransaction( creditTransaction, code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Credit.CreditTransaction AddTransaction(Mozu.Api.Contracts.Customer.Credit.CreditTransaction creditTransaction, string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.Credits.CreditTransactionClient.AddTransactionClient( creditTransaction, code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new transaction and updates the amount of a store credit or gift card. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// Properties of a transaction performed for a customer credit that update the remaining balance of the credit. + /// User-defined code that identifies the customer credit to update. + /// + /// Properties of the transaction to create for the customer credit. /// /// /// @@ -135,12 +83,12 @@ public virtual Mozu.Api.Contracts.Customer.Credit.CreditTransaction AddTransacti /// var creditTransaction = await credittransaction.AddTransactionAsync( creditTransaction, code, responseFields); /// /// - public virtual async Task AddTransactionAsync(Mozu.Api.Contracts.Customer.Credit.CreditTransaction creditTransaction, string code, string responseFields = null) + public virtual async Task AddTransactionAsync(Mozu.Api.Contracts.Customer.Credit.CreditTransaction creditTransaction, string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.Credits.CreditTransactionClient.AddTransactionClient( creditTransaction, code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Customer/CustomerAccountResource.cs b/Mozu.Api/Resources/Commerce/Customer/CustomerAccountResource.cs old mode 100644 new mode 100755 index 0738a7ca..b3a66f95 --- a/Mozu.Api/Resources/Commerce/Customer/CustomerAccountResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/CustomerAccountResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer { @@ -37,48 +38,17 @@ public CustomerAccountResource CloneWithApiContext(Action contextMo } - /// - /// Retrieves a list of customer accounts. - /// - /// The fields to include in the response. - /// 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" - /// If true, retrieve anonymous shopper accounts in the response. - /// - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. - /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var customerAccountCollection = customeraccount.GetAccounts( startIndex, pageSize, sortBy, filter, fields, q, qLimit, isAnonymous, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAccountCollection GetAccounts(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string fields = null, string q = null, int? qLimit = null, bool? isAnonymous = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetAccountsClient( startIndex, pageSize, sortBy, filter, fields, q, qLimit, isAnonymous, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of customer accounts. + /// /// /// The fields to include in the response. - /// 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" + /// /// If true, retrieve anonymous shopper accounts in the response. /// - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// A list of customer account search terms to use in the query when searching across customer name and email. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -90,46 +60,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAccountCollection GetAccounts /// var customerAccountCollection = await customeraccount.GetAccountsAsync( startIndex, pageSize, sortBy, filter, fields, q, qLimit, isAnonymous, responseFields); /// /// - public virtual async Task GetAccountsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string fields = null, string q = null, int? qLimit = null, bool? isAnonymous = null, string responseFields = null) + public virtual async Task GetAccountsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string fields = null, string q = null, int? qLimit = null, bool? isAnonymous = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetAccountsClient( startIndex, pageSize, sortBy, filter, fields, q, qLimit, isAnonymous, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the current login state of the customer account specified in the request. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var loginState = customeraccount.GetLoginState( accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.LoginState GetLoginState(int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetLoginStateClient( accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the current login state of the customer account specified in the request. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -139,46 +85,22 @@ public virtual Mozu.Api.Contracts.Customer.LoginState GetLoginState(int accountI /// var loginState = await customeraccount.GetLoginStateAsync( accountId, responseFields); /// /// - public virtual async Task GetLoginStateAsync(int accountId, string responseFields = null) + public virtual async Task GetLoginStateAsync(int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetLoginStateClient( accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieve details of a customer account. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var customerAccount = customeraccount.GetAccount( accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAccount GetAccount(int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetAccountClient( accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve details of a customer account. + /// /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account to retrieve. + /// /// /// /// @@ -188,46 +110,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAccount GetAccount(int accoun /// var customerAccount = await customeraccount.GetAccountAsync( accountId, responseFields); /// /// - public virtual async Task GetAccountAsync(int accountId, string responseFields = null) + public virtual async Task GetAccountAsync(int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetAccountClient( accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new customer account based on the information specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of the customer account. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var customerAccount = customeraccount.AddAccount( account, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAccount AddAccount(Mozu.Api.Contracts.Customer.CustomerAccount account, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.AddAccountClient( account, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new customer account based on the information specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the customer account. + /// + /// Properties of the customer account to update. /// /// /// @@ -237,47 +135,23 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAccount AddAccount(Mozu.Api.C /// var customerAccount = await customeraccount.AddAccountAsync( account, responseFields); /// /// - public virtual async Task AddAccountAsync(Mozu.Api.Contracts.Customer.CustomerAccount account, string responseFields = null) + public virtual async Task AddAccountAsync(Mozu.Api.Contracts.Customer.CustomerAccount account, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.AddAccountClient( account, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Modifies the password associated with a customer account. - /// - /// Unique identifier of the customer account. - /// Specifies whether to unlock the specified customer account. - /// The information required to modify a shopper account password. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// customeraccount.ChangePassword( passwordInfo, accountId, unlockAccount); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void ChangePassword(Mozu.Api.Contracts.Customer.PasswordInfo passwordInfo, int accountId, bool? unlockAccount = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.ChangePasswordClient( passwordInfo, accountId, unlockAccount); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Modifies the password associated with a customer account. + /// /// - /// Unique identifier of the customer account. - /// Specifies whether to unlock the specified customer account. - /// The information required to modify a shopper account password. + /// The customer account information required to change the userpassword. + /// + /// The password information required to change the user password. /// /// /// @@ -287,47 +161,22 @@ public virtual void ChangePassword(Mozu.Api.Contracts.Customer.PasswordInfo pass /// await customeraccount.ChangePasswordAsync( passwordInfo, accountId, unlockAccount); /// /// - public virtual async Task ChangePasswordAsync(Mozu.Api.Contracts.Customer.PasswordInfo passwordInfo, int accountId, bool? unlockAccount = null) + public virtual async Task ChangePasswordAsync(Mozu.Api.Contracts.Customer.PasswordInfo passwordInfo, int accountId, bool? unlockAccount = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.ChangePasswordClient( passwordInfo, accountId, unlockAccount); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Adds a new user login to a defined customer account. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// The login information for a customer account. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var customerAuthTicket = customeraccount.AddLoginToExistingCustomer( customerAuthInfo, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket AddLoginToExistingCustomer(Mozu.Api.Contracts.Customer.CustomerLoginInfo customerAuthInfo, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.AddLoginToExistingCustomerClient( customerAuthInfo, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a new user login to a defined customer account. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// The login information for a customer account. + /// + /// The authentication information for the customer account. /// /// /// @@ -337,43 +186,21 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket AddLoginToExisting /// var customerAuthTicket = await customeraccount.AddLoginToExistingCustomerAsync( customerAuthInfo, accountId, responseFields); /// /// - public virtual async Task AddLoginToExistingCustomerAsync(Mozu.Api.Contracts.Customer.CustomerLoginInfo customerAuthInfo, int accountId, string responseFields = null) + public virtual async Task AddLoginToExistingCustomerAsync(Mozu.Api.Contracts.Customer.CustomerLoginInfo customerAuthInfo, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.AddLoginToExistingCustomerClient( customerAuthInfo, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the customer lifetime value of the specified customer account in the event of an order import or a lifetime value calculation error. - /// - /// Unique identifier of the customer account. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// customeraccount.RecomputeCustomerLifetimeValue( accountId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void RecomputeCustomerLifetimeValue(int accountId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.RecomputeCustomerLifetimeValueClient( accountId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Updates the customer lifetime value of the specified customer account in the event of an order import or a lifetime value calculation error. + /// /// - /// Unique identifier of the customer account. + /// The unique identifier of the customer account for which to calculate customer lifetime value. /// /// /// @@ -383,43 +210,20 @@ public virtual void RecomputeCustomerLifetimeValue(int accountId) /// await customeraccount.RecomputeCustomerLifetimeValueAsync( accountId); /// /// - public virtual async Task RecomputeCustomerLifetimeValueAsync(int accountId) + public virtual async Task RecomputeCustomerLifetimeValueAsync(int accountId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.RecomputeCustomerLifetimeValueClient( accountId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Lock or unlock a customer account. - /// - /// Unique identifier of the customer account. - /// If true, the customer account is locked from logging in. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// customeraccount.SetLoginLocked( isLocked, accountId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void SetLoginLocked(bool isLocked, int accountId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.SetLoginLockedClient( isLocked, accountId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Lock or unlock a customer account. + /// /// - /// Unique identifier of the customer account. + /// The unique identifier of the customer account. /// If true, the customer account is locked from logging in. /// /// @@ -430,41 +234,18 @@ public virtual void SetLoginLocked(bool isLocked, int accountId) /// await customeraccount.SetLoginLockedAsync( isLocked, accountId); /// /// - public virtual async Task SetLoginLockedAsync(bool isLocked, int accountId) + public virtual async Task SetLoginLockedAsync(bool isLocked, int accountId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.SetLoginLockedClient( isLocked, accountId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Requires the password for the customer account to be changed. - /// - /// Unique identifier of the customer account. - /// If true, the password for the customer account must be changed. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// customeraccount.SetPasswordChangeRequired( isPasswordChangeRequired, accountId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void SetPasswordChangeRequired(bool isPasswordChangeRequired, int accountId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.SetPasswordChangeRequiredClient( isPasswordChangeRequired, accountId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Requires the password for the customer account to be changed. + /// /// /// Unique identifier of the customer account. /// If true, the password for the customer account must be changed. @@ -477,45 +258,21 @@ public virtual void SetPasswordChangeRequired(bool isPasswordChangeRequired, int /// await customeraccount.SetPasswordChangeRequiredAsync( isPasswordChangeRequired, accountId); /// /// - public virtual async Task SetPasswordChangeRequiredAsync(bool isPasswordChangeRequired, int accountId) + public virtual async Task SetPasswordChangeRequiredAsync(bool isPasswordChangeRequired, int accountId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.SetPasswordChangeRequiredClient( isPasswordChangeRequired, accountId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Creates a new customer account and logs the user associated with the customer account into the site. - /// - /// Use this field to include those fields which are not included by default. - /// The authentication information associated with a customer account. The data includes the account properties such as the name, username, authorization access, and email address, the required password to match, and indicates if the account was imported from a third party resource. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var customerAuthTicket = customeraccount.AddAccountAndLogin( accountAndAuthInfo, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket AddAccountAndLogin(Mozu.Api.Contracts.Customer.CustomerAccountAndAuthInfo accountAndAuthInfo, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.AddAccountAndLoginClient( accountAndAuthInfo, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new customer account and logs the user associated with the customer account into the site. + /// /// - /// Use this field to include those fields which are not included by default. - /// The authentication information associated with a customer account. The data includes the account properties such as the name, username, authorization access, and email address, the required password to match, and indicates if the account was imported from a third party resource. + /// + /// Properties of the customer account to create, including the user authentication information. /// /// /// @@ -525,46 +282,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket AddAccountAndLogin /// var customerAuthTicket = await customeraccount.AddAccountAndLoginAsync( accountAndAuthInfo, responseFields); /// /// - public virtual async Task AddAccountAndLoginAsync(Mozu.Api.Contracts.Customer.CustomerAccountAndAuthInfo accountAndAuthInfo, string responseFields = null) + public virtual async Task AddAccountAndLoginAsync(Mozu.Api.Contracts.Customer.CustomerAccountAndAuthInfo accountAndAuthInfo, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.AddAccountAndLoginClient( accountAndAuthInfo, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates multiple customer accounts based on the information specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// The authentication information associated with a customer account. The data includes the account properties such as the name, username, authorization access, and email address, the required password to match, and indicates if the account was imported from a third party resource. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var customerAccountCollection = customeraccount.AddAccounts( customers, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAccountCollection AddAccounts(List customers, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.AddAccountsClient( customers, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates multiple customer accounts based on the information specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// The authentication information associated with a customer account. The data includes the account properties such as the name, username, authorization access, and email address, the required password to match, and indicates if the account was imported from a third party resource. + /// + /// Properties of the customer accounts to create. /// /// /// @@ -574,46 +307,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAccountCollection AddAccounts /// var customerAccountCollection = await customeraccount.AddAccountsAsync( customers, responseFields); /// /// - public virtual async Task AddAccountsAsync(List customers, string responseFields = null) + public virtual async Task AddAccountsAsync(List customers, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.AddAccountsClient( customers, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Changes a collection of customer account passwords. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the changed customer account passwords. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var changePasswordResultCollection = customeraccount.ChangePasswords( accountPasswordInfos, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.ChangePasswordResultCollection ChangePasswords(Mozu.Api.Contracts.Customer.AccountPasswordInfoCollection accountPasswordInfos, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.ChangePasswordsClient( accountPasswordInfos, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Changes a collection of customer account passwords. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the changed customer account passwords. + /// + /// /// /// /// @@ -623,48 +332,23 @@ public virtual Mozu.Api.Contracts.Customer.ChangePasswordResultCollection Change /// var changePasswordResultCollection = await customeraccount.ChangePasswordsAsync( accountPasswordInfos, responseFields); /// /// - public virtual async Task ChangePasswordsAsync(Mozu.Api.Contracts.Customer.AccountPasswordInfoCollection accountPasswordInfos, string responseFields = null) + public virtual async Task ChangePasswordsAsync(Mozu.Api.Contracts.Customer.AccountPasswordInfoCollection accountPasswordInfos, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.ChangePasswordsClient( accountPasswordInfos, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the current login state of a customer account by providing the customer's email address. - /// - /// The unique idenfitier of the customer set. - /// The email address associated with the customer account. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var loginState = customeraccount.GetLoginStateByEmailAddress( emailAddress, customerSetCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.LoginState GetLoginStateByEmailAddress(string emailAddress, string customerSetCode = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetLoginStateByEmailAddressClient( emailAddress, customerSetCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the current login state of a customer account by providing the customer's email address. + /// /// - /// The unique idenfitier of the customer set. + /// /// The email address associated with the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -674,47 +358,22 @@ public virtual Mozu.Api.Contracts.Customer.LoginState GetLoginStateByEmailAddres /// var loginState = await customeraccount.GetLoginStateByEmailAddressAsync( emailAddress, customerSetCode, responseFields); /// /// - public virtual async Task GetLoginStateByEmailAddressAsync(string emailAddress, string customerSetCode = null, string responseFields = null) + public virtual async Task GetLoginStateByEmailAddressAsync(string emailAddress, string customerSetCode = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetLoginStateByEmailAddressClient( emailAddress, customerSetCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the current login state of a customer account by providing the user name associated with the customer account. - /// - /// The unique idenfitier of the customer set. - /// Use this field to include those fields which are not included by default. - /// The user name associated with the customer account. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var loginState = customeraccount.GetLoginStateByUserName( userName, customerSetCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.LoginState GetLoginStateByUserName(string userName, string customerSetCode = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetLoginStateByUserNameClient( userName, customerSetCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the current login state of a customer account by providing the user name associated with the customer account. + /// /// - /// The unique idenfitier of the customer set. - /// Use this field to include those fields which are not included by default. + /// + /// /// The user name associated with the customer account. /// /// @@ -725,50 +384,24 @@ public virtual Mozu.Api.Contracts.Customer.LoginState GetLoginStateByUserName(st /// var loginState = await customeraccount.GetLoginStateByUserNameAsync( userName, customerSetCode, responseFields); /// /// - public virtual async Task GetLoginStateByUserNameAsync(string userName, string customerSetCode = null, string responseFields = null) + public virtual async Task GetLoginStateByUserNameAsync(string userName, string customerSetCode = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetLoginStateByUserNameClient( userName, customerSetCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of customer purchase order accounts according to according to any specified sort options. - /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var customerPurchaseOrderAccountCollection = customeraccount.GetCustomersPurchaseOrderAccounts( startIndex, pageSize, sortBy, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccountCollection GetCustomersPurchaseOrderAccounts(int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetCustomersPurchaseOrderAccountsClient( startIndex, pageSize, sortBy, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of customer purchase order accounts according to according to any specified sort options. + /// /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// /// /// /// @@ -778,41 +411,19 @@ public virtual Mozu.Api.Contracts.Customer.CustomerPurchaseOrderAccountCollectio /// var customerPurchaseOrderAccountCollection = await customeraccount.GetCustomersPurchaseOrderAccountsAsync( startIndex, pageSize, sortBy, responseFields); /// /// - public virtual async Task GetCustomersPurchaseOrderAccountsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null) + public virtual async Task GetCustomersPurchaseOrderAccountsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.GetCustomersPurchaseOrderAccountsClient( startIndex, pageSize, sortBy, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Resets the password for a customer account. - /// - /// Information required to reset the password for a customer account. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// customeraccount.ResetPassword( resetPasswordInfo); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void ResetPassword(Mozu.Api.Contracts.Customer.ResetPasswordInfo resetPasswordInfo) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.ResetPasswordClient( resetPasswordInfo); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Resets the password for a customer account. + /// /// /// Information required to reset the password for a customer account. /// @@ -824,47 +435,22 @@ public virtual void ResetPassword(Mozu.Api.Contracts.Customer.ResetPasswordInfo /// await customeraccount.ResetPasswordAsync( resetPasswordInfo); /// /// - public virtual async Task ResetPasswordAsync(Mozu.Api.Contracts.Customer.ResetPasswordInfo resetPasswordInfo) + public virtual async Task ResetPasswordAsync(Mozu.Api.Contracts.Customer.ResetPasswordInfo resetPasswordInfo, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.ResetPasswordClient( resetPasswordInfo); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates a customer account. - /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of the customer account. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// var customerAccount = customeraccount.UpdateAccount( account, accountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAccount UpdateAccount(Mozu.Api.Contracts.Customer.CustomerAccount account, int accountId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.UpdateAccountClient( account, accountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a customer account. + /// /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. - /// Properties of the customer account. + /// + /// Properties of the customer account to update. /// /// /// @@ -874,43 +460,21 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAccount UpdateAccount(Mozu.Ap /// var customerAccount = await customeraccount.UpdateAccountAsync( account, accountId, responseFields); /// /// - public virtual async Task UpdateAccountAsync(Mozu.Api.Contracts.Customer.CustomerAccount account, int accountId, string responseFields = null) + public virtual async Task UpdateAccountAsync(Mozu.Api.Contracts.Customer.CustomerAccount account, int accountId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.UpdateAccountClient( account, accountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a customer account. A customer account cannot be deleted if any orders exist, past or present. - /// - /// Unique identifier of the customer account. - /// - /// - /// - /// - /// - /// var customeraccount = new CustomerAccount(); - /// customeraccount.DeleteAccount( accountId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteAccount(int accountId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.DeleteAccountClient( accountId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a customer account. A customer account cannot be deleted if any orders exist, past or present. + /// /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account to delete. /// /// /// @@ -920,12 +484,12 @@ public virtual void DeleteAccount(int accountId) /// await customeraccount.DeleteAccountAsync( accountId); /// /// - public virtual async Task DeleteAccountAsync(int accountId) + public virtual async Task DeleteAccountAsync(int accountId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAccountClient.DeleteAccountClient( accountId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Customer/CustomerAuthTicketResource.cs b/Mozu.Api/Resources/Commerce/Customer/CustomerAuthTicketResource.cs old mode 100644 new mode 100755 index cf23ca20..b4ddc728 --- a/Mozu.Api/Resources/Commerce/Customer/CustomerAuthTicketResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/CustomerAuthTicketResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer { @@ -37,34 +38,11 @@ public CustomerAuthTicketResource CloneWithApiContext(Action contex } - /// - /// Creates an authentication ticket for an anonymous shopper user. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var customerauthticket = new CustomerAuthTicket(); - /// var customerAuthTicket = customerauthticket.CreateAnonymousShopperAuthTicket( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket CreateAnonymousShopperAuthTicket(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAuthTicketClient.CreateAnonymousShopperAuthTicketClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates an authentication ticket for an anonymous shopper user. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -74,46 +52,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket CreateAnonymousSho /// var customerAuthTicket = await customerauthticket.CreateAnonymousShopperAuthTicketAsync( responseFields); /// /// - public virtual async Task CreateAnonymousShopperAuthTicketAsync(string responseFields = null) + public virtual async Task CreateAnonymousShopperAuthTicketAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAuthTicketClient.CreateAnonymousShopperAuthTicketClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Generates a new authentication ticket for a customer account. - /// - /// Use this field to include those fields which are not included by default. - /// The authentication information required to generate an authentication ticket for a customer account. - /// - /// - /// - /// - /// - /// var customerauthticket = new CustomerAuthTicket(); - /// var customerAuthTicket = customerauthticket.CreateUserAuthTicket( userAuthInfo, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket CreateUserAuthTicket(Mozu.Api.Contracts.Customer.CustomerUserAuthInfo userAuthInfo, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAuthTicketClient.CreateUserAuthTicketClient( userAuthInfo, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Generates a new authentication ticket for a customer account. + /// /// - /// Use this field to include those fields which are not included by default. - /// The authentication information required to generate an authentication ticket for a customer account. + /// + /// The authentication information required to generate an authetication ticket for a user, which consists of a user name and password. /// /// /// @@ -123,46 +77,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket CreateUserAuthTick /// var customerAuthTicket = await customerauthticket.CreateUserAuthTicketAsync( userAuthInfo, responseFields); /// /// - public virtual async Task CreateUserAuthTicketAsync(Mozu.Api.Contracts.Customer.CustomerUserAuthInfo userAuthInfo, string responseFields = null) + public virtual async Task CreateUserAuthTicketAsync(Mozu.Api.Contracts.Customer.CustomerUserAuthInfo userAuthInfo, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAuthTicketClient.CreateUserAuthTicketClient( userAuthInfo, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Refreshes an existing authentication ticket for a customer account by providing the refresh token string. - /// - /// 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. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var customerauthticket = new CustomerAuthTicket(); - /// var customerAuthTicket = customerauthticket.RefreshUserAuthTicket( refreshToken, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket RefreshUserAuthTicket(string refreshToken, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerAuthTicketClient.RefreshUserAuthTicketClient( refreshToken, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Refreshes an existing authentication ticket for a customer account by providing the refresh token string. + /// /// - /// 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. - /// Use this field to include those fields which are not included by default. + /// The refresh token string required to refresh a user's authentication ticket. + /// /// /// /// @@ -172,12 +102,12 @@ public virtual Mozu.Api.Contracts.Customer.CustomerAuthTicket RefreshUserAuthTic /// var customerAuthTicket = await customerauthticket.RefreshUserAuthTicketAsync( refreshToken, responseFields); /// /// - public virtual async Task RefreshUserAuthTicketAsync(string refreshToken, string responseFields = null) + public virtual async Task RefreshUserAuthTicketAsync(string refreshToken, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerAuthTicketClient.RefreshUserAuthTicketClient( refreshToken, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Customer/CustomerSegmentResource.cs b/Mozu.Api/Resources/Commerce/Customer/CustomerSegmentResource.cs old mode 100644 new mode 100755 index 4ca78b08..8e34754a --- a/Mozu.Api/Resources/Commerce/Customer/CustomerSegmentResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/CustomerSegmentResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer { @@ -37,42 +38,15 @@ public CustomerSegmentResource CloneWithApiContext(Action contextMo } - /// - /// Retrieves a list of defined customer segments according to any filter and sort criteria. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var customersegment = new CustomerSegment(); - /// var customerSegmentCollection = customersegment.GetSegments( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerSegmentCollection GetSegments(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.GetSegmentsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of defined customer segments according to any filter and sort criteria. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerSegmentCollection GetSegments /// var customerSegmentCollection = await customersegment.GetSegmentsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetSegmentsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetSegmentsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.GetSegmentsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the customer segment specified in the request. This operation does not return a list of the customer accounts associated with the segment. - /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var customersegment = new CustomerSegment(); - /// var customerSegment = customersegment.GetSegment( id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerSegment GetSegment(int id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.GetSegmentClient( id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the customer segment specified in the request. This operation does not return a list of the customer accounts associated with the segment. + /// /// /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerSegment GetSegment(int id, st /// var customerSegment = await customersegment.GetSegmentAsync( id, responseFields); /// /// - public virtual async Task GetSegmentAsync(int id, string responseFields = null) + public virtual async Task GetSegmentAsync(int id, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.GetSegmentClient( id, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new customer segments. New customer segments do not have any associated customer accounts. - /// - /// Use this field to include those fields which are not included by default. - /// The Customer Segment object includes properties of a defined customer segment used to group customer accounts. - /// - /// - /// - /// - /// - /// var customersegment = new CustomerSegment(); - /// var customerSegment = customersegment.AddSegment( segment, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerSegment AddSegment(Mozu.Api.Contracts.Customer.CustomerSegment segment, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.AddSegmentClient( segment, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new customer segments. New customer segments do not have any associated customer accounts. + /// /// - /// Use this field to include those fields which are not included by default. - /// The Customer Segment object includes properties of a defined customer segment used to group customer accounts. + /// + /// Properties of the customer segment to add. /// /// /// @@ -180,44 +106,21 @@ public virtual Mozu.Api.Contracts.Customer.CustomerSegment AddSegment(Mozu.Api.C /// var customerSegment = await customersegment.AddSegmentAsync( segment, responseFields); /// /// - public virtual async Task AddSegmentAsync(Mozu.Api.Contracts.Customer.CustomerSegment segment, string responseFields = null) + public virtual async Task AddSegmentAsync(Mozu.Api.Contracts.Customer.CustomerSegment segment, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.AddSegmentClient( segment, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds one or more customer accounts to a defined customer segment. - /// - /// Unique identifier of the customer segment to retrieve. - /// List of customer account IDs to add to the customer segment specified in the request. - /// - /// - /// - /// - /// - /// var customersegment = new CustomerSegment(); - /// customersegment.AddSegmentAccounts( accountIds, id); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void AddSegmentAccounts(List accountIds, int id) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.AddSegmentAccountsClient( accountIds, id); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Adds one or more customer accounts to a defined customer segment. + /// /// - /// Unique identifier of the customer segment to retrieve. + /// Unique identifier of the customer segment for which to add the associated customer accounts. /// List of customer account IDs to add to the customer segment specified in the request. /// /// @@ -228,47 +131,22 @@ public virtual void AddSegmentAccounts(List accountIds, int id) /// await customersegment.AddSegmentAccountsAsync( accountIds, id); /// /// - public virtual async Task AddSegmentAccountsAsync(List accountIds, int id) + public virtual async Task AddSegmentAccountsAsync(List accountIds, int id, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.AddSegmentAccountsClient( accountIds, id); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates the details of the customer segment specified in the request. - /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// The Customer Segment object includes properties of a defined customer segment used to group customer accounts. - /// - /// - /// - /// - /// - /// var customersegment = new CustomerSegment(); - /// var customerSegment = customersegment.UpdateSegment( segment, id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerSegment UpdateSegment(Mozu.Api.Contracts.Customer.CustomerSegment segment, int id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.UpdateSegmentClient( segment, id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of the customer segment specified in the request. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// The Customer Segment object includes properties of a defined customer segment used to group customer accounts. + /// Unique identifier of the customer segment. + /// + /// Properties of the customer segment to update. /// /// /// @@ -278,43 +156,21 @@ public virtual Mozu.Api.Contracts.Customer.CustomerSegment UpdateSegment(Mozu.Ap /// var customerSegment = await customersegment.UpdateSegmentAsync( segment, id, responseFields); /// /// - public virtual async Task UpdateSegmentAsync(Mozu.Api.Contracts.Customer.CustomerSegment segment, int id, string responseFields = null) + public virtual async Task UpdateSegmentAsync(Mozu.Api.Contracts.Customer.CustomerSegment segment, int id, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.UpdateSegmentClient( segment, id, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a customer segment specified by its unique identifier. Deleting a segment removes any customer account associations, but does not delete the customer account itself. - /// - /// Unique identifier of the customer segment to retrieve. - /// - /// - /// - /// - /// - /// var customersegment = new CustomerSegment(); - /// customersegment.DeleteSegment( id); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteSegment(int id) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.DeleteSegmentClient( id); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a customer segment specified by its unique identifier. Deleting a segment removes any customer account associations, but does not delete the customer account itself. + /// /// - /// Unique identifier of the customer segment to retrieve. + /// Unique identifier of the customer segment to delete. /// /// /// @@ -324,44 +180,21 @@ public virtual void DeleteSegment(int id) /// await customersegment.DeleteSegmentAsync( id); /// /// - public virtual async Task DeleteSegmentAsync(int id) + public virtual async Task DeleteSegmentAsync(int id, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.DeleteSegmentClient( id); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Removes single account from a segment. - /// - /// Unique identifier of the customer account. - /// Unique identifier of the customer segment to retrieve. - /// - /// - /// - /// - /// - /// var customersegment = new CustomerSegment(); - /// customersegment.RemoveSegmentAccount( id, accountId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void RemoveSegmentAccount(int id, int accountId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.RemoveSegmentAccountClient( id, accountId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes single account from a segment. + /// /// - /// Unique identifier of the customer account. - /// Unique identifier of the customer segment to retrieve. + /// + /// /// /// /// @@ -371,12 +204,12 @@ public virtual void RemoveSegmentAccount(int id, int accountId) /// await customersegment.RemoveSegmentAccountAsync( id, accountId); /// /// - public virtual async Task RemoveSegmentAccountAsync(int id, int accountId) + public virtual async Task RemoveSegmentAccountAsync(int id, int accountId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerSegmentClient.RemoveSegmentAccountClient( id, accountId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Customer/CustomerSetResource.cs b/Mozu.Api/Resources/Commerce/Customer/CustomerSetResource.cs old mode 100644 new mode 100755 index ae0eb5a9..3f24ec65 --- a/Mozu.Api/Resources/Commerce/Customer/CustomerSetResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/CustomerSetResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer { /// - /// Use the Customer Sets resource to manage your customer sets. You can use customer sets to control the specific sites your customers can access using the same login credentials, as well as what customer My Account information is shared between sites.Refer to [Customer Sets](../../../guides/settings/customer-sets.htm) in the Guides section for more information. + /// /// public partial class CustomerSetResource { /// @@ -37,40 +38,14 @@ public CustomerSetResource CloneWithApiContext(Action contextModifi } - /// - /// Retrieves a collection of customer sets according to any specified filter criteria. - /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var customerset = new CustomerSet(); - /// var customerSetCollection = customerset.GetCustomerSets( startIndex, pageSize, sortBy, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerSetCollection GetCustomerSets(int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerSetClient.GetCustomerSetsClient( startIndex, pageSize, sortBy, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of customer sets according to any specified filter criteria. + /// /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// /// /// /// @@ -80,46 +55,22 @@ public virtual Mozu.Api.Contracts.Customer.CustomerSetCollection GetCustomerSets /// var customerSetCollection = await customerset.GetCustomerSetsAsync( startIndex, pageSize, sortBy, responseFields); /// /// - public virtual async Task GetCustomerSetsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null) + public virtual async Task GetCustomerSetsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerSetClient.GetCustomerSetsClient( startIndex, pageSize, sortBy, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the specified customer set. - /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var customerset = new CustomerSet(); - /// var customerSet = customerset.GetCustomerSet( code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.CustomerSet GetCustomerSet(string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.CustomerSetClient.GetCustomerSetClient( code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified customer set. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -129,12 +80,12 @@ public virtual Mozu.Api.Contracts.Customer.CustomerSet GetCustomerSet(string cod /// var customerSet = await customerset.GetCustomerSetAsync( code, responseFields); /// /// - public virtual async Task GetCustomerSetAsync(string code, string responseFields = null) + public virtual async Task GetCustomerSetAsync(string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.CustomerSetClient.GetCustomerSetClient( code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Customer/VisitResource.cs b/Mozu.Api/Resources/Commerce/Customer/VisitResource.cs old mode 100644 new mode 100755 index 4bb9e3fa..26e0e987 --- a/Mozu.Api/Resources/Commerce/Customer/VisitResource.cs +++ b/Mozu.Api/Resources/Commerce/Customer/VisitResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Customer { @@ -37,42 +38,15 @@ public VisitResource CloneWithApiContext(Action contextModification } - /// - /// Retrieves a list of customer visits according to any filter or sort criteria specified in the request. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var visit = new Visit(); - /// var visitCollection = visit.GetVisits( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.VisitCollection GetVisits(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.VisitClient.GetVisitsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of customer visits according to any filter or sort criteria specified in the request. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.Customer.VisitCollection GetVisits(int? startI /// var visitCollection = await visit.GetVisitsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetVisitsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetVisitsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.VisitClient.GetVisitsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the customer visit specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the customer visit to update. - /// - /// - /// - /// - /// - /// var visit = new Visit(); - /// var visit = visit.GetVisit( visitId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Visit GetVisit(string visitId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.VisitClient.GetVisitClient( visitId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the customer visit specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the customer visit to update. + /// + /// Unique identifier of the customer visit to retrieve. /// /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.Customer.Visit GetVisit(string visitId, string /// var visit = await visit.GetVisitAsync( visitId, responseFields); /// /// - public virtual async Task GetVisitAsync(string visitId, string responseFields = null) + public virtual async Task GetVisitAsync(string visitId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.VisitClient.GetVisitClient( visitId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new visit for the customer account specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of a customer visit to one of a company's sites. - /// - /// - /// - /// - /// - /// var visit = new Visit(); - /// var visit = visit.AddVisit( visit, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Visit AddVisit(Mozu.Api.Contracts.Customer.Visit visit, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.VisitClient.AddVisitClient( visit, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new visit for the customer account specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a customer visit to one of a company's sites. + /// + /// Properties of the visit to add to the customer account. /// /// /// @@ -180,48 +106,23 @@ public virtual Mozu.Api.Contracts.Customer.Visit AddVisit(Mozu.Api.Contracts.Cus /// var visit = await visit.AddVisitAsync( visit, responseFields); /// /// - public virtual async Task AddVisitAsync(Mozu.Api.Contracts.Customer.Visit visit, string responseFields = null) + public virtual async Task AddVisitAsync(Mozu.Api.Contracts.Customer.Visit visit, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.VisitClient.AddVisitClient( visit, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of a defined customer visit. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the customer visit to update. - /// Properties of a customer visit to one of a company's sites. - /// - /// - /// - /// - /// - /// var visit = new Visit(); - /// var visit = visit.UpdateVisit( visit, visitId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.Visit UpdateVisit(Mozu.Api.Contracts.Customer.Visit visit, string visitId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Customer.VisitClient.UpdateVisitClient( visit, visitId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a defined customer visit. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// Unique identifier of the customer visit to update. - /// Properties of a customer visit to one of a company's sites. + /// Properties of the customer visit to update. /// /// /// @@ -231,12 +132,12 @@ public virtual Mozu.Api.Contracts.Customer.Visit UpdateVisit(Mozu.Api.Contracts. /// var visit = await visit.UpdateVisitAsync( visit, visitId, responseFields); /// /// - public virtual async Task UpdateVisitAsync(Mozu.Api.Contracts.Customer.Visit visit, string visitId, string responseFields = null) + public virtual async Task UpdateVisitAsync(Mozu.Api.Contracts.Customer.Visit visit, string visitId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Customer.VisitClient.UpdateVisitClient( visit, visitId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/InStockNotificationSubscriptionResource.cs b/Mozu.Api/Resources/Commerce/InStockNotificationSubscriptionResource.cs old mode 100644 new mode 100755 index 4417b945..b3b0cd55 --- a/Mozu.Api/Resources/Commerce/InStockNotificationSubscriptionResource.cs +++ b/Mozu.Api/Resources/Commerce/InStockNotificationSubscriptionResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce { @@ -37,42 +38,15 @@ public InStockNotificationSubscriptionResource CloneWithApiContext(Action - /// Retrieves a list of in-stock notification subscriptions. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var instocknotificationsubscription = new InStockNotificationSubscription(); - /// var inStockNotificationSubscriptionCollection = instocknotificationsubscription.GetInStockNotificationSubscriptions( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.InStockNotificationSubscriptionCollection GetInStockNotificationSubscriptions(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.InStockNotificationSubscriptionClient.GetInStockNotificationSubscriptionsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of in-stock notification subscriptions. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.Customer.InStockNotificationSubscriptionCollec /// var inStockNotificationSubscriptionCollection = await instocknotificationsubscription.GetInStockNotificationSubscriptionsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetInStockNotificationSubscriptionsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetInStockNotificationSubscriptionsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.InStockNotificationSubscriptionClient.GetInStockNotificationSubscriptionsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a subscription that sends a push notification when a product is available in a site's active stock. - /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var instocknotificationsubscription = new InStockNotificationSubscription(); - /// var inStockNotificationSubscription = instocknotificationsubscription.GetInStockNotificationSubscription( id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.InStockNotificationSubscription GetInStockNotificationSubscription(int id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.InStockNotificationSubscriptionClient.GetInStockNotificationSubscriptionClient( id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a subscription that sends a push notification when a product is available in a site's active stock. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the in-stock notification subscription to retrieve. + /// /// /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.Customer.InStockNotificationSubscription GetIn /// var inStockNotificationSubscription = await instocknotificationsubscription.GetInStockNotificationSubscriptionAsync( id, responseFields); /// /// - public virtual async Task GetInStockNotificationSubscriptionAsync(int id, string responseFields = null) + public virtual async Task GetInStockNotificationSubscriptionAsync(int id, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.InStockNotificationSubscriptionClient.GetInStockNotificationSubscriptionClient( id, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new subscription that notifies the customer when the product specified in the request is available in the active inventory of the defined location. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of a push notification to which the shopper subscribes. This notification sends the shopper an alert when a new product or a product previously out of stock becomes available in the specified location's active product inventory. - /// - /// - /// - /// - /// - /// var instocknotificationsubscription = new InStockNotificationSubscription(); - /// var inStockNotificationSubscription = instocknotificationsubscription.AddInStockNotificationSubscription( inStockNotificationSubscription, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Customer.InStockNotificationSubscription AddInStockNotificationSubscription(Mozu.Api.Contracts.Customer.InStockNotificationSubscription inStockNotificationSubscription, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.InStockNotificationSubscriptionClient.AddInStockNotificationSubscriptionClient( inStockNotificationSubscription, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new subscription that notifies the customer when the product specified in the request is available in the active inventory of the defined location. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a push notification to which the shopper subscribes. This notification sends the shopper an alert when a new product or a product previously out of stock becomes available in the specified location's active product inventory. + /// + /// Properties of a subscription that sends the customer a notification when a product is available in a site's active stock. /// /// /// @@ -180,43 +106,21 @@ public virtual Mozu.Api.Contracts.Customer.InStockNotificationSubscription AddIn /// var inStockNotificationSubscription = await instocknotificationsubscription.AddInStockNotificationSubscriptionAsync( inStockNotificationSubscription, responseFields); /// /// - public virtual async Task AddInStockNotificationSubscriptionAsync(Mozu.Api.Contracts.Customer.InStockNotificationSubscription inStockNotificationSubscription, string responseFields = null) + public virtual async Task AddInStockNotificationSubscriptionAsync(Mozu.Api.Contracts.Customer.InStockNotificationSubscription inStockNotificationSubscription, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.InStockNotificationSubscriptionClient.AddInStockNotificationSubscriptionClient( inStockNotificationSubscription, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a subscription for a customer in-stock notification. - /// - /// Unique identifier of the customer segment to retrieve. - /// - /// - /// - /// - /// - /// var instocknotificationsubscription = new InStockNotificationSubscription(); - /// instocknotificationsubscription.DeleteInStockNotificationSubscription( id); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteInStockNotificationSubscription(int id) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.InStockNotificationSubscriptionClient.DeleteInStockNotificationSubscriptionClient( id); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a subscription for a customer in-stock notification. + /// /// - /// Unique identifier of the customer segment to retrieve. + /// Unique identifier of the customer in-stock notification subscription to delete. /// /// /// @@ -226,12 +130,12 @@ public virtual void DeleteInStockNotificationSubscription(int id) /// await instocknotificationsubscription.DeleteInStockNotificationSubscriptionAsync( id); /// /// - public virtual async Task DeleteInStockNotificationSubscriptionAsync(int id) + public virtual async Task DeleteInStockNotificationSubscriptionAsync(int id, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.InStockNotificationSubscriptionClient.DeleteInStockNotificationSubscriptionClient( id); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/LocationResource.cs b/Mozu.Api/Resources/Commerce/LocationResource.cs old mode 100644 new mode 100755 index 92443e67..5d2dece5 --- a/Mozu.Api/Resources/Commerce/LocationResource.cs +++ b/Mozu.Api/Resources/Commerce/LocationResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce { /// - /// Use the Location resource to retrieve details about a location from a hosted storefront. + /// Use the Location resource to retrieve details about a location from a Mozu hosted storefront. /// public partial class LocationResource { /// @@ -37,259 +38,138 @@ public LocationResource CloneWithApiContext(Action contextModificat } - /// - /// Retrieves the details of the location specified in the request. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// var location = location.GetLocation( code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.Location GetLocation(string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetLocationClient( code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the location specified in the request. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// /// /// /// var location = new Location(); - /// var location = await location.GetLocationAsync( code, responseFields); + /// var location = await location.GetLocationAsync( locationCode, includeAttributeDefinition, responseFields); /// /// - public virtual async Task GetLocationAsync(string code, string responseFields = null) + public virtual async Task GetLocationAsync(string locationCode, bool? includeAttributeDefinition = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetLocationClient( code, responseFields); + var client = Mozu.Api.Clients.Commerce.LocationClient.GetLocationClient( locationCode, includeAttributeDefinition, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of the locations configured for a specified location usage type for the specified site, according to any defined filter or sort criteria. - /// - /// 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" - /// System-defined location usage type code, which is DS for direct ship, SP for in-store pickup, or storeFinder. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// var locationCollection = location.GetLocationsInUsageType( locationUsageType, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.LocationCollection GetLocationsInUsageType(string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetLocationsInUsageTypeClient( locationUsageType, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the locations configured for a specified location usage type for the specified site, according to any defined filter or sort criteria. + /// /// - /// 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" + /// + /// /// System-defined location usage type code, which is DS for direct ship, SP for in-store pickup, or storeFinder. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// /// /// /// /// /// /// var location = new Location(); - /// var locationCollection = await location.GetLocationsInUsageTypeAsync( locationUsageType, startIndex, pageSize, sortBy, filter, responseFields); + /// var locationCollection = await location.GetLocationsInUsageTypeAsync( locationUsageType, startIndex, pageSize, sortBy, filter, includeAttributeDefinition, responseFields); /// /// - public virtual async Task GetLocationsInUsageTypeAsync(string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetLocationsInUsageTypeAsync(string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeAttributeDefinition = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetLocationsInUsageTypeClient( locationUsageType, startIndex, pageSize, sortBy, filter, responseFields); + var client = Mozu.Api.Clients.Commerce.LocationClient.GetLocationsInUsageTypeClient( locationUsageType, startIndex, pageSize, sortBy, filter, includeAttributeDefinition, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the location configured for the direct shipping (DS) location usage type for the site specified in the request. This location acts as an origin address from which order packages will ship, as well as the location where product reservations are created when order items are submitted with the direct ship fulfillment type (DS). If the direct ship location usage type is not configured for this site, the operation returns an error. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// var location = location.GetDirectShipLocation( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.Location GetDirectShipLocation(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetDirectShipLocationClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the location configured for the direct shipping (DS) location usage type for the site specified in the request. This location acts as an origin address from which order packages will ship, as well as the location where product reservations are created when order items are submitted with the direct ship fulfillment type (DS). If the direct ship location usage type is not configured for this site, the operation returns an error. + /// /// - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// /// /// /// var location = new Location(); - /// var location = await location.GetDirectShipLocationAsync( responseFields); + /// var location = await location.GetDirectShipLocationAsync( includeAttributeDefinition, responseFields); /// /// - public virtual async Task GetDirectShipLocationAsync(string responseFields = null) + public virtual async Task GetDirectShipLocationAsync(bool? includeAttributeDefinition = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetDirectShipLocationClient( responseFields); + var client = Mozu.Api.Clients.Commerce.LocationClient.GetDirectShipLocationClient( includeAttributeDefinition, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the location configured for the in-store pickup (SP) location usage type for the site specified in the request. If the location is not associated with a location type configured for the in-store pickup location usage type (SP), the operation returns an error. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// var location = location.GetInStorePickupLocation( code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.Location GetInStorePickupLocation(string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationClient( code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the location configured for the in-store pickup (SP) location usage type for the site specified in the request. If the location is not associated with a location type configured for the in-store pickup location usage type (SP), the operation returns an error. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// /// /// /// var location = new Location(); - /// var location = await location.GetInStorePickupLocationAsync( code, responseFields); + /// var location = await location.GetInStorePickupLocationAsync( locationCode, includeAttributeDefinition, responseFields); /// /// - public virtual async Task GetInStorePickupLocationAsync(string code, string responseFields = null) + public virtual async Task GetInStorePickupLocationAsync(string locationCode, bool? includeAttributeDefinition = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationClient( code, responseFields); + var client = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationClient( locationCode, includeAttributeDefinition, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of locations valid for in-store pickup of an item in an order according to any filter and sort criteria. For example, an application could use this operation to provide a store finder feature based on the shopper's GPS coordinates. If the location types for the in-store pickup location usage type are not configured for the site, this operation returns an error. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var location = new Location(); - /// var locationCollection = location.GetInStorePickupLocations( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.LocationCollection GetInStorePickupLocations(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of locations valid for in-store pickup of an item in an order according to any filter and sort criteria. For example, an application could use this operation to provide a store finder feature based on the shopper's GPS coordinates. If the location types for the in-store pickup location usage type are not configured for the site, this operation returns an error. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// /// /// /// /// var location = new Location(); - /// var locationCollection = await location.GetInStorePickupLocationsAsync( startIndex, pageSize, sortBy, filter, responseFields); + /// var locationCollection = await location.GetInStorePickupLocationsAsync( startIndex, pageSize, sortBy, filter, includeAttributeDefinition, responseFields); /// /// - public virtual async Task GetInStorePickupLocationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetInStorePickupLocationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeAttributeDefinition = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationsClient( startIndex, pageSize, sortBy, filter, responseFields); + var client = Mozu.Api.Clients.Commerce.LocationClient.GetInStorePickupLocationsClient( startIndex, pageSize, sortBy, filter, includeAttributeDefinition, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/OrderResource.cs b/Mozu.Api/Resources/Commerce/OrderResource.cs old mode 100644 new mode 100755 index a67edab9..1ccf79c8 --- a/Mozu.Api/Resources/Commerce/OrderResource.cs +++ b/Mozu.Api/Resources/Commerce/OrderResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce { @@ -37,45 +38,17 @@ public OrderResource CloneWithApiContext(Action contextModification } - /// - /// Retrieves a list of orders according to any specified filter criteria and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. - /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// - /// - /// var order = new Order(); - /// var orderCollection = order.GetOrders( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderCollection GetOrders(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.GetOrdersClient( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of orders according to any specified filter criteria and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter an order's search results by any of its properties, including status, contact information, or total. 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=Status+eq+Submitted" + /// + /// Used to page results from a query. Indicates the maximum number of entities to return from a query. Default value: 20. Max value: 200. + /// A list of order search terms to use in the query when searching across order number and the name or email of the billing contact. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// + /// + /// The element to sort the results by and the order in which the results appear. Either ascending order (a-z) which accepts 'asc' or 'asc' or descending order (z-a) which accepts 'desc' or 'desc'. The sortBy parameter follows an available property. For examp /// /// /// @@ -83,47 +56,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderCollection GetOrde /// /// /// var order = new Order(); - /// var orderCollection = await order.GetOrdersAsync( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); + /// var orderCollection = await order.GetOrdersAsync( startIndex, pageSize, sortBy, filter, q, qLimit, includeBin, responseFields); /// /// - public virtual async Task GetOrdersAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null) + public virtual async Task GetOrdersAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, bool? includeBin = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.GetOrdersClient( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); + var client = Mozu.Api.Clients.Commerce.OrderClient.GetOrdersClient( startIndex, pageSize, sortBy, filter, q, qLimit, includeBin, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the actions available to perform for an order based on its current status. - /// - /// Unique identifier of the order. - /// - /// List{string} - /// - /// - /// - /// var order = new Order(); - /// var string = order.GetAvailableActions( orderId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAvailableActions(string orderId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.OrderClient.GetAvailableActionsClient( orderId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the actions available to perform for an order based on its current status. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the available order actions to get. /// /// List{string} /// @@ -133,44 +83,21 @@ public virtual List GetAvailableActions(string orderId) /// var string = await order.GetAvailableActionsAsync( orderId); /// /// - public virtual async Task> GetAvailableActionsAsync(string orderId) + public virtual async Task> GetAvailableActionsAsync(string orderId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.OrderClient.GetAvailableActionsClient( orderId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves an order for the purpose of splitting it into multiple taxable orders in order to fulfill the order in multiple locations. - /// - /// Unique identifier of the order. - /// - /// List{} - /// - /// - /// - /// var order = new Order(); - /// var taxableOrder = order.GetTaxableOrders( orderId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetTaxableOrders(string orderId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.OrderClient.GetTaxableOrdersClient( orderId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves an order for the purpose of splitting it into multiple taxable orders in order to fulfill the order in multiple locations. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order to retrieve. /// /// List{} /// @@ -180,97 +107,49 @@ public virtual async Task> GetAvailableActionsAsync(string orderId) /// var taxableOrder = await order.GetTaxableOrdersAsync( orderId); /// /// - public virtual async Task> GetTaxableOrdersAsync(string orderId) + public virtual async Task> GetTaxableOrdersAsync(string orderId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.OrderClient.GetTaxableOrdersClient( orderId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of an order specified by the order ID. - /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// var order = order.GetOrder( orderId, draft, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order GetOrder(string orderId, bool? draft = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.GetOrderClient( orderId, draft, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of an order specified by the order ID. + /// /// /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// + /// Unique identifier of the order details to get. + /// /// /// /// /// /// /// var order = new Order(); - /// var order = await order.GetOrderAsync( orderId, draft, responseFields); + /// var order = await order.GetOrderAsync( orderId, draft, includeBin, responseFields); /// /// - public virtual async Task GetOrderAsync(string orderId, bool? draft = null, string responseFields = null) + public virtual async Task GetOrderAsync(string orderId, bool? draft = null, bool? includeBin = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.GetOrderClient( orderId, draft, responseFields); + var client = Mozu.Api.Clients.Commerce.OrderClient.GetOrderClient( orderId, draft, includeBin, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new order from an existing cart when the customer chooses to proceed to checkout. - /// - /// Identifier of the cart to delete. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// var order = order.CreateOrderFromCart( cartId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrderFromCart(string cartId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.CreateOrderFromCartClient( cartId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new order from an existing cart when the customer chooses to proceed to checkout. + /// /// - /// Identifier of the cart to delete. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the cart. This is the original cart ID expressed as a GUID. + /// /// /// /// @@ -280,46 +159,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrderFromCa /// var order = await order.CreateOrderFromCartAsync( cartId, responseFields); /// /// - public virtual async Task CreateOrderFromCartAsync(string cartId, string responseFields = null) + public virtual async Task CreateOrderFromCartAsync(string cartId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.CreateOrderFromCartClient( cartId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new order for no-cart quick-ordering scenarios. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of an order, including its components. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// var order = order.CreateOrder( order, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrder(Mozu.Api.Contracts.CommerceRuntime.Orders.Order order, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.CreateOrderClient( order, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new order for no-cart quick-ordering scenarios. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of an order, including its components. + /// + /// Properties of the order to create and submit. /// /// /// @@ -329,47 +184,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrder(Mozu. /// var order = await order.CreateOrderAsync( order, responseFields); /// /// - public virtual async Task CreateOrderAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.Order order, string responseFields = null) + public virtual async Task CreateOrderAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.Order order, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.CreateOrderClient( order, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Perform the specified action for an order. The actions you can perform depend on the current status of the order. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// The action to perform for the order. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// var order = order.PerformOrderAction( action, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformOrderAction(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderAction action, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.PerformOrderActionClient( action, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Perform the specified action for an order. The actions you can perform depend on the current status of the order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// The action to perform for the order. /// /// @@ -380,50 +210,51 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformOrderActio /// var order = await order.PerformOrderActionAsync( action, orderId, responseFields); /// /// - public virtual async Task PerformOrderActionAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderAction action, string orderId, string responseFields = null) + public virtual async Task PerformOrderActionAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderAction action, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.PerformOrderActionClient( action, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } + /// - /// Processes a digital wallet (used to hold 3rd party payment and shipping information). + /// /// - /// The type of digital wallet to be processed. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the digitial wallet. + /// + /// + /// + /// /// /// /// /// /// /// var order = new Order(); - /// var order = order.ProcessDigitalWallet( digitalWallet, orderId, digitalWalletType, responseFields); + /// var order = await order.PriceOrderAsync( order, refreshShipping, couponCodeToApply, responseFields); /// /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ProcessDigitalWallet(Mozu.Api.Contracts.CommerceRuntime.Orders.DigitalWallet digitalWallet, string orderId, string digitalWalletType, string responseFields = null) + public virtual async Task PriceOrderAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.Order order, bool refreshShipping, string couponCodeToApply = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.ProcessDigitalWalletClient( digitalWallet, orderId, digitalWalletType, responseFields); + var client = Mozu.Api.Clients.Commerce.OrderClient.PriceOrderClient( order, refreshShipping, couponCodeToApply, responseFields); client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); } + /// - /// Processes a digital wallet (used to hold 3rd party payment and shipping information). + /// /// - /// The type of digital wallet to be processed. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the digitial wallet. + /// + /// + /// + /// /// /// /// @@ -433,54 +264,26 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ProcessDigitalWal /// var order = await order.ProcessDigitalWalletAsync( digitalWallet, orderId, digitalWalletType, responseFields); /// /// - public virtual async Task ProcessDigitalWalletAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.DigitalWallet digitalWallet, string orderId, string digitalWalletType, string responseFields = null) + public virtual async Task ProcessDigitalWalletAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.DigitalWallet digitalWallet, string orderId, string digitalWalletType, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.ProcessDigitalWalletClient( digitalWallet, orderId, digitalWalletType, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update the properties of a discount applied to an order. - /// - /// discountId parameter description DOCUMENT_HERE - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of all applied discounts for an associated cart, order, or product. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// var order = order.UpdateOrderDiscount( discount, orderId, discountId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrderDiscount(Mozu.Api.Contracts.CommerceRuntime.Discounts.AppliedDiscount discount, string orderId, int discountId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.UpdateOrderDiscountClient( discount, orderId, discountId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update the properties of a discount applied to an order. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of all applied discounts for an associated cart, order, or product. + /// Unique identifier of the discount. System-supplied and read only. + /// Unique identifier of the order discount. System-supplied and read only. + /// + /// Specifies whether to modify the discount by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Properties of the order discount to update. /// /// /// @@ -490,45 +293,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrderDiscou /// var order = await order.UpdateOrderDiscountAsync( discount, orderId, discountId, updateMode, version, responseFields); /// /// - public virtual async Task UpdateOrderDiscountAsync(Mozu.Api.Contracts.CommerceRuntime.Discounts.AppliedDiscount discount, string orderId, int discountId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task UpdateOrderDiscountAsync(Mozu.Api.Contracts.CommerceRuntime.Discounts.AppliedDiscount discount, string orderId, int discountId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.UpdateOrderDiscountClient( discount, orderId, discountId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the current draft version of the order, which also deletes any uncommitted changes made to the order in draft mode. - /// - /// Unique identifier of the order. - /// Determines whether or not to check versioning of items for concurrency purposes. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// order.DeleteOrderDraft( orderId, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteOrderDraft(string orderId, string version = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.DeleteOrderDraftClient( orderId, version); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the current draft version of the order, which also deletes any uncommitted changes made to the order in draft mode. + /// /// - /// Unique identifier of the order. - /// Determines whether or not to check versioning of items for concurrency purposes. + /// Unique identifier of the order associated with the draft to delete. + /// If applicable, the version of the order draft to delete. /// /// /// @@ -538,44 +318,21 @@ public virtual void DeleteOrderDraft(string orderId, string version = null) /// await order.DeleteOrderDraftAsync( orderId, version); /// /// - public virtual async Task DeleteOrderDraftAsync(string orderId, string version = null) + public virtual async Task DeleteOrderDraftAsync(string orderId, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.DeleteOrderDraftClient( orderId, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Triggers an order confirmation email to be resent. - /// - /// Unique identifier of the order. - /// The action to perform for the order. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// order.ResendOrderConfirmationEmail( action, orderId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void ResendOrderConfirmationEmail(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderAction action, string orderId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.ResendOrderConfirmationEmailClient( action, orderId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Triggers an order confirmation email to be resent. + /// /// - /// Unique identifier of the order. - /// The action to perform for the order. + /// + /// /// /// /// @@ -585,51 +342,24 @@ public virtual void ResendOrderConfirmationEmail(Mozu.Api.Contracts.CommerceRunt /// await order.ResendOrderConfirmationEmailAsync( action, orderId); /// /// - public virtual async Task ResendOrderConfirmationEmailAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderAction action, string orderId) + public virtual async Task ResendOrderConfirmationEmailAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderAction action, string orderId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.ResendOrderConfirmationEmailClient( action, orderId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Changes the price list associated with an order. The desired price list code should be specified in the ApiContext. - /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The unique price list code. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// var order = order.ChangeOrderPriceList( priceListCode, orderId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ChangeOrderPriceList(string priceListCode, string orderId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.ChangeOrderPriceListClient( priceListCode, orderId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Changes the price list associated with an order. The desired price list code should be specified in the ApiContext. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The unique price list code. + /// + /// + /// + /// + /// /// /// /// @@ -639,46 +369,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ChangeOrderPriceL /// var order = await order.ChangeOrderPriceListAsync( priceListCode, orderId, updateMode, version, responseFields); /// /// - public virtual async Task ChangeOrderPriceListAsync(string priceListCode, string orderId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task ChangeOrderPriceListAsync(string priceListCode, string orderId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.ChangeOrderPriceListClient( priceListCode, orderId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the user ID of the shopper who placed the order to the current user. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// var order = order.ChangeOrderUserId( orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ChangeOrderUserId(string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.ChangeOrderUserIdClient( orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the user ID of the shopper who placed the order to the current user. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -688,52 +394,25 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ChangeOrderUserId /// var order = await order.ChangeOrderUserIdAsync( orderId, responseFields); /// /// - public virtual async Task ChangeOrderUserIdAsync(string orderId, string responseFields = null) + public virtual async Task ChangeOrderUserIdAsync(string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.ChangeOrderUserIdClient( orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the specified order when additional order information, such as shipping or billing information, is modified during the checkout process. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of an order, including its components. - /// - /// - /// - /// - /// - /// var order = new Order(); - /// var order = order.UpdateOrder( order, orderId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrder(Mozu.Api.Contracts.CommerceRuntime.Orders.Order order, string orderId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.OrderClient.UpdateOrderClient( order, orderId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the specified order when additional order information, such as shipping or billing information, is modified during the checkout process. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order to update. + /// /// 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." - /// 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. - /// Properties of an order, including its components. + /// + /// The properties of the order to update. /// /// /// @@ -743,12 +422,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrder(Mozu. /// var order = await order.UpdateOrderAsync( order, orderId, updateMode, version, responseFields); /// /// - public virtual async Task UpdateOrderAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.Order order, string orderId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task UpdateOrderAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.Order order, string orderId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.OrderClient.UpdateOrderClient( order, orderId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/AdjustmentResource.cs b/Mozu.Api/Resources/Commerce/Orders/AdjustmentResource.cs old mode 100644 new mode 100755 index 4bc69579..32f7757c --- a/Mozu.Api/Resources/Commerce/Orders/AdjustmentResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/AdjustmentResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,41 +38,14 @@ public AdjustmentResource CloneWithApiContext(Action contextModific } - /// - /// Updates the order handling adjustment. - /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// - /// - /// - /// - /// - /// - /// var adjustment = new Adjustment(); - /// var order = adjustment.ApplyHandlingAdjustment( adjustment, orderId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyHandlingAdjustment(Mozu.Api.Contracts.CommerceRuntime.Commerce.Adjustment adjustment, string orderId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.ApplyHandlingAdjustmentClient( adjustment, orderId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the order handling adjustment. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// /// /// /// @@ -82,52 +56,25 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyHandlingAdju /// var order = await adjustment.ApplyHandlingAdjustmentAsync( adjustment, orderId, updateMode, version, responseFields); /// /// - public virtual async Task ApplyHandlingAdjustmentAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.Adjustment adjustment, string orderId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task ApplyHandlingAdjustmentAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.Adjustment adjustment, string orderId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.ApplyHandlingAdjustmentClient( adjustment, orderId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Applies a shipping adjustment to the specified order. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of an ad-hoc price adjustment for an order. - /// - /// - /// - /// - /// - /// var adjustment = new Adjustment(); - /// var order = adjustment.ApplyShippingAdjustment( adjustment, orderId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyShippingAdjustment(Mozu.Api.Contracts.CommerceRuntime.Commerce.Adjustment adjustment, string orderId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.ApplyShippingAdjustmentClient( adjustment, orderId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Applies a shipping adjustment to the specified order. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of an ad-hoc price adjustment for an order. + /// Unique identifier of the order associated with the shipping adjustment. + /// + /// Specifies whether to apply the shipping adjustment by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Properties of the shipping adjustment to apply to the order. /// /// /// @@ -137,52 +84,25 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyShippingAdju /// var order = await adjustment.ApplyShippingAdjustmentAsync( adjustment, orderId, updateMode, version, responseFields); /// /// - public virtual async Task ApplyShippingAdjustmentAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.Adjustment adjustment, string orderId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task ApplyShippingAdjustmentAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.Adjustment adjustment, string orderId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.ApplyShippingAdjustmentClient( adjustment, orderId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Applies a price adjustment to the specified order. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of an ad-hoc price adjustment for an order. - /// - /// - /// - /// - /// - /// var adjustment = new Adjustment(); - /// var order = adjustment.ApplyAdjustment( adjustment, orderId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyAdjustment(Mozu.Api.Contracts.CommerceRuntime.Commerce.Adjustment adjustment, string orderId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.ApplyAdjustmentClient( adjustment, orderId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Applies a price adjustment to the specified order. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of an ad-hoc price adjustment for an order. + /// Unique identifier of the order for which to apply the adjustment. + /// + /// Specifies whether to apply the adjustment by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Properties of the price adjustment to apply to the order. /// /// /// @@ -192,48 +112,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyAdjustment(M /// var order = await adjustment.ApplyAdjustmentAsync( adjustment, orderId, updateMode, version, responseFields); /// /// - public virtual async Task ApplyAdjustmentAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.Adjustment adjustment, string orderId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task ApplyAdjustmentAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.Adjustment adjustment, string orderId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.ApplyAdjustmentClient( adjustment, orderId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes an adjustment to the order handling fee. - /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// - /// - /// - /// - /// - /// var adjustment = new Adjustment(); - /// var order = adjustment.RemoveHandlingAdjustment( orderId, updateMode, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveHandlingAdjustment(string orderId, string updateMode = null, string version = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.RemoveHandlingAdjustmentClient( orderId, updateMode, version); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes an adjustment to the order handling fee. + /// /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// /// /// /// @@ -243,48 +138,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveHandlingAdj /// var order = await adjustment.RemoveHandlingAdjustmentAsync( orderId, updateMode, version); /// /// - public virtual async Task RemoveHandlingAdjustmentAsync(string orderId, string updateMode = null, string version = null) + public virtual async Task RemoveHandlingAdjustmentAsync(string orderId, string updateMode = null, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.RemoveHandlingAdjustmentClient( orderId, updateMode, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes a shipping adjustment previously applied to an order or draft. - /// - /// Unique identifier of the order. - /// 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." - /// 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. - /// - /// - /// - /// - /// - /// var adjustment = new Adjustment(); - /// var order = adjustment.RemoveShippingAdjustment( orderId, updateMode, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveShippingAdjustment(string orderId, string updateMode = null, string version = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.RemoveShippingAdjustmentClient( orderId, updateMode, version); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes a shipping adjustment previously applied to an order or draft. + /// /// - /// Unique identifier of the order. - /// 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." - /// 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. + /// Unique identifier of the order with the applied shipping adjustment. + /// Specifies whether to remove the shipping adjustment by updating the original order, updating the order in draft mode, or updating 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." + /// /// /// /// @@ -294,48 +164,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveShippingAdj /// var order = await adjustment.RemoveShippingAdjustmentAsync( orderId, updateMode, version); /// /// - public virtual async Task RemoveShippingAdjustmentAsync(string orderId, string updateMode = null, string version = null) + public virtual async Task RemoveShippingAdjustmentAsync(string orderId, string updateMode = null, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.RemoveShippingAdjustmentClient( orderId, updateMode, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes a price adjustment from the specified order. - /// - /// Unique identifier of the order. - /// 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." - /// 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. - /// - /// - /// - /// - /// - /// var adjustment = new Adjustment(); - /// var order = adjustment.RemoveAdjustment( orderId, updateMode, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveAdjustment(string orderId, string updateMode = null, string version = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.RemoveAdjustmentClient( orderId, updateMode, version); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes a price adjustment from the specified order. + /// /// - /// Unique identifier of the order. - /// 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." - /// 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. + /// Unique identifier of the order for which to delete the adjustment. + /// Specifies whether to remove the adjustment by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// /// @@ -345,12 +190,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveAdjustment( /// var order = await adjustment.RemoveAdjustmentAsync( orderId, updateMode, version); /// /// - public virtual async Task RemoveAdjustmentAsync(string orderId, string updateMode = null, string version = null) + public virtual async Task RemoveAdjustmentAsync(string orderId, string updateMode = null, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.AdjustmentClient.RemoveAdjustmentClient( orderId, updateMode, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/AppliedDiscountResource.cs b/Mozu.Api/Resources/Commerce/Orders/AppliedDiscountResource.cs old mode 100644 new mode 100755 index b2cf70de..0a7f7c7e --- a/Mozu.Api/Resources/Commerce/Orders/AppliedDiscountResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/AppliedDiscountResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,42 +38,15 @@ public AppliedDiscountResource CloneWithApiContext(Action contextMo } - /// - /// Apply a coupon to the order. - /// - /// Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// - /// - /// - /// - /// - /// var applieddiscount = new AppliedDiscount(); - /// var order = applieddiscount.ApplyCoupon( orderId, couponCode, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyCoupon(string orderId, string couponCode, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.AppliedDiscountClient.ApplyCouponClient( orderId, couponCode, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Apply a coupon to the order. + /// /// - /// Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// + /// Unique identifier of the order to associate the coupon. System-supplied and read-only. + /// + /// Specifies whether to apply the coupon by updating the original order, updating the order in draft mode, or updating 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." + /// /// /// /// @@ -82,50 +56,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ApplyCoupon(strin /// var order = await applieddiscount.ApplyCouponAsync( orderId, couponCode, updateMode, version, responseFields); /// /// - public virtual async Task ApplyCouponAsync(string orderId, string couponCode, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task ApplyCouponAsync(string orderId, string couponCode, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.AppliedDiscountClient.ApplyCouponClient( orderId, couponCode, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes a coupon previously applied to the order. - /// - /// Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// Unique identifier of the order. - /// 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." - /// 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. - /// - /// - /// - /// - /// - /// var applieddiscount = new AppliedDiscount(); - /// var order = applieddiscount.RemoveCoupon( orderId, couponCode, updateMode, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveCoupon(string orderId, string couponCode, string updateMode = null, string version = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.AppliedDiscountClient.RemoveCouponClient( orderId, couponCode, updateMode, version); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes a coupon previously applied to the order. + /// /// - /// Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// Unique identifier of the order. - /// 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." - /// 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. + /// + /// Unique identifier of the order with the coupon to remove. + /// Specifies whether to remove the coupon by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// /// @@ -135,48 +83,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveCoupon(stri /// var order = await applieddiscount.RemoveCouponAsync( orderId, couponCode, updateMode, version); /// /// - public virtual async Task RemoveCouponAsync(string orderId, string couponCode, string updateMode = null, string version = null) + public virtual async Task RemoveCouponAsync(string orderId, string couponCode, string updateMode = null, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.AppliedDiscountClient.RemoveCouponClient( orderId, couponCode, updateMode, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes all coupons previously applied to the order. - /// - /// Unique identifier of the order. - /// 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." - /// 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. - /// - /// - /// - /// - /// - /// var applieddiscount = new AppliedDiscount(); - /// var order = applieddiscount.RemoveCoupons( orderId, updateMode, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveCoupons(string orderId, string updateMode = null, string version = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.AppliedDiscountClient.RemoveCouponsClient( orderId, updateMode, version); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes all coupons previously applied to the order. + /// /// - /// Unique identifier of the order. - /// 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." - /// 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. + /// Unique identifier of the order with the coupons to remove. + /// Specifies whether to remove coupons by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// /// @@ -186,12 +109,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order RemoveCoupons(str /// var order = await applieddiscount.RemoveCouponsAsync( orderId, updateMode, version); /// /// - public virtual async Task RemoveCouponsAsync(string orderId, string updateMode = null, string version = null) + public virtual async Task RemoveCouponsAsync(string orderId, string updateMode = null, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.AppliedDiscountClient.RemoveCouponsClient( orderId, updateMode, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/Attributedefinition/AttributeResource.cs b/Mozu.Api/Resources/Commerce/Orders/Attributedefinition/AttributeResource.cs old mode 100644 new mode 100755 index 4493ae8a..33e309f8 --- a/Mozu.Api/Resources/Commerce/Orders/Attributedefinition/AttributeResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/Attributedefinition/AttributeResource.cs @@ -13,13 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders.Attributedefinition { /// - /// Attributes are used to add custom definitions and characteristics to the following objects: - - + /// Use the Order Attribute Definition resource to manage the attributes that uniquely describe orders, such as the associated shopping season or "How did you hear about us?". Merchants can display order attributes on the order summary, the order confirmation page, invoices, or packing slips. /// public partial class AttributeResource { /// @@ -39,42 +38,15 @@ public AttributeResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// var attributeCollection = attribute.GetAttributes( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttributes(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.GetAttributesClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a paged list of attributes according to any specified filter criteria and sort options. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// /// @@ -84,44 +56,21 @@ public virtual Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttribu /// var attributeCollection = await attribute.GetAttributesAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetAttributesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetAttributesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.GetAttributesClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieve a list of the vocabulary values defined for the customer attribute specified in the request. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// - /// List{} - /// - /// - /// - /// var attribute = new Attribute(); - /// var attributeVocabularyValue = attribute.GetAttributeVocabularyValues( attributeFQN); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAttributeVocabularyValues(string attributeFQN) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.GetAttributeVocabularyValuesClient( attributeFQN); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve a list of the vocabulary values defined for the customer attribute specified in the request. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// List{} /// @@ -131,46 +80,22 @@ public virtual Mozu.Api.Contracts.Core.Extensible.AttributeCollection GetAttribu /// var attributeVocabularyValue = await attribute.GetAttributeVocabularyValuesAsync( attributeFQN); /// /// - public virtual async Task> GetAttributeVocabularyValuesAsync(string attributeFQN) + public virtual async Task> GetAttributeVocabularyValuesAsync(string attributeFQN, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.GetAttributeVocabularyValuesClient( attributeFQN); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the specified product attribute. - /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// var attribute = attribute.GetAttribute( attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.Extensible.Attribute GetAttribute(string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.GetAttributeClient( attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified product attribute. + /// /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// @@ -180,46 +105,22 @@ public virtual Mozu.Api.Contracts.Core.Extensible.Attribute GetAttribute(string /// var attribute = await attribute.GetAttributeAsync( attributeFQN, responseFields); /// /// - public virtual async Task GetAttributeAsync(string attributeFQN, string responseFields = null) + public virtual async Task GetAttributeAsync(string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.GetAttributeClient( attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Create and save a new attribute. These attributes are used in products and product options. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an attribute used to describe customers or orders. - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// var attribute = attribute.CreateAttribute( attribute, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.Extensible.Attribute CreateAttribute(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.CreateAttributeClient( attribute, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Create and save a new attribute. These attributes are used in products and product options. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an attribute used to describe customers or orders. + /// + /// The properties of the order attribute to create. /// /// /// @@ -229,48 +130,23 @@ public virtual Mozu.Api.Contracts.Core.Extensible.Attribute CreateAttribute(Mozu /// var attribute = await attribute.CreateAttributeAsync( attribute, responseFields); /// /// - public virtual async Task CreateAttributeAsync(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null) + public virtual async Task CreateAttributeAsync(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.CreateAttributeClient( attribute, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates an existing attribute with attribute properties to set. - /// - /// Fully qualified name for an attribute. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an attribute used to describe customers or orders. - /// - /// - /// - /// - /// - /// var attribute = new Attribute(); - /// var attribute = attribute.UpdateAttribute( attribute, attributeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.Extensible.Attribute UpdateAttribute(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.UpdateAttributeClient( attribute, attributeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates an existing attribute with attribute properties to set. + /// /// - /// Fully qualified name for an attribute. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an attribute used to describe customers or orders. + /// + /// + /// The properties of the order attribute to update. /// /// /// @@ -280,12 +156,12 @@ public virtual Mozu.Api.Contracts.Core.Extensible.Attribute UpdateAttribute(Mozu /// var attribute = await attribute.UpdateAttributeAsync( attribute, attributeFQN, responseFields); /// /// - public virtual async Task UpdateAttributeAsync(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null) + public virtual async Task UpdateAttributeAsync(Mozu.Api.Contracts.Core.Extensible.Attribute attribute, string attributeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.Attributedefinition.AttributeClient.UpdateAttributeClient( attribute, attributeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/BillingInfoResource.cs b/Mozu.Api/Resources/Commerce/Orders/BillingInfoResource.cs old mode 100644 new mode 100755 index 621523fd..7c144747 --- a/Mozu.Api/Resources/Commerce/Orders/BillingInfoResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/BillingInfoResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,38 +38,13 @@ public BillingInfoResource CloneWithApiContext(Action contextModifi } - /// - /// Retrieves the billing information associated with an order. - /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var billinginfo = new BillingInfo(); - /// var billingInfo = billinginfo.GetBillingInfo( orderId, draft, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo GetBillingInfo(string orderId, bool? draft = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.BillingInfoClient.GetBillingInfoClient( orderId, draft, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the billing information associated with an order. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. + /// If true, retrieve the draft version of the order billing information, which might include uncommitted changes. /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -78,52 +54,25 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo GetBillin /// var billingInfo = await billinginfo.GetBillingInfoAsync( orderId, draft, responseFields); /// /// - public virtual async Task GetBillingInfoAsync(string orderId, bool? draft = null, string responseFields = null) + public virtual async Task GetBillingInfoAsync(string orderId, bool? draft = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.BillingInfoClient.GetBillingInfoClient( orderId, draft, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the billing information supplied for an order. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of the billing information entered for an order during checkout. - /// - /// - /// - /// - /// - /// var billinginfo = new BillingInfo(); - /// var billingInfo = billinginfo.SetBillingInfo( billingInfo, orderId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo SetBillingInfo(Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo billingInfo, string orderId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.BillingInfoClient.SetBillingInfoClient( billingInfo, orderId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the billing information supplied for an order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of the billing information entered for an order during checkout. + /// + /// Specifies whether to set the billing information by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// The properties of the order billing information to update. /// /// /// @@ -133,12 +82,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo SetBillin /// var billingInfo = await billinginfo.SetBillingInfoAsync( billingInfo, orderId, updateMode, version, responseFields); /// /// - public virtual async Task SetBillingInfoAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo billingInfo, string orderId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task SetBillingInfoAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.BillingInfo billingInfo, string orderId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.BillingInfoClient.SetBillingInfoClient( billingInfo, orderId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/DigitalPackageResource.cs b/Mozu.Api/Resources/Commerce/Orders/DigitalPackageResource.cs old mode 100644 new mode 100755 index 0a288cbe..c3528831 --- a/Mozu.Api/Resources/Commerce/Orders/DigitalPackageResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/DigitalPackageResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,36 +38,12 @@ public DigitalPackageResource CloneWithApiContext(Action contextMod } - /// - /// Retrieves a collection of fulfillment options for digital packages. Options may include emailed files/links or provided links. - /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// - /// List{string} - /// - /// - /// - /// var digitalpackage = new DigitalPackage(); - /// var string = digitalpackage.GetAvailableDigitalPackageFulfillmentActions( orderId, digitalPackageId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAvailableDigitalPackageFulfillmentActions(string orderId, string digitalPackageId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.GetAvailableDigitalPackageFulfillmentActionsClient( orderId, digitalPackageId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of fulfillment options for digital packages. Options may include emailed files/links or provided links. + /// /// /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. + /// This parameter provides the unique identifier of the order on which to get a list of available actions. /// /// List{string} /// @@ -76,48 +53,23 @@ public virtual List GetAvailableDigitalPackageFulfillmentActions(string /// var string = await digitalpackage.GetAvailableDigitalPackageFulfillmentActionsAsync( orderId, digitalPackageId); /// /// - public virtual async Task> GetAvailableDigitalPackageFulfillmentActionsAsync(string orderId, string digitalPackageId) + public virtual async Task> GetAvailableDigitalPackageFulfillmentActionsAsync(string orderId, string digitalPackageId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.GetAvailableDigitalPackageFulfillmentActionsClient( orderId, digitalPackageId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// This operation retreives a digital package within an order and it requires two parameters: orderId and digitalPackageId. - /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var digitalpackage = new DigitalPackage(); - /// var digitalPackage = digitalpackage.GetDigitalPackage( orderId, digitalPackageId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage GetDigitalPackage(string orderId, string digitalPackageId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.GetDigitalPackageClient( orderId, digitalPackageId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// This operation retreives a digital package within an order and it requires two parameters: orderId and digitalPackageId. + /// /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// This parameter provides the digital package Id. + /// This parameter provides the unique identifier of the order with which to associate the digital package. + /// /// /// /// @@ -127,48 +79,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage Get /// var digitalPackage = await digitalpackage.GetDigitalPackageAsync( orderId, digitalPackageId, responseFields); /// /// - public virtual async Task GetDigitalPackageAsync(string orderId, string digitalPackageId, string responseFields = null) + public virtual async Task GetDigitalPackageAsync(string orderId, string digitalPackageId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.GetDigitalPackageClient( orderId, digitalPackageId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Lets you apply a digital package to the order using the orderId and digitalPackage parameters. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Lets you manage an order's digital packages, by applying a digital package to the order. - /// - /// - /// - /// - /// - /// var digitalpackage = new DigitalPackage(); - /// var digitalPackage = digitalpackage.CreateDigitalPackage( digitalPackage, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage CreateDigitalPackage(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage digitalPackage, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.CreateDigitalPackageClient( digitalPackage, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Lets you apply a digital package to the order using the orderId and digitalPackage parameters. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Lets you manage an order's digital packages, by applying a digital package to the order. + /// The orderID is a required paramter for the digitalpackages operation. The orderId is a unique identifier of the order with which to associate the digital package. + /// + /// The digitalPackage parameter is a required parameter for the CreateDigitalPackages operation. The digitalPackage is the digital package to create and add to the order. /// /// /// @@ -178,50 +105,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage Cre /// var digitalPackage = await digitalpackage.CreateDigitalPackageAsync( digitalPackage, orderId, responseFields); /// /// - public virtual async Task CreateDigitalPackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage digitalPackage, string orderId, string responseFields = null) + public virtual async Task CreateDigitalPackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage digitalPackage, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.CreateDigitalPackageClient( digitalPackage, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// This method operates on one digital package, specified by the id given. This method ensures that the digital package ID provided is in the order with the id given, and then updates the properties of that package with the properties of the one passed in using the ‘digitalpackage’ parameter. - /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Lets you manage an order's digital packages, by applying a digital package to the order. - /// - /// - /// - /// - /// - /// var digitalpackage = new DigitalPackage(); - /// var digitalPackage = digitalpackage.UpdateDigitalPackage( digitalPackage, orderId, digitalPackageId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage UpdateDigitalPackage(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage digitalPackage, string orderId, string digitalPackageId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.UpdateDigitalPackageClient( digitalPackage, orderId, digitalPackageId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// This method operates on one digital package, specified by the id given. This method ensures that the digital package ID provided is in the order with the id given, and then updates the properties of that package with the properties of the one passed in using the ‘digitalpackage’ parameter. + /// /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Lets you manage an order's digital packages, by applying a digital package to the order. + /// This parameter specifies the digital package to update in the order. + /// This parameter provides the unique identifier of the order with which to associate the digital package. + /// + /// This parameter provides the package content to update in the order. /// /// /// @@ -231,45 +132,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage Upd /// var digitalPackage = await digitalpackage.UpdateDigitalPackageAsync( digitalPackage, orderId, digitalPackageId, responseFields); /// /// - public virtual async Task UpdateDigitalPackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage digitalPackage, string orderId, string digitalPackageId, string responseFields = null) + public virtual async Task UpdateDigitalPackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.DigitalPackage digitalPackage, string orderId, string digitalPackageId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.UpdateDigitalPackageClient( digitalPackage, orderId, digitalPackageId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// This operation deletes a digital package from an order. This operation requires three parameters: orderId, digitalPackageId, and digitalPackage. - /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// - /// - /// - /// - /// - /// var digitalpackage = new DigitalPackage(); - /// digitalpackage.DeleteDigitalPackage( orderId, digitalPackageId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDigitalPackage(string orderId, string digitalPackageId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.DeleteDigitalPackageClient( orderId, digitalPackageId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// This operation deletes a digital package from an order. This operation requires three parameters: orderId, digitalPackageId, and digitalPackage. + /// /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. + /// The digitalPackage ID is unique package ID to update on the order. + /// The orderId is unique identifier of the order with which to associate the package. /// /// /// @@ -279,12 +157,12 @@ public virtual void DeleteDigitalPackage(string orderId, string digitalPackageId /// await digitalpackage.DeleteDigitalPackageAsync( orderId, digitalPackageId); /// /// - public virtual async Task DeleteDigitalPackageAsync(string orderId, string digitalPackageId) + public virtual async Task DeleteDigitalPackageAsync(string orderId, string digitalPackageId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.DigitalPackageClient.DeleteDigitalPackageClient( orderId, digitalPackageId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Orders/ExtendedPropertyResource.cs b/Mozu.Api/Resources/Commerce/Orders/ExtendedPropertyResource.cs old mode 100644 new mode 100755 index 247ab410..174c80e7 --- a/Mozu.Api/Resources/Commerce/Orders/ExtendedPropertyResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/ExtendedPropertyResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { /// - /// Use the Extended Properties resource to store tracking strings for your orders. Extended properties can help you track affiliate sources. + /// /// public partial class ExtendedPropertyResource { /// @@ -37,36 +38,12 @@ public ExtendedPropertyResource CloneWithApiContext(Action contextM } - /// - /// Retrieves the extended property string associated with the order. - /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// - /// List{} - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// var extendedProperty = extendedproperty.GetExtendedProperties( orderId, draft); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetExtendedProperties(string orderId, bool? draft = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.GetExtendedPropertiesClient( orderId, draft); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the extended property string associated with the order. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. + /// + /// /// /// List{} /// @@ -76,50 +53,24 @@ public ExtendedPropertyResource CloneWithApiContext(Action contextM /// var extendedProperty = await extendedproperty.GetExtendedPropertiesAsync( orderId, draft); /// /// - public virtual async Task> GetExtendedPropertiesAsync(string orderId, bool? draft = null) + public virtual async Task> GetExtendedPropertiesAsync(string orderId, bool? draft = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.GetExtendedPropertiesClient( orderId, draft); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates an extended property for the order. - /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The details of the extended property. - /// - /// List{} - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// var extendedProperty = extendedproperty.AddExtendedProperties( extendedProperties, orderId, updateMode, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List AddExtendedProperties(List extendedProperties, string orderId, string updateMode = null, string version = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.AddExtendedPropertiesClient( extendedProperties, orderId, updateMode, version); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates an extended property for the order. + /// /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The details of the extended property. + /// + /// + /// + /// /// /// List{} /// @@ -129,56 +80,27 @@ public ExtendedPropertyResource CloneWithApiContext(Action contextM /// var extendedProperty = await extendedproperty.AddExtendedPropertiesAsync( extendedProperties, orderId, updateMode, version); /// /// - public virtual async Task> AddExtendedPropertiesAsync(List extendedProperties, string orderId, string updateMode = null, string version = null) + public virtual async Task> AddExtendedPropertiesAsync(List extendedProperties, string orderId, string updateMode = null, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.AddExtendedPropertiesClient( extendedProperties, orderId, updateMode, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one ore more extended properties. - /// - /// The extended property key. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Inserts and updates an extended property. - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The details of the updated extended property. - /// - /// - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// var extendedProperty = extendedproperty.UpdateExtendedProperty( extendedProperty, orderId, key, updateMode, version, upsert, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty UpdateExtendedProperty(Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty extendedProperty, string orderId, string key, string updateMode = null, string version = null, bool? upsert = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.UpdateExtendedPropertyClient( extendedProperty, orderId, key, updateMode, version, upsert, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one ore more extended properties. + /// /// - /// The extended property key. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Inserts and updates an extended property. - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The details of the updated extended property. + /// + /// + /// + /// + /// + /// + /// /// /// /// @@ -188,52 +110,25 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty Upda /// var extendedProperty = await extendedproperty.UpdateExtendedPropertyAsync( extendedProperty, orderId, key, updateMode, version, upsert, responseFields); /// /// - public virtual async Task UpdateExtendedPropertyAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty extendedProperty, string orderId, string key, string updateMode = null, string version = null, bool? upsert = null, string responseFields = null) + public virtual async Task UpdateExtendedPropertyAsync(Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty extendedProperty, string orderId, string key, string updateMode = null, string version = null, bool? upsert = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.UpdateExtendedPropertyClient( extendedProperty, orderId, key, updateMode, version, upsert, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more extended properties. - /// - /// Unique identifier of the order. - /// 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." - /// Inserts and updates the extended property. - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The details of the updated extended properties. - /// - /// List{} - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// var extendedProperty = extendedproperty.UpdateExtendedProperties( extendedProperties, orderId, updateMode, version, upsert); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateExtendedProperties(List extendedProperties, string orderId, string updateMode = null, string version = null, bool? upsert = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.UpdateExtendedPropertiesClient( extendedProperties, orderId, updateMode, version, upsert); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more extended properties. + /// /// - /// Unique identifier of the order. - /// 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." - /// Inserts and updates the extended property. - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The details of the updated extended properties. + /// + /// + /// + /// + /// /// /// List{} /// @@ -243,49 +138,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Commerce.ExtendedProperty Upda /// var extendedProperty = await extendedproperty.UpdateExtendedPropertiesAsync( extendedProperties, orderId, updateMode, version, upsert); /// /// - public virtual async Task> UpdateExtendedPropertiesAsync(List extendedProperties, string orderId, string updateMode = null, string version = null, bool? upsert = null) + public virtual async Task> UpdateExtendedPropertiesAsync(List extendedProperties, string orderId, string updateMode = null, string version = null, bool? upsert = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.UpdateExtendedPropertiesClient( extendedProperties, orderId, updateMode, version, upsert); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes one or more extended properties. - /// - /// The extended property key. - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// - /// - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// extendedproperty.DeleteExtendedProperty( orderId, key, updateMode, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteExtendedProperty(string orderId, string key, string updateMode = null, string version = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.DeleteExtendedPropertyClient( orderId, key, updateMode, version); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes one or more extended properties. + /// /// - /// The extended property key. - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// /// /// /// @@ -295,48 +165,23 @@ public virtual void DeleteExtendedProperty(string orderId, string key, string up /// await extendedproperty.DeleteExtendedPropertyAsync( orderId, key, updateMode, version); /// /// - public virtual async Task DeleteExtendedPropertyAsync(string orderId, string key, string updateMode = null, string version = null) + public virtual async Task DeleteExtendedPropertyAsync(string orderId, string key, string updateMode = null, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.DeleteExtendedPropertyClient( orderId, key, updateMode, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the extended property associated with the order. - /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The extended property keys. - /// - /// - /// - /// - /// - /// var extendedproperty = new ExtendedProperty(); - /// extendedproperty.DeleteExtendedProperties( keys, orderId, updateMode, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteExtendedProperties(List keys, string orderId, string updateMode = null, string version = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.DeleteExtendedPropertiesClient( keys, orderId, updateMode, version); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the extended property associated with the order. + /// /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// The extended property keys. + /// + /// + /// + /// /// /// /// @@ -346,12 +191,12 @@ public virtual void DeleteExtendedProperties(List keys, string orderId, /// await extendedproperty.DeleteExtendedPropertiesAsync( keys, orderId, updateMode, version); /// /// - public virtual async Task DeleteExtendedPropertiesAsync(List keys, string orderId, string updateMode = null, string version = null) + public virtual async Task DeleteExtendedPropertiesAsync(List keys, string orderId, string updateMode = null, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.ExtendedPropertyClient.DeleteExtendedPropertiesClient( keys, orderId, updateMode, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Orders/FulfillmentActionResource.cs b/Mozu.Api/Resources/Commerce/Orders/FulfillmentActionResource.cs old mode 100644 new mode 100755 index 03f56e9a..58ca9c5f --- a/Mozu.Api/Resources/Commerce/Orders/FulfillmentActionResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/FulfillmentActionResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,38 +38,13 @@ public FulfillmentActionResource CloneWithApiContext(Action context } - /// - /// Sets the fulfillment action to "Ship" or "PickUp". To ship an order or prepare it for in-store pickup, the order must have a customer name, the "Open" or "OpenAndProcessing" status. To ship the order, it must also have the full shipping address and shipping method. Shipping all packages or picking up all pickups for an order will complete a paid order. - /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an action to perform when fulfilling an item in an order, whether through in-store pickup or direct shipping. - /// - /// - /// - /// - /// - /// var fulfillmentaction = new FulfillmentAction(); - /// var order = fulfillmentaction.PerformFulfillmentAction( action, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformFulfillmentAction(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentAction action, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.FulfillmentActionClient.PerformFulfillmentActionClient( action, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Sets the fulfillment action to "Ship" or "PickUp". To ship an order or prepare it for in-store pickup, the order must have a customer name, the "Open" or "OpenAndProcessing" status. To ship the order, it must also have the full shipping address and shipping method. Shipping all packages or picking up all pickups for an order will complete a paid order. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an action to perform when fulfilling an item in an order, whether through in-store pickup or direct shipping. + /// Unique identifier of the order for which to perform the fulfillment action. + /// Updated order with a new fulfillment status resulting from the action supplied in the request. + /// The action to perform for the order fulfillment. /// /// /// @@ -78,48 +54,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformFulfillmen /// var order = await fulfillmentaction.PerformFulfillmentActionAsync( action, orderId, responseFields); /// /// - public virtual async Task PerformFulfillmentActionAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentAction action, string orderId, string responseFields = null) + public virtual async Task PerformFulfillmentActionAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentAction action, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.FulfillmentActionClient.PerformFulfillmentActionClient( action, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Resends an email with details about the package fulfillment to the shopper. - /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an action to perform when fulfilling an item in an order, whether through in-store pickup or direct shipping. - /// - /// - /// - /// - /// - /// var fulfillmentaction = new FulfillmentAction(); - /// var order = fulfillmentaction.ResendPackageFulfillmentEmail( action, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ResendPackageFulfillmentEmail(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentAction action, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.FulfillmentActionClient.ResendPackageFulfillmentEmailClient( action, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Resends an email with details about the package fulfillment to the shopper. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of an action to perform when fulfilling an item in an order, whether through in-store pickup or direct shipping. + /// + /// + /// /// /// /// @@ -129,12 +80,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order ResendPackageFulf /// var order = await fulfillmentaction.ResendPackageFulfillmentEmailAsync( action, orderId, responseFields); /// /// - public virtual async Task ResendPackageFulfillmentEmailAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentAction action, string orderId, string responseFields = null) + public virtual async Task ResendPackageFulfillmentEmailAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentAction action, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.FulfillmentActionClient.ResendPackageFulfillmentEmailClient( action, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/FulfillmentInfoResource.cs b/Mozu.Api/Resources/Commerce/Orders/FulfillmentInfoResource.cs old mode 100644 new mode 100755 index 1a350280..c204eac5 --- a/Mozu.Api/Resources/Commerce/Orders/FulfillmentInfoResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/FulfillmentInfoResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,38 +38,13 @@ public FulfillmentInfoResource CloneWithApiContext(Action contextMo } - /// - /// Retrieves a list of the fulfillment information for the specified order. - /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var fulfillmentinfo = new FulfillmentInfo(); - /// var fulfillmentInfo = fulfillmentinfo.GetFulfillmentInfo( orderId, draft, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo GetFulfillmentInfo(string orderId, bool? draft = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.FulfillmentInfoClient.GetFulfillmentInfoClient( orderId, draft, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the fulfillment information for the specified order. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. + /// If true, retrieve the draft version of the order's fulfillment information, which might include uncommitted changes. /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -78,52 +54,25 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo Ge /// var fulfillmentInfo = await fulfillmentinfo.GetFulfillmentInfoAsync( orderId, draft, responseFields); /// /// - public virtual async Task GetFulfillmentInfoAsync(string orderId, bool? draft = null, string responseFields = null) + public virtual async Task GetFulfillmentInfoAsync(string orderId, bool? draft = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.FulfillmentInfoClient.GetFulfillmentInfoClient( orderId, draft, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of fulfillment information for the specified order. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of the information needed to fulfill an order, whether via in-store pickup or direct shipping. - /// - /// - /// - /// - /// - /// var fulfillmentinfo = new FulfillmentInfo(); - /// var fulfillmentInfo = fulfillmentinfo.SetFulFillmentInfo( fulfillmentInfo, orderId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo SetFulFillmentInfo(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo fulfillmentInfo, string orderId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.FulfillmentInfoClient.SetFulFillmentInfoClient( fulfillmentInfo, orderId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of fulfillment information for the specified order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of the information needed to fulfill an order, whether via in-store pickup or direct shipping. + /// + /// Specifies whether to set the fulfillment information by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Array list of fulfillment information associated with an order. /// /// /// @@ -133,12 +82,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo Se /// var fulfillmentInfo = await fulfillmentinfo.SetFulFillmentInfoAsync( fulfillmentInfo, orderId, updateMode, version, responseFields); /// /// - public virtual async Task SetFulFillmentInfoAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo fulfillmentInfo, string orderId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task SetFulFillmentInfoAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.FulfillmentInfo fulfillmentInfo, string orderId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.FulfillmentInfoClient.SetFulFillmentInfoClient( fulfillmentInfo, orderId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/OrderAttributeResource.cs b/Mozu.Api/Resources/Commerce/Orders/OrderAttributeResource.cs old mode 100644 new mode 100755 index dc91ed2c..e6914ba1 --- a/Mozu.Api/Resources/Commerce/Orders/OrderAttributeResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/OrderAttributeResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,34 +38,11 @@ public OrderAttributeResource CloneWithApiContext(Action contextMod } - /// - /// Retrieves a list of the attributes defined for the order specified in the request. - /// - /// Unique identifier of the order. - /// - /// List{} - /// - /// - /// - /// var orderattribute = new OrderAttribute(); - /// var orderAttribute = orderattribute.GetOrderAttributes( orderId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetOrderAttributes(string orderId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderAttributeClient.GetOrderAttributesClient( orderId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the attributes defined for the order specified in the request. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order for which to retrieve a list of defined attributes. /// /// List{} /// @@ -74,46 +52,22 @@ public OrderAttributeResource CloneWithApiContext(Action contextMod /// var orderAttribute = await orderattribute.GetOrderAttributesAsync( orderId); /// /// - public virtual async Task> GetOrderAttributesAsync(string orderId) + public virtual async Task> GetOrderAttributesAsync(string orderId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.OrderAttributeClient.GetOrderAttributesClient( orderId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Applies a list of attributes to the order specified in the request and defines a value for each attribute in the request body. - /// - /// Unique identifier of the order. - /// Properties of an attribute applied to an order. - /// - /// List{} - /// - /// - /// - /// var orderattribute = new OrderAttribute(); - /// var orderAttribute = orderattribute.CreateOrderAttributes( orderAttributes, orderId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List CreateOrderAttributes(List orderAttributes, string orderId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderAttributeClient.CreateOrderAttributesClient( orderAttributes, orderId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Applies a list of attributes to the order specified in the request and defines a value for each attribute in the request body. + /// /// - /// Unique identifier of the order. - /// Properties of an attribute applied to an order. + /// Unique identifier of the order for which to assign the attributes. + /// The list of attributes to associate with the order, and the properties of each attribute to define for the order. /// /// List{} /// @@ -123,48 +77,23 @@ public OrderAttributeResource CloneWithApiContext(Action contextMod /// var orderAttribute = await orderattribute.CreateOrderAttributesAsync( orderAttributes, orderId); /// /// - public virtual async Task> CreateOrderAttributesAsync(List orderAttributes, string orderId) + public virtual async Task> CreateOrderAttributesAsync(List orderAttributes, string orderId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.OrderAttributeClient.CreateOrderAttributesClient( orderAttributes, orderId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of an attribute defined for the order specified in the request. - /// - /// Unique identifier of the order. - /// If true, the operation removes missing properties so that the updated order attributes will not show properties with a null value. - /// Properties of an attribute applied to an order. - /// - /// List{} - /// - /// - /// - /// var orderattribute = new OrderAttribute(); - /// var orderAttribute = orderattribute.UpdateOrderAttributes( orderAttributes, orderId, removeMissing); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateOrderAttributes(List orderAttributes, string orderId, bool? removeMissing = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderAttributeClient.UpdateOrderAttributesClient( orderAttributes, orderId, removeMissing); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of an attribute defined for the order specified in the request. + /// /// - /// Unique identifier of the order. + /// Identifier of the order for which to update attributes. /// If true, the operation removes missing properties so that the updated order attributes will not show properties with a null value. - /// Properties of an attribute applied to an order. + /// List of order attributes to update, including the properties of each defined attribute in the list. /// /// List{} /// @@ -174,12 +103,12 @@ public OrderAttributeResource CloneWithApiContext(Action contextMod /// var orderAttribute = await orderattribute.UpdateOrderAttributesAsync( orderAttributes, orderId, removeMissing); /// /// - public virtual async Task> UpdateOrderAttributesAsync(List orderAttributes, string orderId, bool? removeMissing = null) + public virtual async Task> UpdateOrderAttributesAsync(List orderAttributes, string orderId, bool? removeMissing = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.OrderAttributeClient.UpdateOrderAttributesClient( orderAttributes, orderId, removeMissing); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/OrderItemResource.cs b/Mozu.Api/Resources/Commerce/Orders/OrderItemResource.cs old mode 100644 new mode 100755 index b3f33658..eacb3caa --- a/Mozu.Api/Resources/Commerce/Orders/OrderItemResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/OrderItemResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,40 +38,14 @@ public OrderItemResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves an order item with the order line ID. - /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// The specific line id that's associated with the order item. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var orderItem = orderitem.GetOrderItemViaLineId( orderId, lineId, draft, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem GetOrderItemViaLineId(string orderId, int lineId, bool? draft = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.GetOrderItemViaLineIdClient( orderId, lineId, draft, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves an order item with the order line ID. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// The specific line id that's associated with the order item. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// /// @@ -80,50 +55,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem GetOrderItemV /// var orderItem = await orderitem.GetOrderItemViaLineIdAsync( orderId, lineId, draft, responseFields); /// /// - public virtual async Task GetOrderItemViaLineIdAsync(string orderId, int lineId, bool? draft = null, string responseFields = null) + public virtual async Task GetOrderItemViaLineIdAsync(string orderId, int lineId, bool? draft = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.GetOrderItemViaLineIdClient( orderId, lineId, draft, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a single order item. - /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var orderItem = orderitem.GetOrderItem( orderId, orderItemId, draft, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem GetOrderItem(string orderId, string orderItemId, bool? draft = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.GetOrderItemClient( orderId, orderItemId, draft, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a single order item. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. + /// If true, retrieve the draft version of this order item, which might include uncommitted changes to the order item, the order, or other order components. + /// Unique identifier of the order item to retrieve. + /// Unique identifier of the order item details to retrieve. + /// /// /// /// @@ -133,48 +82,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem GetOrderItem( /// var orderItem = await orderitem.GetOrderItemAsync( orderId, orderItemId, draft, responseFields); /// /// - public virtual async Task GetOrderItemAsync(string orderId, string orderItemId, bool? draft = null, string responseFields = null) + public virtual async Task GetOrderItemAsync(string orderId, string orderItemId, bool? draft = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.GetOrderItemClient( orderId, orderItemId, draft, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of all items in an order. - /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var orderItemCollection = orderitem.GetOrderItems( orderId, draft, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItemCollection GetOrderItems(string orderId, bool? draft = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.GetOrderItemsClient( orderId, draft, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of all items in an order. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// If true, retrieve the draft version of the order's items, which might include uncommitted changes to one or more order items, the order itself, or other order components. + /// Unique identifier of the order items to retrieve. + /// /// /// /// @@ -184,54 +108,26 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItemCollection Get /// var orderItemCollection = await orderitem.GetOrderItemsAsync( orderId, draft, responseFields); /// /// - public virtual async Task GetOrderItemsAsync(string orderId, bool? draft = null, string responseFields = null) + public virtual async Task GetOrderItemsAsync(string orderId, bool? draft = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.GetOrderItemsClient( orderId, draft, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a new item to a defined order. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// If true, skip the process to validate inventory when creating this product reservation. - /// 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." - /// 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. - /// The details associated with a specific item in an order. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var order = orderitem.CreateOrderItem( orderItem, orderId, updateMode, version, skipInventoryCheck, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrderItem(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem orderItem, string orderId, string updateMode = null, string version = null, bool? skipInventoryCheck = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.CreateOrderItemClient( orderItem, orderId, updateMode, version, skipInventoryCheck, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a new item to a defined order. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// If true, skip the process to validate inventory when creating this product reservation. - /// 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." - /// 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. - /// The details associated with a specific item in an order. + /// Unique identifier of the order for which to add the item. + /// + /// If true, do not validate the product inventory when adding this item to the order. + /// Specifies whether to add the item by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// The properties of the item to create in the existing order. /// /// /// @@ -241,56 +137,27 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateOrderItem(M /// var order = await orderitem.CreateOrderItemAsync( orderItem, orderId, updateMode, version, skipInventoryCheck, responseFields); /// /// - public virtual async Task CreateOrderItemAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem orderItem, string orderId, string updateMode = null, string version = null, bool? skipInventoryCheck = null, string responseFields = null) + public virtual async Task CreateOrderItemAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem orderItem, string orderId, string updateMode = null, string version = null, bool? skipInventoryCheck = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.CreateOrderItemClient( orderItem, orderId, updateMode, version, skipInventoryCheck, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update the discount applied to an item in an order. - /// - /// discountId parameter description DOCUMENT_HERE - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of all applied discounts for an associated cart, order, or product. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var order = orderitem.UpdateOrderItemDiscount( discount, orderId, orderItemId, discountId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrderItemDiscount(Mozu.Api.Contracts.CommerceRuntime.Discounts.AppliedDiscount discount, string orderId, string orderItemId, int discountId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateOrderItemDiscountClient( discount, orderId, orderItemId, discountId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update the discount applied to an item in an order. + /// /// - /// discountId parameter description DOCUMENT_HERE - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// Properties of all applied discounts for an associated cart, order, or product. + /// Unique identifier of the discount. System-supplied and read only. + /// Unique identifier of the order associated with the item discount. + /// Unique identifier of the item in the order. + /// + /// Specifies whether to change the item discount by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// + /// Properties of the discount to modify for the order item. /// /// /// @@ -300,54 +167,26 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateOrderItemDi /// var order = await orderitem.UpdateOrderItemDiscountAsync( discount, orderId, orderItemId, discountId, updateMode, version, responseFields); /// /// - public virtual async Task UpdateOrderItemDiscountAsync(Mozu.Api.Contracts.CommerceRuntime.Discounts.AppliedDiscount discount, string orderId, string orderItemId, int discountId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task UpdateOrderItemDiscountAsync(Mozu.Api.Contracts.CommerceRuntime.Discounts.AppliedDiscount discount, string orderId, string orderItemId, int discountId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateOrderItemDiscountClient( discount, orderId, orderItemId, discountId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update the duty fee information for an order item. - /// - /// The amount added to the order item for duty fees. - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var order = orderitem.UpdateItemDuty( orderId, orderItemId, dutyAmount, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemDuty(string orderId, string orderItemId, decimal dutyAmount, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateItemDutyClient( orderId, orderItemId, dutyAmount, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update the duty fee information for an order item. + /// /// - /// The amount added to the order item for duty fees. - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// + /// + /// /// /// /// @@ -357,54 +196,26 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemDuty(st /// var order = await orderitem.UpdateItemDutyAsync( orderId, orderItemId, dutyAmount, updateMode, version, responseFields); /// /// - public virtual async Task UpdateItemDutyAsync(string orderId, string orderItemId, decimal dutyAmount, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task UpdateItemDutyAsync(string orderId, string orderItemId, decimal dutyAmount, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateItemDutyClient( orderId, orderItemId, dutyAmount, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the item fulfillment information for the order specified in the request. - /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// The details associated with a specific item in an order. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var order = orderitem.UpdateItemFulfillment( orderItem, orderId, orderItemId, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemFulfillment(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem orderItem, string orderId, string orderItemId, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateItemFulfillmentClient( orderItem, orderId, orderItemId, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the item fulfillment information for the order specified in the request. + /// /// /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// The details associated with a specific item in an order. + /// Unique identifier of the item in the order. + /// + /// Specifies whether to apply the coupon by updating the original order, updating the order in draft mode, or updating 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." + /// + /// Properties of the order item to update for fulfillment. /// /// /// @@ -414,54 +225,26 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemFulfill /// var order = await orderitem.UpdateItemFulfillmentAsync( orderItem, orderId, orderItemId, updateMode, version, responseFields); /// /// - public virtual async Task UpdateItemFulfillmentAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem orderItem, string orderId, string orderItemId, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task UpdateItemFulfillmentAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderItem orderItem, string orderId, string orderItemId, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateItemFulfillmentClient( orderItem, orderId, orderItemId, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Override the price of an individual product on a line item in the specified order. - /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// The override price to specify for this item in the specified order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var order = orderitem.UpdateItemProductPrice( orderId, orderItemId, price, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemProductPrice(string orderId, string orderItemId, decimal price, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateItemProductPriceClient( orderId, orderItemId, price, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Override the price of an individual product on a line item in the specified order. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. + /// Unique identifier of the order containing the item to price override. + /// Unique identifier of the item in the order to price override. /// The override price to specify for this item in the specified order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// + /// Specifies whether to change the product price by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// /// @@ -471,54 +254,26 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemProduct /// var order = await orderitem.UpdateItemProductPriceAsync( orderId, orderItemId, price, updateMode, version, responseFields); /// /// - public virtual async Task UpdateItemProductPriceAsync(string orderId, string orderItemId, decimal price, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task UpdateItemProductPriceAsync(string orderId, string orderItemId, decimal price, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateItemProductPriceClient( orderId, orderItemId, price, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update the quantity of an item in an order. - /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var order = orderitem.UpdateItemQuantity( orderId, orderItemId, quantity, updateMode, version, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemQuantity(string orderId, string orderItemId, int quantity, string updateMode = null, string version = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateItemQuantityClient( orderId, orderItemId, quantity, updateMode, version, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update the quantity of an item in an order. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// Unique identifier of the order containing the item to update quantity. + /// Unique identifier of the item in the order to update quantity. + /// The quantity of the item in the order to update. + /// + /// Specifies whether to change the item quantity by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// /// @@ -528,50 +283,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order UpdateItemQuantit /// var order = await orderitem.UpdateItemQuantityAsync( orderId, orderItemId, quantity, updateMode, version, responseFields); /// /// - public virtual async Task UpdateItemQuantityAsync(string orderId, string orderItemId, int quantity, string updateMode = null, string version = null, string responseFields = null) + public virtual async Task UpdateItemQuantityAsync(string orderId, string orderItemId, int quantity, string updateMode = null, string version = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.UpdateItemQuantityClient( orderId, orderItemId, quantity, updateMode, version, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes a previously added item from a defined order. - /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// 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." - /// 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. - /// - /// - /// - /// - /// - /// var orderitem = new OrderItem(); - /// var order = orderitem.DeleteOrderItem( orderId, orderItemId, updateMode, version); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order DeleteOrderItem(string orderId, string orderItemId, string updateMode = null, string version = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.DeleteOrderItemClient( orderId, orderItemId, updateMode, version); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes a previously added item from a defined order. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order with the item to remove. /// Unique identifier of the item to remove from the order. - /// 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." - /// 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. + /// Specifies whether to remove the item by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// /// @@ -581,12 +310,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order DeleteOrderItem(s /// var order = await orderitem.DeleteOrderItemAsync( orderId, orderItemId, updateMode, version); /// /// - public virtual async Task DeleteOrderItemAsync(string orderId, string orderItemId, string updateMode = null, string version = null) + public virtual async Task DeleteOrderItemAsync(string orderId, string orderItemId, string updateMode = null, string version = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderItemClient.DeleteOrderItemClient( orderId, orderItemId, updateMode, version); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/OrderNoteResource.cs b/Mozu.Api/Resources/Commerce/Orders/OrderNoteResource.cs old mode 100644 new mode 100755 index 38cf1634..9a71b368 --- a/Mozu.Api/Resources/Commerce/Orders/OrderNoteResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/OrderNoteResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,32 +38,9 @@ public OrderNoteResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves a list of all notes for an order. - /// - /// Unique identifier of the order. - /// - /// List{} - /// - /// - /// - /// var ordernote = new OrderNote(); - /// var orderNote = ordernote.GetOrderNotes( orderId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetOrderNotes(string orderId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.GetOrderNotesClient( orderId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of all notes for an order. + /// /// /// Unique identifier of the order. /// @@ -74,48 +52,23 @@ public OrderNoteResource CloneWithApiContext(Action contextModifica /// var orderNote = await ordernote.GetOrderNotesAsync( orderId); /// /// - public virtual async Task> GetOrderNotesAsync(string orderId) + public virtual async Task> GetOrderNotesAsync(string orderId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.GetOrderNotesClient( orderId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a specific order note. - /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var ordernote = new OrderNote(); - /// var orderNote = ordernote.GetOrderNote( orderId, noteId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote GetOrderNote(string orderId, string noteId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.GetOrderNoteClient( orderId, noteId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a specific order note. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order note to retrieve. + /// Unique identifier of the order associated with the note. + /// /// /// /// @@ -125,48 +78,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote GetOrderNote( /// var orderNote = await ordernote.GetOrderNoteAsync( orderId, noteId, responseFields); /// /// - public virtual async Task GetOrderNoteAsync(string orderId, string noteId, string responseFields = null) + public virtual async Task GetOrderNoteAsync(string orderId, string noteId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.GetOrderNoteClient( orderId, noteId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new merchant note for the specified order. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of an order note for a merchant, which is internal only for administrative purposes and not available to the shopper. - /// - /// - /// - /// - /// - /// var ordernote = new OrderNote(); - /// var orderNote = ordernote.CreateOrderNote( orderNote, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote CreateOrderNote(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote orderNote, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.CreateOrderNoteClient( orderNote, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new merchant note for the specified order. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of an order note for a merchant, which is internal only for administrative purposes and not available to the shopper. + /// Unique identifier of the order for which to add a note. + /// + /// The alphanumeric text contained in the note. The maximum length is 256 characters. /// /// /// @@ -176,50 +104,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote CreateOrderNo /// var orderNote = await ordernote.CreateOrderNoteAsync( orderNote, orderId, responseFields); /// /// - public virtual async Task CreateOrderNoteAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote orderNote, string orderId, string responseFields = null) + public virtual async Task CreateOrderNoteAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote orderNote, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.CreateOrderNoteClient( orderNote, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a specific note for an order. - /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of an order note for a merchant, which is internal only for administrative purposes and not available to the shopper. - /// - /// - /// - /// - /// - /// var ordernote = new OrderNote(); - /// var orderNote = ordernote.UpdateOrderNote( orderNote, orderId, noteId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote UpdateOrderNote(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote orderNote, string orderId, string noteId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.UpdateOrderNoteClient( orderNote, orderId, noteId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a specific note for an order. + /// /// - /// Unique identifier of a particular note to retrieve. + /// Unique identifier of the order note. /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of an order note for a merchant, which is internal only for administrative purposes and not available to the shopper. + /// + /// The content of the order note. The maximum length is 256 characters. /// /// /// @@ -229,45 +131,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote UpdateOrderNo /// var orderNote = await ordernote.UpdateOrderNoteAsync( orderNote, orderId, noteId, responseFields); /// /// - public virtual async Task UpdateOrderNoteAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote orderNote, string orderId, string noteId, string responseFields = null) + public virtual async Task UpdateOrderNoteAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote orderNote, string orderId, string noteId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.UpdateOrderNoteClient( orderNote, orderId, noteId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified order note. - /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the order. - /// - /// - /// - /// - /// - /// var ordernote = new OrderNote(); - /// ordernote.DeleteOrderNote( orderId, noteId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteOrderNote(string orderId, string noteId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.DeleteOrderNoteClient( orderId, noteId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified order note. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the order. + /// Unique identifier of the order note to delete. + /// Unique identifier of the order associated with the note. /// /// /// @@ -277,12 +156,12 @@ public virtual void DeleteOrderNote(string orderId, string noteId) /// await ordernote.DeleteOrderNoteAsync( orderId, noteId); /// /// - public virtual async Task DeleteOrderNoteAsync(string orderId, string noteId) + public virtual async Task DeleteOrderNoteAsync(string orderId, string noteId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderNoteClient.DeleteOrderNoteClient( orderId, noteId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Orders/OrderReturnableItemResource.cs b/Mozu.Api/Resources/Commerce/Orders/OrderReturnableItemResource.cs old mode 100644 new mode 100755 index 86b547d3..a0a96c75 --- a/Mozu.Api/Resources/Commerce/Orders/OrderReturnableItemResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/OrderReturnableItemResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { /// - /// Use this subresource to view which order items are eligible for return. + /// /// public partial class OrderReturnableItemResource { /// @@ -37,42 +38,12 @@ public OrderReturnableItemResource CloneWithApiContext(Action conte } - /// - /// Retrieves information about which items are eligible for return on an order.Each item displays the following information: - - - - /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var orderreturnableitem = new OrderReturnableItem(); - /// var orderReturnableItemCollection = orderreturnableitem.GetOrderReturnableItems( orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderReturnableItemCollection GetOrderReturnableItems(string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderReturnableItemClient.GetOrderReturnableItemsClient( orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves information about which items are eligible for return on an order.Each item displays the following information: - - - + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -82,12 +53,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderReturnableItemColl /// var orderReturnableItemCollection = await orderreturnableitem.GetOrderReturnableItemsAsync( orderId, responseFields); /// /// - public virtual async Task GetOrderReturnableItemsAsync(string orderId, string responseFields = null) + public virtual async Task GetOrderReturnableItemsAsync(string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderReturnableItemClient.GetOrderReturnableItemsClient( orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/OrderValidationResultResource.cs b/Mozu.Api/Resources/Commerce/Orders/OrderValidationResultResource.cs old mode 100644 new mode 100755 index 71263c3b..62af2ae5 --- a/Mozu.Api/Resources/Commerce/Orders/OrderValidationResultResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/OrderValidationResultResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,32 +38,9 @@ public OrderValidationResultResource CloneWithApiContext(Action con } - /// - /// Retrieves a list of the validation results associated with the order. - /// - /// Unique identifier of the order. - /// - /// List{} - /// - /// - /// - /// var ordervalidationresult = new OrderValidationResult(); - /// var orderValidationResult = ordervalidationresult.GetValidationResults( orderId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetValidationResults(string orderId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderValidationResultClient.GetValidationResultsClient( orderId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the validation results associated with the order. + /// /// /// Unique identifier of the order. /// @@ -74,48 +52,23 @@ public OrderValidationResultResource CloneWithApiContext(Action con /// var orderValidationResult = await ordervalidationresult.GetValidationResultsAsync( orderId); /// /// - public virtual async Task> GetValidationResultsAsync(string orderId) + public virtual async Task> GetValidationResultsAsync(string orderId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.OrderValidationResultClient.GetValidationResultsClient( orderId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Add a new order validation result to a submitted order. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of the resulting order validation performed by an order validation capability. - /// - /// - /// - /// - /// - /// var ordervalidationresult = new OrderValidationResult(); - /// var orderValidationResult = ordervalidationresult.AddValidationResult( validationResult, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderValidationResult AddValidationResult(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderValidationResult validationResult, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.OrderValidationResultClient.AddValidationResultClient( validationResult, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Add a new order validation result to a submitted order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of the resulting order validation performed by an order validation capability. + /// + /// Properties of the validation result to add for the order. /// /// /// @@ -125,12 +78,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderValidationResult A /// var orderValidationResult = await ordervalidationresult.AddValidationResultAsync( validationResult, orderId, responseFields); /// /// - public virtual async Task AddValidationResultAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderValidationResult validationResult, string orderId, string responseFields = null) + public virtual async Task AddValidationResultAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderValidationResult validationResult, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.OrderValidationResultClient.AddValidationResultClient( validationResult, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/PackageResource.cs b/Mozu.Api/Resources/Commerce/Orders/PackageResource.cs old mode 100644 new mode 100755 index 935b7bb6..cadc1fee --- a/Mozu.Api/Resources/Commerce/Orders/PackageResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/PackageResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,36 +38,12 @@ public PackageResource CloneWithApiContext(Action contextModificati } - /// - /// Retrieves a list of the actions available to perform for a package associated with order fulfillment. - /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// - /// List{string} - /// - /// - /// - /// var package = new Package(); - /// var string = package.GetAvailablePackageFulfillmentActions( orderId, packageId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAvailablePackageFulfillmentActions(string orderId, string packageId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.GetAvailablePackageFulfillmentActionsClient( orderId, packageId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the actions available to perform for a package associated with order fulfillment. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. + /// Unique identifier of the order associated with the package fulfillment. + /// Unique identifier of the package associated with the fulfillment actions to retrieve. /// /// List{string} /// @@ -76,45 +53,21 @@ public virtual List GetAvailablePackageFulfillmentActions(string orderId /// var string = await package.GetAvailablePackageFulfillmentActionsAsync( orderId, packageId); /// /// - public virtual async Task> GetAvailablePackageFulfillmentActionsAsync(string orderId, string packageId) + public virtual async Task> GetAvailablePackageFulfillmentActionsAsync(string orderId, string packageId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.GetAvailablePackageFulfillmentActionsClient( orderId, packageId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the package label image supplied by the carrier. - /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// var stream = package.GetPackageLabel( orderId, packageId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual System.IO.Stream GetPackageLabel(string orderId, string packageId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.GetPackageLabelClient( orderId, packageId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the package label image supplied by the carrier. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order associated with the package label to retrieve. /// Unique identifier of the package for which to retrieve the label. /// /// @@ -125,48 +78,23 @@ public virtual System.IO.Stream GetPackageLabel(string orderId, string packageId /// var stream = await package.GetPackageLabelAsync( orderId, packageId); /// /// - public virtual async Task GetPackageLabelAsync(string orderId, string packageId) + public virtual async Task GetPackageLabelAsync(string orderId, string packageId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.GetPackageLabelClient( orderId, packageId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a package of order items. - /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// var package = package.GetPackage( orderId, packageId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package GetPackage(string orderId, string packageId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.GetPackageClient( orderId, packageId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a package of order items. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the package to retrieve. + /// Unique identifier of the package to retrieve. + /// /// /// /// @@ -176,48 +104,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package GetPackage /// var package = await package.GetPackageAsync( orderId, packageId, responseFields); /// /// - public virtual async Task GetPackageAsync(string orderId, string packageId, string responseFields = null) + public virtual async Task GetPackageAsync(string orderId, string packageId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.GetPackageClient( orderId, packageId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new physical package of order items. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of a physical package shipped for an order. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// var package = package.CreatePackage( pkg, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package CreatePackage(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.CreatePackageClient( pkg, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new physical package of order items. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of a physical package shipped for an order. + /// Unique identifier of the order associated with this package. + /// + /// Properties of the physical package of order items. /// /// /// @@ -227,50 +130,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package CreatePack /// var package = await package.CreatePackageAsync( pkg, orderId, responseFields); /// /// - public virtual async Task CreatePackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string orderId, string responseFields = null) + public virtual async Task CreatePackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.CreatePackageClient( pkg, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of a physical package of order items. - /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Properties of a physical package shipped for an order. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// var package = package.UpdatePackage( pkg, orderId, packageId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package UpdatePackage(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string orderId, string packageId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.UpdatePackageClient( pkg, orderId, packageId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a physical package of order items. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Properties of a physical package shipped for an order. + /// Unique identifier of the order associated with the package to update. + /// Unique identifier of the package of order items to update. + /// + /// Wrapper of properties for the package of order items to update. /// /// /// @@ -280,45 +157,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package UpdatePack /// var package = await package.UpdatePackageAsync( pkg, orderId, packageId, responseFields); /// /// - public virtual async Task UpdatePackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string orderId, string packageId, string responseFields = null) + public virtual async Task UpdatePackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string orderId, string packageId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.UpdatePackageClient( pkg, orderId, packageId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes a physical package of items from the specified order. - /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// package.DeletePackage( orderId, packageId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeletePackage(string orderId, string packageId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.DeletePackageClient( orderId, packageId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes a physical package of items from the specified order. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. + /// Unique identifier of the order associated with the package to delete. + /// Unique identifier of the package to delete. /// /// /// @@ -328,12 +182,12 @@ public virtual void DeletePackage(string orderId, string packageId) /// await package.DeletePackageAsync( orderId, packageId); /// /// - public virtual async Task DeletePackageAsync(string orderId, string packageId) + public virtual async Task DeletePackageAsync(string orderId, string packageId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PackageClient.DeletePackageClient( orderId, packageId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Orders/PaymentResource.cs b/Mozu.Api/Resources/Commerce/Orders/PaymentResource.cs old mode 100644 new mode 100755 index a3cc0dc2..488dff72 --- a/Mozu.Api/Resources/Commerce/Orders/PaymentResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/PaymentResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,36 +38,12 @@ public PaymentResource CloneWithApiContext(Action contextModificati } - /// - /// Retrieves information about all payment transactions submitted for the specified order. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var payment = new Payment(); - /// var paymentCollection = payment.GetPayments( orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentCollection GetPayments(string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.GetPaymentsClient( orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves information about all payment transactions submitted for the specified order. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -76,46 +53,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentCollection Get /// var paymentCollection = await payment.GetPaymentsAsync( orderId, responseFields); /// /// - public virtual async Task GetPaymentsAsync(string orderId, string responseFields = null) + public virtual async Task GetPaymentsAsync(string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.GetPaymentsClient( orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the list of all available payment actions dependent on the order payment status by specifying the order ID. - /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. - /// - /// List{string} - /// - /// - /// - /// var payment = new Payment(); - /// var string = payment.GetAvailablePaymentActions( orderId, paymentId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAvailablePaymentActions(string orderId, string paymentId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.GetAvailablePaymentActionsClient( orderId, paymentId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the list of all available payment actions dependent on the order payment status by specifying the order ID. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. + /// Unique identifier of the order associated with the payment. + /// Unique identifer of the payment for which to retrieve available actions. /// /// List{string} /// @@ -125,48 +78,23 @@ public virtual List GetAvailablePaymentActions(string orderId, string pa /// var string = await payment.GetAvailablePaymentActionsAsync( orderId, paymentId); /// /// - public virtual async Task> GetAvailablePaymentActionsAsync(string orderId, string paymentId) + public virtual async Task> GetAvailablePaymentActionsAsync(string orderId, string paymentId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.GetAvailablePaymentActionsClient( orderId, paymentId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves information about a specific payment transaction submitted for the specified order. - /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var payment = new Payment(); - /// var payment = payment.GetPayment( orderId, paymentId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.Payment GetPayment(string orderId, string paymentId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.GetPaymentClient( orderId, paymentId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves information about a specific payment transaction submitted for the specified order. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the payment transaction. + /// Unique identifier of the payment transaction submitted for the order. + /// /// /// /// @@ -176,50 +104,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.Payment GetPayment(st /// var payment = await payment.GetPaymentAsync( orderId, paymentId, responseFields); /// /// - public virtual async Task GetPaymentAsync(string orderId, string paymentId, string responseFields = null) + public virtual async Task GetPaymentAsync(string orderId, string paymentId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.GetPaymentClient( orderId, paymentId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Performs the specified action for an individual order payment transaction. - /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Properties of the payment action performed for an order. - /// - /// - /// - /// - /// - /// var payment = new Payment(); - /// var order = payment.PerformPaymentAction( action, orderId, paymentId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformPaymentAction(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string orderId, string paymentId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.PerformPaymentActionClient( action, orderId, paymentId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Performs the specified action for an individual order payment transaction. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Properties of the payment action performed for an order. + /// Unique identifier of the order associated with the payment. + /// Unique identifer of the payment for which to perform the action. + /// + /// The action to perform for the payment. Possible values are AuthAndCapture, AuthorizePayment, CapturePayment, VoidPayment, CreditPayment, RequestCheck, ApplyCheck, DeclineCheck. /// /// /// @@ -229,48 +131,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order PerformPaymentAct /// var order = await payment.PerformPaymentActionAsync( action, orderId, paymentId, responseFields); /// /// - public virtual async Task PerformPaymentActionAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string orderId, string paymentId, string responseFields = null) + public virtual async Task PerformPaymentActionAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string orderId, string paymentId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.PerformPaymentActionClient( action, orderId, paymentId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new payment transaction for the specified order and performs the specified action. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of the payment action performed for an order. - /// - /// - /// - /// - /// - /// var payment = new Payment(); - /// var order = payment.CreatePaymentAction( action, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreatePaymentAction(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.CreatePaymentActionClient( action, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new payment transaction for the specified order and performs the specified action. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of the payment action performed for an order. + /// Unique identifier of the order for which to apply the payment. + /// + /// To action to perform for the newly created payment. Possible values are AuthAndCapture, AuthorizePayment, CapturePayment, VoidPayment, CreditPayment, RequestCheck, ApplyCheck, DeclineCheck. /// /// /// @@ -280,12 +157,12 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreatePaymentActi /// var order = await payment.CreatePaymentActionAsync( action, orderId, responseFields); /// /// - public virtual async Task CreatePaymentActionAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string orderId, string responseFields = null) + public virtual async Task CreatePaymentActionAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PaymentClient.CreatePaymentActionClient( action, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Orders/PickupResource.cs b/Mozu.Api/Resources/Commerce/Orders/PickupResource.cs old mode 100644 new mode 100755 index f1d1fdf7..3c46ef60 --- a/Mozu.Api/Resources/Commerce/Orders/PickupResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/PickupResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,36 +38,12 @@ public PickupResource CloneWithApiContext(Action contextModificatio } - /// - /// Retrieves a list of the actions available to perform for the pickup specified in the request. - /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// - /// List{string} - /// - /// - /// - /// var pickup = new Pickup(); - /// var string = pickup.GetAvailablePickupFulfillmentActions( orderId, pickupId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAvailablePickupFulfillmentActions(string orderId, string pickupId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.GetAvailablePickupFulfillmentActionsClient( orderId, pickupId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the actions available to perform for the pickup specified in the request. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. + /// Unique identifier of the order associated with the pickup. + /// Unique identifier of the pickup for which to retrieve available actions. /// /// List{string} /// @@ -76,48 +53,23 @@ public virtual List GetAvailablePickupFulfillmentActions(string orderId, /// var string = await pickup.GetAvailablePickupFulfillmentActionsAsync( orderId, pickupId); /// /// - public virtual async Task> GetAvailablePickupFulfillmentActionsAsync(string orderId, string pickupId) + public virtual async Task> GetAvailablePickupFulfillmentActionsAsync(string orderId, string pickupId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.GetAvailablePickupFulfillmentActionsClient( orderId, pickupId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the in-store pickup specified in the request. - /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var pickup = new Pickup(); - /// var pickup = pickup.GetPickup( orderId, pickupId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup GetPickup(string orderId, string pickupId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.GetPickupClient( orderId, pickupId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the in-store pickup specified in the request. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the pickup. + /// Unique identifier of the pickup to retrieve. + /// /// /// /// @@ -127,48 +79,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup GetPickup(s /// var pickup = await pickup.GetPickupAsync( orderId, pickupId, responseFields); /// /// - public virtual async Task GetPickupAsync(string orderId, string pickupId, string responseFields = null) + public virtual async Task GetPickupAsync(string orderId, string pickupId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.GetPickupClient( orderId, pickupId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Create a new pickup for the order specified in the request for in-store fufillment. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of an in-store pickup defined to fulfill items in an order. - /// - /// - /// - /// - /// - /// var pickup = new Pickup(); - /// var pickup = pickup.CreatePickup( pickup, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup CreatePickup(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup pickup, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.CreatePickupClient( pickup, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Create a new pickup for the order specified in the request for in-store fufillment. + /// /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Properties of an in-store pickup defined to fulfill items in an order. + /// + /// Properties of the in-store pickup to create. /// /// /// @@ -178,50 +105,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup CreatePicku /// var pickup = await pickup.CreatePickupAsync( pickup, orderId, responseFields); /// /// - public virtual async Task CreatePickupAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup pickup, string orderId, string responseFields = null) + public virtual async Task CreatePickupAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup pickup, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.CreatePickupClient( pickup, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more details of a defined in-store pickup. - /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// Use this field to include those fields which are not included by default. - /// Properties of an in-store pickup defined to fulfill items in an order. - /// - /// - /// - /// - /// - /// var pickup = new Pickup(); - /// var pickup = pickup.UpdatePickup( pickup, orderId, pickupId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup UpdatePickup(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup pickup, string orderId, string pickupId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.UpdatePickupClient( pickup, orderId, pickupId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more details of a defined in-store pickup. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// Use this field to include those fields which are not included by default. - /// Properties of an in-store pickup defined to fulfill items in an order. + /// Unique identifier of the order associated with the in-store pickup. + /// Unique identifier of the pickup to update. + /// + /// Properties of the in-store pickup to update. /// /// /// @@ -231,44 +132,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup UpdatePicku /// var pickup = await pickup.UpdatePickupAsync( pickup, orderId, pickupId, responseFields); /// /// - public virtual async Task UpdatePickupAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup pickup, string orderId, string pickupId, string responseFields = null) + public virtual async Task UpdatePickupAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Pickup pickup, string orderId, string pickupId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.UpdatePickupClient( pickup, orderId, pickupId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes a pickup previously defined for order item in-store pickup fulfillment. - /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// - /// - /// - /// - /// - /// var pickup = new Pickup(); - /// pickup.DeletePickup( orderId, pickupId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeletePickup(string orderId, string pickupId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.DeletePickupClient( orderId, pickupId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes a pickup previously defined for order item in-store pickup fulfillment. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order associated with the pickup. /// Unique identifier of the pickup to remove. /// /// @@ -279,12 +157,12 @@ public virtual void DeletePickup(string orderId, string pickupId) /// await pickup.DeletePickupAsync( orderId, pickupId); /// /// - public virtual async Task DeletePickupAsync(string orderId, string pickupId) + public virtual async Task DeletePickupAsync(string orderId, string pickupId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.PickupClient.DeletePickupClient( orderId, pickupId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Orders/RefundResource.cs b/Mozu.Api/Resources/Commerce/Orders/RefundResource.cs old mode 100644 new mode 100755 index 98eb98cd..7991a9c1 --- a/Mozu.Api/Resources/Commerce/Orders/RefundResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/RefundResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { /// - /// Use the refunds resource to create a refund. + /// /// public partial class RefundResource { /// @@ -37,38 +38,13 @@ public RefundResource CloneWithApiContext(Action contextModificatio } - /// - /// Creates a refund based on the information supplied in the request. - /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the refund. - /// - /// - /// - /// - /// - /// var refund = new Refund(); - /// var refund = refund.CreateRefund( refund, orderId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Refunds.Refund CreateRefund(Mozu.Api.Contracts.CommerceRuntime.Refunds.Refund refund, string orderId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.RefundClient.CreateRefundClient( refund, orderId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a refund based on the information supplied in the request. + /// /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the refund. + /// + /// + /// /// /// /// @@ -78,45 +54,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Refunds.Refund CreateRefund(Mo /// var refund = await refund.CreateRefundAsync( refund, orderId, responseFields); /// /// - public virtual async Task CreateRefundAsync(Mozu.Api.Contracts.CommerceRuntime.Refunds.Refund refund, string orderId, string responseFields = null) + public virtual async Task CreateRefundAsync(Mozu.Api.Contracts.CommerceRuntime.Refunds.Refund refund, string orderId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.RefundClient.CreateRefundClient( refund, orderId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Resends the order refund email previously sent to the shopper. - /// - /// Unique identifier of the order. - /// Unique ID of the refund. - /// - /// - /// - /// - /// - /// var refund = new Refund(); - /// refund.ResendRefundEmail( orderId, refundId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void ResendRefundEmail(string orderId, string refundId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.RefundClient.ResendRefundEmailClient( orderId, refundId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Resends the order refund email previously sent to the shopper. + /// /// - /// Unique identifier of the order. - /// Unique ID of the refund. + /// + /// /// /// /// @@ -126,12 +79,12 @@ public virtual void ResendRefundEmail(string orderId, string refundId) /// await refund.ResendRefundEmailAsync( orderId, refundId); /// /// - public virtual async Task ResendRefundEmailAsync(string orderId, string refundId) + public virtual async Task ResendRefundEmailAsync(string orderId, string refundId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.RefundClient.ResendRefundEmailClient( orderId, refundId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Orders/ShipmentResource.cs b/Mozu.Api/Resources/Commerce/Orders/ShipmentResource.cs old mode 100644 new mode 100755 index 5465c1ae..24db901a --- a/Mozu.Api/Resources/Commerce/Orders/ShipmentResource.cs +++ b/Mozu.Api/Resources/Commerce/Orders/ShipmentResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Orders { @@ -37,37 +38,12 @@ public ShipmentResource CloneWithApiContext(Action contextModificat } - /// - /// Retrieves the details of the order shipment specified in the request. - /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the shipment to retrieve. - /// - /// - /// - /// - /// - /// var shipment = new Shipment(); - /// var shipment = shipment.GetShipment( orderId, shipmentId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipment(string orderId, string shipmentId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.ShipmentClient.GetShipmentClient( orderId, shipmentId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the order shipment specified in the request. + /// /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the shipment to retrieve. + /// /// Unique identifier of the shipment to retrieve. /// /// @@ -78,46 +54,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipme /// var shipment = await shipment.GetShipmentAsync( orderId, shipmentId, responseFields); /// /// - public virtual async Task GetShipmentAsync(string orderId, string shipmentId, string responseFields = null) + public virtual async Task GetShipmentAsync(string orderId, string shipmentId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.ShipmentClient.GetShipmentClient( orderId, shipmentId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the available shipping methods applicable to the order. Typically used to display available shipping method options on the checkout page. - /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// - /// List{} - /// - /// - /// - /// var shipment = new Shipment(); - /// var shippingRate = shipment.GetAvailableShipmentMethods( orderId, draft); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAvailableShipmentMethods(string orderId, bool? draft = null) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.ShipmentClient.GetAvailableShipmentMethodsClient( orderId, draft); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the available shipping methods applicable to the order. Typically used to display available shipping method options on the checkout page. + /// /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. + /// + /// Unique identifier of the order for the available shipment methods being retrieved. /// /// List{} /// @@ -127,45 +79,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipme /// var shippingRate = await shipment.GetAvailableShipmentMethodsAsync( orderId, draft); /// /// - public virtual async Task> GetAvailableShipmentMethodsAsync(string orderId, bool? draft = null) + public virtual async Task> GetAvailableShipmentMethodsAsync(string orderId, bool? draft = null, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.ShipmentClient.GetAvailableShipmentMethodsClient( orderId, draft); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a shipment from one or more package associated with an order and assign a label and tracking number to an order shipment. - /// - /// Unique identifier of the order. - /// List of unique identifiers for each package associated with this shipment. Not all packages must belong to the same shipment. - /// - /// List{} - /// - /// - /// - /// var shipment = new Shipment(); - /// var package = shipment.CreatePackageShipments( packageIds, orderId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List CreatePackageShipments(List packageIds, string orderId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Orders.ShipmentClient.CreatePackageShipmentsClient( packageIds, orderId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a shipment from one or more package associated with an order and assign a label and tracking number to an order shipment. + /// /// - /// Unique identifier of the order. + /// Unique identifier of the order for this shipment. /// List of unique identifiers for each package associated with this shipment. Not all packages must belong to the same shipment. /// /// List{} @@ -176,45 +104,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipme /// var package = await shipment.CreatePackageShipmentsAsync( packageIds, orderId); /// /// - public virtual async Task> CreatePackageShipmentsAsync(List packageIds, string orderId) + public virtual async Task> CreatePackageShipmentsAsync(List packageIds, string orderId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Orders.ShipmentClient.CreatePackageShipmentsClient( packageIds, orderId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the shipment specified in the request. - /// - /// Unique identifier of the order. - /// Unique identifier of the shipment to retrieve. - /// - /// - /// - /// - /// - /// var shipment = new Shipment(); - /// shipment.DeleteShipment( orderId, shipmentId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteShipment(string orderId, string shipmentId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Orders.ShipmentClient.DeleteShipmentClient( orderId, shipmentId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the shipment specified in the request. + /// /// - /// Unique identifier of the order. - /// Unique identifier of the shipment to retrieve. + /// Unique identifier of the order to cancel shipment. + /// Unique identifier of the shipment to cancel. /// /// /// @@ -224,12 +129,12 @@ public virtual void DeleteShipment(string orderId, string shipmentId) /// await shipment.DeleteShipmentAsync( orderId, shipmentId); /// /// - public virtual async Task DeleteShipmentAsync(string orderId, string shipmentId) + public virtual async Task DeleteShipmentAsync(string orderId, string shipmentId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Orders.ShipmentClient.DeleteShipmentClient( orderId, shipmentId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Payments/FraudScreenResource.cs b/Mozu.Api/Resources/Commerce/Payments/FraudScreenResource.cs old mode 100644 new mode 100755 index 5490fba1..5a0c3a80 --- a/Mozu.Api/Resources/Commerce/Payments/FraudScreenResource.cs +++ b/Mozu.Api/Resources/Commerce/Payments/FraudScreenResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Payments { /// - /// commerce/payments/fraudscreen related resources. DOCUMENT_HERE + /// /// public partial class FraudScreenResource { /// @@ -37,36 +38,12 @@ public FraudScreenResource CloneWithApiContext(Action contextModifi } - /// - /// payments-fraudscreen Post Screen description DOCUMENT_HERE - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Mozu.PaymentService.Contracts.Request.FraudScreenRequest ApiType DOCUMENT_HERE - /// - /// - /// - /// - /// - /// var fraudscreen = new FraudScreen(); - /// var fraudScreen = fraudscreen.Screen( request, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.PaymentService.Response.FraudScreen Screen(Mozu.Api.Contracts.PaymentService.Request.FraudScreenRequest request, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Payments.FraudScreenClient.ScreenClient( request, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// payments-fraudscreen Post Screen description DOCUMENT_HERE + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Mozu.PaymentService.Contracts.Request.FraudScreenRequest ApiType DOCUMENT_HERE + /// + /// /// /// /// @@ -76,12 +53,12 @@ public virtual Mozu.Api.Contracts.PaymentService.Response.FraudScreen Screen(Moz /// var fraudScreen = await fraudscreen.ScreenAsync( request, responseFields); /// /// - public virtual async Task ScreenAsync(Mozu.Api.Contracts.PaymentService.Request.FraudScreenRequest request, string responseFields = null) + public virtual async Task ScreenAsync(Mozu.Api.Contracts.PaymentService.Request.FraudScreenRequest request, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Payments.FraudScreenClient.ScreenClient( request, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Payments/PublicCardResource.cs b/Mozu.Api/Resources/Commerce/Payments/PublicCardResource.cs old mode 100644 new mode 100755 index 7337101d..e6b47697 --- a/Mozu.Api/Resources/Commerce/Payments/PublicCardResource.cs +++ b/Mozu.Api/Resources/Commerce/Payments/PublicCardResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Payments { /// - /// commerce/payments/cards related resources. DOCUMENT_HERE + /// /// public partial class PublicCardResource { /// @@ -41,36 +42,12 @@ public PublicCardResource CloneWithApiContext(Action contextModific } - /// - /// payments-cards Post Create description DOCUMENT_HERE - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Mozu.PaymentService.Contracts.PublicCard ApiType DOCUMENT_HERE - /// - /// - /// - /// - /// - /// var publiccard = new PublicCard(); - /// var syncResponse = publiccard.Create( request, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.PaymentService.Response.SyncResponse Create(Mozu.Api.Contracts.PaymentService.PublicCard request, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Payments.PublicCardClient.CreateClient( request, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// payments-cards Post Create description DOCUMENT_HERE + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Mozu.PaymentService.Contracts.PublicCard ApiType DOCUMENT_HERE + /// + /// /// /// /// @@ -80,48 +57,23 @@ public virtual Mozu.Api.Contracts.PaymentService.Response.SyncResponse Create(Mo /// var syncResponse = await publiccard.CreateAsync( request, responseFields); /// /// - public virtual async Task CreateAsync(Mozu.Api.Contracts.PaymentService.PublicCard request, string responseFields = null) + public virtual async Task CreateAsync(Mozu.Api.Contracts.PaymentService.PublicCard request, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Payments.PublicCardClient.CreateClient( request, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// payments-cards Put Update description DOCUMENT_HERE - /// - /// Unique identifier of the card associated with the customer account billing contact. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Mozu.PaymentService.Contracts.PublicCard ApiType DOCUMENT_HERE - /// - /// - /// - /// - /// - /// var publiccard = new PublicCard(); - /// var syncResponse = publiccard.Update( request, cardId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.PaymentService.Response.SyncResponse Update(Mozu.Api.Contracts.PaymentService.PublicCard request, string cardId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Payments.PublicCardClient.UpdateClient( request, cardId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// payments-cards Put Update description DOCUMENT_HERE + /// /// - /// Unique identifier of the card associated with the customer account billing contact. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Mozu.PaymentService.Contracts.PublicCard ApiType DOCUMENT_HERE + /// + /// + /// /// /// /// @@ -131,43 +83,21 @@ public virtual Mozu.Api.Contracts.PaymentService.Response.SyncResponse Update(Mo /// var syncResponse = await publiccard.UpdateAsync( request, cardId, responseFields); /// /// - public virtual async Task UpdateAsync(Mozu.Api.Contracts.PaymentService.PublicCard request, string cardId, string responseFields = null) + public virtual async Task UpdateAsync(Mozu.Api.Contracts.PaymentService.PublicCard request, string cardId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Payments.PublicCardClient.UpdateClient( request, cardId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// payments-cards Delete Delete description DOCUMENT_HERE - /// - /// Unique identifier of the card associated with the customer account billing contact. - /// - /// - /// - /// - /// - /// var publiccard = new PublicCard(); - /// publiccard.Delete( cardId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void Delete(string cardId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Payments.PublicCardClient.DeleteClient( cardId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// payments-cards Delete Delete description DOCUMENT_HERE + /// /// - /// Unique identifier of the card associated with the customer account billing contact. + /// /// /// /// @@ -177,12 +107,12 @@ public virtual void Delete(string cardId) /// await publiccard.DeleteAsync( cardId); /// /// - public virtual async Task DeleteAsync(string cardId) + public virtual async Task DeleteAsync(string cardId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Payments.PublicCardClient.DeleteClient( cardId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/ReturnResource.cs b/Mozu.Api/Resources/Commerce/ReturnResource.cs old mode 100644 new mode 100755 index 7016e4dd..d6606cc4 --- a/Mozu.Api/Resources/Commerce/ReturnResource.cs +++ b/Mozu.Api/Resources/Commerce/ReturnResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce { /// - /// Use the Returns resource to manage returned items that were previously fufilled. Returns can include any number of items associated with an original order. Each return must either be associated with an original order or a product definition to represent each returned item.Refer to the [Returns API](https://www.mozu.com/docs/developer/api-guides/returns.htm) topic for more information about creating and processing returns using the API. + /// Use the Returns resource to manage returned items that were previously fufilled. Returns can include any number of items associated with an original Mozu order. Each return must either be associated with an original order or a product definition to represent each returned item. /// public partial class ReturnResource { /// @@ -37,44 +38,16 @@ public ReturnResource CloneWithApiContext(Action contextModificatio } - /// - /// Retrieves a list of all returns according to any filter and sort criteria. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var returnCollection = return.GetReturns( startIndex, pageSize, sortBy, filter, q, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnCollection GetReturns(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReturnsClient( startIndex, pageSize, sortBy, filter, q, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of all returns according to any filter and sort criteria. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// /// @@ -84,44 +57,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnCollection GetRe /// var returnCollection = await return.GetReturnsAsync( startIndex, pageSize, sortBy, filter, q, responseFields); /// /// - public virtual async Task GetReturnsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, string responseFields = null) + public virtual async Task GetReturnsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReturnsClient( startIndex, pageSize, sortBy, filter, q, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of the actions available to perform for the specified return based on its current state. - /// - /// Unique identifier of the return whose items you want to get. - /// - /// List{string} - /// - /// - /// - /// var return = new Return(); - /// var string = return.GetAvailableReturnActions( returnId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAvailableReturnActions(string returnId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.GetAvailableReturnActionsClient( returnId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the actions available to perform for the specified return based on its current state. + /// /// - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return for which to retrieve available actions. /// /// List{string} /// @@ -131,48 +81,23 @@ public virtual List GetAvailableReturnActions(string returnId) /// var string = await return.GetAvailableReturnActionsAsync( returnId); /// /// - public virtual async Task> GetAvailableReturnActionsAsync(string returnId) + public virtual async Task> GetAvailableReturnActionsAsync(string returnId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.ReturnClient.GetAvailableReturnActionsClient( returnId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a single return item. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the return item whose details you want to get. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var returnItem = return.GetReturnItem( returnId, returnItemId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItem GetReturnItem(string returnId, string returnItemId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReturnItemClient( returnId, returnItemId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a single return item. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the return item whose details you want to get. + /// + /// + /// /// /// /// @@ -182,46 +107,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItem GetReturnIt /// var returnItem = await return.GetReturnItemAsync( returnId, returnItemId, responseFields); /// /// - public virtual async Task GetReturnItemAsync(string returnId, string returnItemId, string responseFields = null) + public virtual async Task GetReturnItemAsync(string returnId, string returnItemId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReturnItemClient( returnId, returnItemId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of all return items in an order. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var returnItemCollection = return.GetReturnItems( returnId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItemCollection GetReturnItems(string returnId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReturnItemsClient( returnId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of all return items in an order. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// /// @@ -231,46 +132,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItemCollection G /// var returnItemCollection = await return.GetReturnItemsAsync( returnId, responseFields); /// /// - public virtual async Task GetReturnItemsAsync(string returnId, string responseFields = null) + public virtual async Task GetReturnItemsAsync(string returnId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReturnItemsClient( returnId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of the payment actions available to perform for the specified return when a return results in a refund to the customer. - /// - /// Unique identifier of the payment for which to perform the action. - /// Unique identifier of the return whose items you want to get. - /// - /// List{string} - /// - /// - /// - /// var return = new Return(); - /// var string = return.GetAvailablePaymentActionsForReturn( returnId, paymentId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetAvailablePaymentActionsForReturn(string returnId, string paymentId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.GetAvailablePaymentActionsForReturnClient( returnId, paymentId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the payment actions available to perform for the specified return when a return results in a refund to the customer. + /// /// /// Unique identifier of the payment for which to perform the action. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return associated with the payment. /// /// List{string} /// @@ -280,48 +157,23 @@ public virtual List GetAvailablePaymentActionsForReturn(string returnId, /// var string = await return.GetAvailablePaymentActionsForReturnAsync( returnId, paymentId); /// /// - public virtual async Task> GetAvailablePaymentActionsForReturnAsync(string returnId, string paymentId) + public virtual async Task> GetAvailablePaymentActionsForReturnAsync(string returnId, string paymentId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.ReturnClient.GetAvailablePaymentActionsForReturnClient( returnId, paymentId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a payment submitted as part of a refund associated with a customer return. - /// - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var payment = return.GetPayment( returnId, paymentId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.Payment GetPayment(string returnId, string paymentId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.GetPaymentClient( returnId, paymentId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a payment submitted as part of a refund associated with a customer return. + /// /// - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return payment to retrieve. + /// + /// Unique identifier of the return associated with the payment. /// /// /// @@ -331,46 +183,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.Payment GetPayment(st /// var payment = await return.GetPaymentAsync( returnId, paymentId, responseFields); /// /// - public virtual async Task GetPaymentAsync(string returnId, string paymentId, string responseFields = null) + public virtual async Task GetPaymentAsync(string returnId, string paymentId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.GetPaymentClient( returnId, paymentId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of all payments submitted as part of a refund associated with a customer return. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var paymentCollection = return.GetPayments( returnId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentCollection GetPayments(string returnId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.GetPaymentsClient( returnId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of all payments submitted as part of a refund associated with a customer return. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// Returns the details of the refund payment associated with the return specified in the request. /// /// /// @@ -380,46 +208,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentCollection Get /// var paymentCollection = await return.GetPaymentsAsync( returnId, responseFields); /// /// - public virtual async Task GetPaymentsAsync(string returnId, string responseFields = null) + public virtual async Task GetPaymentsAsync(string returnId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.GetPaymentsClient( returnId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of properties for the specified return. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var return = return.GetReturn( returnId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return GetReturn(string returnId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReturnClient( returnId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of properties for the specified return. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// Returns the properties of the return specified in the request as well as system-supplied information. /// /// /// @@ -429,44 +233,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return GetReturn(strin /// var return = await return.GetReturnAsync( returnId, responseFields); /// /// - public virtual async Task GetReturnAsync(string returnId, string responseFields = null) + public virtual async Task GetReturnAsync(string returnId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReturnClient( returnId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Returns a list of reasons for a return. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var reasonCollection = return.GetReasons( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReasonCollection GetReasons(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReasonsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Returns a list of reasons for a return. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -476,52 +257,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReasonCollection GetRe /// var reasonCollection = await return.GetReasonsAsync( responseFields); /// /// - public virtual async Task GetReasonsAsync(string responseFields = null) + public virtual async Task GetReasonsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.GetReasonsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a return for previously fulfilled items. Each return must either be associated with an original order or a product definition to represent each returned item.When you create a return, you must specify the following fields: - - - - /// - /// Use this field to include those fields which are not included by default. - /// Properties of a return of one or more previously fulfilled items. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var return = return.CreateReturn( ret, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreateReturn(Mozu.Api.Contracts.CommerceRuntime.Returns.Return ret, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.CreateReturnClient( ret, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a return for previously fulfilled items. Each return must either be associated with an original order or a product definition to represent each returned item.When you create a return, you must specify the following fields: - - - + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a return of one or more previously fulfilled items. + /// + /// Wrapper for the properties of the return to create. /// /// /// @@ -531,48 +282,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreateReturn(Mo /// var return = await return.CreateReturnAsync( ret, responseFields); /// /// - public virtual async Task CreateReturnAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.Return ret, string responseFields = null) + public virtual async Task CreateReturnAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.Return ret, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.CreateReturnClient( ret, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a return item to the return. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a previously fulfilled item associated with a return. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var return = return.CreateReturnItem( returnItem, returnId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreateReturnItem(Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItem returnItem, string returnId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.CreateReturnItemClient( returnItem, returnId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a return item to the return. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a previously fulfilled item associated with a return. + /// + /// + /// /// /// /// @@ -582,50 +308,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreateReturnIte /// var return = await return.CreateReturnItemAsync( returnItem, returnId, responseFields); /// /// - public virtual async Task CreateReturnItemAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItem returnItem, string returnId, string responseFields = null) + public virtual async Task CreateReturnItemAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnItem returnItem, string returnId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.CreateReturnItemClient( returnItem, returnId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a refund payment associated with a customer return by performing the specified action. - /// - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of the payment action performed for an order. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var return = return.PerformPaymentActionForReturn( action, returnId, paymentId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return PerformPaymentActionForReturn(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string returnId, string paymentId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.PerformPaymentActionForReturnClient( action, returnId, paymentId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a refund payment associated with a customer return by performing the specified action. + /// /// - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of the payment action performed for an order. + /// Unique identifier of the return payment to update. + /// + /// Unique identifier of the return associated with the refund payment. + /// The payment action to perform for the refund payment. /// /// /// @@ -635,48 +335,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return PerformPaymentA /// var return = await return.PerformPaymentActionForReturnAsync( action, returnId, paymentId, responseFields); /// /// - public virtual async Task PerformPaymentActionForReturnAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string returnId, string paymentId, string responseFields = null) + public virtual async Task PerformPaymentActionForReturnAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string returnId, string paymentId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.PerformPaymentActionForReturnClient( action, returnId, paymentId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new payment for a return that results in a refund to the customer. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of the payment action performed for an order. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var return = return.CreatePaymentActionForReturn( action, returnId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreatePaymentActionForReturn(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string returnId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.CreatePaymentActionForReturnClient( action, returnId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new payment for a return that results in a refund to the customer. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of the payment action performed for an order. + /// + /// Unique identifier of the return associated with the payment action. + /// The payment action to perform for the customer return. /// /// /// @@ -686,47 +361,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return CreatePaymentAc /// var return = await return.CreatePaymentActionForReturnAsync( action, returnId, responseFields); /// /// - public virtual async Task CreatePaymentActionForReturnAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string returnId, string responseFields = null) + public virtual async Task CreatePaymentActionForReturnAsync(Mozu.Api.Contracts.CommerceRuntime.Payments.PaymentAction action, string returnId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.CreatePaymentActionForReturnClient( action, returnId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a replacement order for the return. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var order = return.CreateReturnShippingOrder( itemQuantities, returnId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateReturnShippingOrder(List itemQuantities, string returnId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.CreateReturnShippingOrderClient( itemQuantities, returnId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a replacement order for the return. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// /// @@ -737,46 +387,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.Order CreateReturnShipp /// var order = await return.CreateReturnShippingOrderAsync( itemQuantities, returnId, responseFields); /// /// - public virtual async Task CreateReturnShippingOrderAsync(List itemQuantities, string returnId, string responseFields = null) + public virtual async Task CreateReturnShippingOrderAsync(List itemQuantities, string returnId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.CreateReturnShippingOrderClient( itemQuantities, returnId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the return by performing the action specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of an action a user can perform for a return. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var returnCollection = return.PerformReturnActions( action, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnCollection PerformReturnActions(Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnAction action, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.PerformReturnActionsClient( action, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the return by performing the action specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of an action a user can perform for a return. + /// + /// The name of the return action to perform, such as "Reject" or "Authorize". /// /// /// @@ -786,48 +412,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnCollection Perfo /// var returnCollection = await return.PerformReturnActionsAsync( action, responseFields); /// /// - public virtual async Task PerformReturnActionsAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnAction action, string responseFields = null) + public virtual async Task PerformReturnActionsAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnAction action, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.PerformReturnActionsClient( action, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of a return for items previously shipped in a completed order. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a return of one or more previously fulfilled items. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var return = return.UpdateReturn( ret, returnId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return UpdateReturn(Mozu.Api.Contracts.CommerceRuntime.Returns.Return ret, string returnId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.UpdateReturnClient( ret, returnId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a return for items previously shipped in a completed order. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a return of one or more previously fulfilled items. + /// + /// Unique identifier of the return. + /// Wrapper for the array of properties to update for the return. /// /// /// @@ -837,43 +438,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return UpdateReturn(Mo /// var return = await return.UpdateReturnAsync( ret, returnId, responseFields); /// /// - public virtual async Task UpdateReturnAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.Return ret, string returnId, string responseFields = null) + public virtual async Task UpdateReturnAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.Return ret, string returnId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.UpdateReturnClient( ret, returnId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Resend the email notification to a shopper that a return has been created. - /// - /// Properties of an action a user can perform for a return. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// return.ResendReturnEmail( action); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void ResendReturnEmail(Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnAction action) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.ResendReturnEmailClient( action); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Resend the email notification to a shopper that a return has been created. + /// /// - /// Properties of an action a user can perform for a return. + /// /// /// /// @@ -883,45 +462,21 @@ public virtual void ResendReturnEmail(Mozu.Api.Contracts.CommerceRuntime.Returns /// await return.ResendReturnEmailAsync( action); /// /// - public virtual async Task ResendReturnEmailAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnAction action) + public virtual async Task ResendReturnEmailAsync(Mozu.Api.Contracts.CommerceRuntime.Returns.ReturnAction action, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.ResendReturnEmailClient( action); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Removes a particular order item from the order of the current shopper. - /// - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the return item whose details you want to get. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// var return = return.DeleteOrderItem( returnId, returnItemId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return DeleteOrderItem(string returnId, string returnItemId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.DeleteOrderItemClient( returnId, returnItemId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes a particular order item from the order of the current shopper. + /// /// - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the return item whose details you want to get. + /// + /// /// /// /// @@ -931,43 +486,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Returns.Return DeleteOrderItem /// var return = await return.DeleteOrderItemAsync( returnId, returnItemId); /// /// - public virtual async Task DeleteOrderItemAsync(string returnId, string returnItemId) + public virtual async Task DeleteOrderItemAsync(string returnId, string returnItemId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.DeleteOrderItemClient( returnId, returnItemId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the return specified in the request. - /// - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var return = new Return(); - /// return.DeleteReturn( returnId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteReturn(string returnId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.ReturnClient.DeleteReturnClient( returnId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the return specified in the request. + /// /// - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return to delete. /// /// /// @@ -977,12 +510,12 @@ public virtual void DeleteReturn(string returnId) /// await return.DeleteReturnAsync( returnId); /// /// - public virtual async Task DeleteReturnAsync(string returnId) + public virtual async Task DeleteReturnAsync(string returnId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.ReturnClient.DeleteReturnClient( returnId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Returns/OrderNoteResource.cs b/Mozu.Api/Resources/Commerce/Returns/OrderNoteResource.cs old mode 100644 new mode 100755 index 876edabf..ddd98575 --- a/Mozu.Api/Resources/Commerce/Returns/OrderNoteResource.cs +++ b/Mozu.Api/Resources/Commerce/Returns/OrderNoteResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Returns { /// - /// Use the Return Notes resource to access and modify internal notes associated with returns. These notes can be useful to customer service representatives viewing them in . + /// /// public partial class OrderNoteResource { /// @@ -37,34 +38,11 @@ public OrderNoteResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves all internal notes associated with a return. - /// - /// Unique identifier of the return whose items you want to get. - /// - /// List{} - /// - /// - /// - /// var ordernote = new OrderNote(); - /// var orderNote = ordernote.GetReturnNotes( returnId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetReturnNotes(string returnId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.GetReturnNotesClient( returnId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves all internal notes associated with a return. + /// /// - /// Unique identifier of the return whose items you want to get. + /// /// /// List{} /// @@ -74,48 +52,23 @@ public OrderNoteResource CloneWithApiContext(Action contextModifica /// var orderNote = await ordernote.GetReturnNotesAsync( returnId); /// /// - public virtual async Task> GetReturnNotesAsync(string returnId) + public virtual async Task> GetReturnNotesAsync(string returnId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.GetReturnNotesClient( returnId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a specific internal note from a return. - /// - /// Unique identifier of a particular note to retrieve. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var ordernote = new OrderNote(); - /// var orderNote = ordernote.GetReturnNote( returnId, noteId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote GetReturnNote(string returnId, string noteId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.GetReturnNoteClient( returnId, noteId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a specific internal note from a return. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// + /// /// /// /// @@ -125,47 +78,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote GetReturnNote /// var orderNote = await ordernote.GetReturnNoteAsync( returnId, noteId, responseFields); /// /// - public virtual async Task GetReturnNoteAsync(string returnId, string noteId, string responseFields = null) + public virtual async Task GetReturnNoteAsync(string returnId, string noteId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.GetReturnNoteClient( returnId, noteId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates an internal note on a given return. This note is visible in for customer service representatives to see. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// - /// var ordernote = new OrderNote(); - /// var orderNote = ordernote.CreateReturnNote( returnNote, returnId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote CreateReturnNote(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote returnNote, string returnId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.CreateReturnNoteClient( returnNote, returnId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates an internal note on a given return. This note is visible in for customer service representatives to see. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// /// @@ -176,49 +104,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote CreateReturnN /// var orderNote = await ordernote.CreateReturnNoteAsync( returnNote, returnId, responseFields); /// /// - public virtual async Task CreateReturnNoteAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote returnNote, string returnId, string responseFields = null) + public virtual async Task CreateReturnNoteAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote returnNote, string returnId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.CreateReturnNoteClient( returnNote, returnId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates an internal note on a given return. This note is visible in for customer service representatives to see. - /// - /// Unique identifier of a particular note to retrieve. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// - /// var ordernote = new OrderNote(); - /// var orderNote = ordernote.UpdateReturnNote( returnNote, returnId, noteId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote UpdateReturnNote(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote returnNote, string returnId, string noteId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.UpdateReturnNoteClient( returnNote, returnId, noteId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates an internal note on a given return. This note is visible in for customer service representatives to see. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// + /// /// /// /// @@ -229,45 +131,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote UpdateReturnN /// var orderNote = await ordernote.UpdateReturnNoteAsync( returnNote, returnId, noteId, responseFields); /// /// - public virtual async Task UpdateReturnNoteAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote returnNote, string returnId, string noteId, string responseFields = null) + public virtual async Task UpdateReturnNoteAsync(Mozu.Api.Contracts.CommerceRuntime.Orders.OrderNote returnNote, string returnId, string noteId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.UpdateReturnNoteClient( returnNote, returnId, noteId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes an internal note from a given return. - /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var ordernote = new OrderNote(); - /// ordernote.DeleteReturnNote( returnId, noteId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteReturnNote(string returnId, string noteId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.DeleteReturnNoteClient( returnId, noteId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes an internal note from a given return. + /// /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// /// @@ -277,12 +156,12 @@ public virtual void DeleteReturnNote(string returnId, string noteId) /// await ordernote.DeleteReturnNoteAsync( returnId, noteId); /// /// - public virtual async Task DeleteReturnNoteAsync(string returnId, string noteId) + public virtual async Task DeleteReturnNoteAsync(string returnId, string noteId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.OrderNoteClient.DeleteReturnNoteClient( returnId, noteId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Returns/PackageResource.cs b/Mozu.Api/Resources/Commerce/Returns/PackageResource.cs old mode 100644 new mode 100755 index 6503c56a..5360718d --- a/Mozu.Api/Resources/Commerce/Returns/PackageResource.cs +++ b/Mozu.Api/Resources/Commerce/Returns/PackageResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Returns { @@ -37,38 +38,13 @@ public PackageResource CloneWithApiContext(Action contextModificati } - /// - /// Retrieves the package label image supplied by the carrier for a return replacement. - /// - /// Unique identifier of the package for which to retrieve the label. - /// Specifies whether to return the RMA label image as Base64-encoded PNG image instead of as a byte array encoded in the original image format. The default is . - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// var stream = package.GetPackageLabel( returnId, packageId, returnAsBase64Png); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual System.IO.Stream GetPackageLabel(string returnId, string packageId, bool? returnAsBase64Png = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.GetPackageLabelClient( returnId, packageId, returnAsBase64Png); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the package label image supplied by the carrier for a return replacement. + /// /// - /// Unique identifier of the package for which to retrieve the label. - /// Specifies whether to return the RMA label image as Base64-encoded PNG image instead of as a byte array encoded in the original image format. The default is . - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package for which to retrieve the label. + /// + /// Unique identifier of the return associated with the replacement package label to retrieve. /// /// /// @@ -78,48 +54,23 @@ public virtual System.IO.Stream GetPackageLabel(string returnId, string packageI /// var stream = await package.GetPackageLabelAsync( returnId, packageId, returnAsBase64Png); /// /// - public virtual async Task GetPackageLabelAsync(string returnId, string packageId, bool? returnAsBase64Png = null) + public virtual async Task GetPackageLabelAsync(string returnId, string packageId, bool? returnAsBase64Png = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.GetPackageLabelClient( returnId, packageId, returnAsBase64Png); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a package of return replacement items. - /// - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// var package = package.GetPackage( returnId, packageId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package GetPackage(string returnId, string packageId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.GetPackageClient( returnId, packageId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a package of return replacement items. + /// /// - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package to retrieve. + /// + /// Unique identifier of the return associated with the replacement package to retrieve. /// /// /// @@ -129,48 +80,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package GetPackage /// var package = await package.GetPackageAsync( returnId, packageId, responseFields); /// /// - public virtual async Task GetPackageAsync(string returnId, string packageId, string responseFields = null) + public virtual async Task GetPackageAsync(string returnId, string packageId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.GetPackageClient( returnId, packageId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new physical package of return replacement items. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a physical package shipped for an order. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// var package = package.CreatePackage( pkg, returnId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package CreatePackage(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string returnId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.CreatePackageClient( pkg, returnId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new physical package of return replacement items. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a physical package shipped for an order. + /// + /// Unique identifier of the return for which to create a replacement package. + /// Properties of the physical package for a return replacement. /// /// /// @@ -180,50 +106,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package CreatePack /// var package = await package.CreatePackageAsync( pkg, returnId, responseFields); /// /// - public virtual async Task CreatePackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string returnId, string responseFields = null) + public virtual async Task CreatePackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string returnId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.CreatePackageClient( pkg, returnId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of a package associated with a return replacement. - /// - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a physical package shipped for an order. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// var package = package.UpdatePackage( pkg, returnId, packageId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package UpdatePackage(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string returnId, string packageId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.UpdatePackageClient( pkg, returnId, packageId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a package associated with a return replacement. + /// /// - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Properties of a physical package shipped for an order. + /// Unique identifier of the return replacement package to update. + /// + /// Unique identifier of the return associated with the replacement package to update. + /// Properties of the return replacement package to update. /// /// /// @@ -233,45 +133,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package UpdatePack /// var package = await package.UpdatePackageAsync( pkg, returnId, packageId, responseFields); /// /// - public virtual async Task UpdatePackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string returnId, string packageId, string responseFields = null) + public virtual async Task UpdatePackageAsync(Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Package pkg, string returnId, string packageId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.UpdatePackageClient( pkg, returnId, packageId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a package associated with a return replacement. - /// - /// Unique identifier of the package for which to retrieve the label. - /// Unique identifier of the return whose items you want to get. - /// - /// - /// - /// - /// - /// var package = new Package(); - /// package.DeletePackage( returnId, packageId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeletePackage(string returnId, string packageId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.DeletePackageClient( returnId, packageId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a package associated with a return replacement. + /// /// - /// Unique identifier of the package for which to retrieve the label. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package to delete. + /// Unique identifier of the return associated with the replacement package to delete. /// /// /// @@ -281,12 +158,12 @@ public virtual void DeletePackage(string returnId, string packageId) /// await package.DeletePackageAsync( returnId, packageId); /// /// - public virtual async Task DeletePackageAsync(string returnId, string packageId) + public virtual async Task DeletePackageAsync(string returnId, string packageId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.PackageClient.DeletePackageClient( returnId, packageId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Returns/ShipmentResource.cs b/Mozu.Api/Resources/Commerce/Returns/ShipmentResource.cs old mode 100644 new mode 100755 index 118ee1d6..b30a9a25 --- a/Mozu.Api/Resources/Commerce/Returns/ShipmentResource.cs +++ b/Mozu.Api/Resources/Commerce/Returns/ShipmentResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Returns { @@ -37,38 +38,13 @@ public ShipmentResource CloneWithApiContext(Action contextModificat } - /// - /// Retrieves the details of the specified return replacement shipment. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the shipment to retrieve. - /// - /// - /// - /// - /// - /// var shipment = new Shipment(); - /// var shipment = shipment.GetShipment( returnId, shipmentId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipment(string returnId, string shipmentId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.ShipmentClient.GetShipmentClient( returnId, shipmentId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified return replacement shipment. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the shipment to retrieve. + /// + /// Unique identifier of the return associated with the replacement shipment to retrieve. + /// Unique identifier of the return replacement shipment to retrieve. /// /// /// @@ -78,46 +54,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipme /// var shipment = await shipment.GetShipmentAsync( returnId, shipmentId, responseFields); /// /// - public virtual async Task GetShipmentAsync(string returnId, string shipmentId, string responseFields = null) + public virtual async Task GetShipmentAsync(string returnId, string shipmentId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.ShipmentClient.GetShipmentClient( returnId, shipmentId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a shipment from one or more packages associated with a return replacement. - /// - /// Unique identifier of the return whose items you want to get. - /// List of unique identifiers for each package associated with this shipment. Not all packages must belong to the same shipment. - /// - /// List{} - /// - /// - /// - /// var shipment = new Shipment(); - /// var package = shipment.CreatePackageShipments( packageIds, returnId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List CreatePackageShipments(List packageIds, string returnId) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Returns.ShipmentClient.CreatePackageShipmentsClient( packageIds, returnId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a shipment from one or more packages associated with a return replacement. + /// /// - /// Unique identifier of the return whose items you want to get. - /// List of unique identifiers for each package associated with this shipment. Not all packages must belong to the same shipment. + /// Unique identifier of the return for which to create replacement package shipments. + /// List of packages in the return replacement shipment. /// /// List{} /// @@ -127,45 +79,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Fulfillment.Shipment GetShipme /// var package = await shipment.CreatePackageShipmentsAsync( packageIds, returnId); /// /// - public virtual async Task> CreatePackageShipmentsAsync(List packageIds, string returnId) + public virtual async Task> CreatePackageShipmentsAsync(List packageIds, string returnId, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Returns.ShipmentClient.CreatePackageShipmentsClient( packageIds, returnId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a shipment for a return replacement. - /// - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the shipment to retrieve. - /// - /// - /// - /// - /// - /// var shipment = new Shipment(); - /// shipment.DeleteShipment( returnId, shipmentId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteShipment(string returnId, string shipmentId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Returns.ShipmentClient.DeleteShipmentClient( returnId, shipmentId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a shipment for a return replacement. + /// /// - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the shipment to retrieve. + /// Unique identifier of the return associated with the replacement shipment to delete. + /// Unique identifier of the return replacement shipment to delete. /// /// /// @@ -175,12 +104,12 @@ public virtual void DeleteShipment(string returnId, string shipmentId) /// await shipment.DeleteShipmentAsync( returnId, shipmentId); /// /// - public virtual async Task DeleteShipmentAsync(string returnId, string shipmentId) + public virtual async Task DeleteShipmentAsync(string returnId, string shipmentId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Returns.ShipmentClient.DeleteShipmentClient( returnId, shipmentId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Settings/ApplicationResource.cs b/Mozu.Api/Resources/Commerce/Settings/ApplicationResource.cs old mode 100644 new mode 100755 index 0504968c..91c9a3cf --- a/Mozu.Api/Resources/Commerce/Settings/ApplicationResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/ApplicationResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings { @@ -37,34 +38,11 @@ public ApplicationResource CloneWithApiContext(Action contextModifi } - /// - /// Retrieve the settings of a third-party application. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var application = new Application(); - /// var application = application.ThirdPartyGetApplication( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Application.Application ThirdPartyGetApplication(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.ApplicationClient.ThirdPartyGetApplicationClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve the settings of a third-party application. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -74,46 +52,22 @@ public virtual Mozu.Api.Contracts.SiteSettings.Application.Application ThirdPart /// var application = await application.ThirdPartyGetApplicationAsync( responseFields); /// /// - public virtual async Task ThirdPartyGetApplicationAsync(string responseFields = null) + public virtual async Task ThirdPartyGetApplicationAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.ApplicationClient.ThirdPartyGetApplicationClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Initializes an application with the necessary configured settings. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of an application installed in a tenant. - /// - /// - /// - /// - /// - /// var application = new Application(); - /// var application = application.ThirdPartyUpdateApplication( application, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Application.Application ThirdPartyUpdateApplication(Mozu.Api.Contracts.SiteSettings.Application.Application application, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.ApplicationClient.ThirdPartyUpdateApplicationClient( application, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Initializes an application with the necessary configured settings. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of an application installed in a tenant. + /// + /// Properties of the application to update. /// /// /// @@ -123,12 +77,12 @@ public virtual Mozu.Api.Contracts.SiteSettings.Application.Application ThirdPart /// var application = await application.ThirdPartyUpdateApplicationAsync( application, responseFields); /// /// - public virtual async Task ThirdPartyUpdateApplicationAsync(Mozu.Api.Contracts.SiteSettings.Application.Application application, string responseFields = null) + public virtual async Task ThirdPartyUpdateApplicationAsync(Mozu.Api.Contracts.SiteSettings.Application.Application application, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.ApplicationClient.ThirdPartyUpdateApplicationClient( application, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Settings/CartSettingsResource.cs b/Mozu.Api/Resources/Commerce/Settings/CartSettingsResource.cs old mode 100644 new mode 100755 index cd8bbd14..c64813d3 --- a/Mozu.Api/Resources/Commerce/Settings/CartSettingsResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/CartSettingsResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings { /// - /// Use the cart subresource to manage settings for the cart, such as whether to include handling fees in the cost calculations. + /// /// public partial class CartSettingsResource { /// @@ -37,34 +38,11 @@ public CartSettingsResource CloneWithApiContext(Action contextModif } - /// - /// Retrieves cart settings. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var cartsettings = new CartSettings(); - /// var cartSettings = cartsettings.GetCartSettings( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Order.CartSettings GetCartSettings(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.CartSettingsClient.GetCartSettingsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves cart settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -74,45 +52,21 @@ public virtual Mozu.Api.Contracts.SiteSettings.Order.CartSettings GetCartSetting /// var cartSettings = await cartsettings.GetCartSettingsAsync( responseFields); /// /// - public virtual async Task GetCartSettingsAsync(string responseFields = null) + public virtual async Task GetCartSettingsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.CartSettingsClient.GetCartSettingsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates cart settings. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// - /// var cartsettings = new CartSettings(); - /// var cartSettings = cartsettings.CreateCartSettings( cartSettings, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Order.CartSettings CreateCartSettings(Mozu.Api.Contracts.SiteSettings.Order.CartSettings cartSettings, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.CartSettingsClient.CreateCartSettingsClient( cartSettings, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates cart settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -123,45 +77,21 @@ public virtual Mozu.Api.Contracts.SiteSettings.Order.CartSettings CreateCartSett /// var cartSettings = await cartsettings.CreateCartSettingsAsync( cartSettings, responseFields); /// /// - public virtual async Task CreateCartSettingsAsync(Mozu.Api.Contracts.SiteSettings.Order.CartSettings cartSettings, string responseFields = null) + public virtual async Task CreateCartSettingsAsync(Mozu.Api.Contracts.SiteSettings.Order.CartSettings cartSettings, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.CartSettingsClient.CreateCartSettingsClient( cartSettings, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates cart settings. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// - /// var cartsettings = new CartSettings(); - /// var cartSettings = cartsettings.UpdateCartSettings( cartSettings, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Order.CartSettings UpdateCartSettings(Mozu.Api.Contracts.SiteSettings.Order.CartSettings cartSettings, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.CartSettingsClient.UpdateCartSettingsClient( cartSettings, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates cart settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -172,12 +102,12 @@ public virtual Mozu.Api.Contracts.SiteSettings.Order.CartSettings UpdateCartSett /// var cartSettings = await cartsettings.UpdateCartSettingsAsync( cartSettings, responseFields); /// /// - public virtual async Task UpdateCartSettingsAsync(Mozu.Api.Contracts.SiteSettings.Order.CartSettings cartSettings, string responseFields = null) + public virtual async Task UpdateCartSettingsAsync(Mozu.Api.Contracts.SiteSettings.Order.CartSettings cartSettings, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.CartSettingsClient.UpdateCartSettingsClient( cartSettings, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Settings/Checkout/CustomerCheckoutSettingsResource.cs b/Mozu.Api/Resources/Commerce/Settings/Checkout/CustomerCheckoutSettingsResource.cs old mode 100644 new mode 100755 index 44a7ba70..d130f9b0 --- a/Mozu.Api/Resources/Commerce/Settings/Checkout/CustomerCheckoutSettingsResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/Checkout/CustomerCheckoutSettingsResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings.Checkout { @@ -37,34 +38,11 @@ public CustomerCheckoutSettingsResource CloneWithApiContext(Action } - /// - /// Retrieves all checkout settings defined for the site: Payment settings, such as the payment gateway ID and credentials, supported credit cards, and more; Customer Checkout settings, such as whether login is required, and any custom attributes; and Order Processing settings, such as when payment is authorized and captured, and any custom attributes. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var customercheckoutsettings = new CustomerCheckoutSettings(); - /// var customerCheckoutSettings = customercheckoutsettings.GetCustomerCheckoutSettings( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings GetCustomerCheckoutSettings(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.Checkout.CustomerCheckoutSettingsClient.GetCustomerCheckoutSettingsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves all checkout settings defined for the site: Payment settings, such as the payment gateway ID and credentials, supported credit cards, and more; Customer Checkout settings, such as whether login is required, and any custom attributes; and Order Processing settings, such as when payment is authorized and captured, and any custom attributes. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -74,46 +52,22 @@ public virtual Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings Ge /// var customerCheckoutSettings = await customercheckoutsettings.GetCustomerCheckoutSettingsAsync( responseFields); /// /// - public virtual async Task GetCustomerCheckoutSettingsAsync(string responseFields = null) + public virtual async Task GetCustomerCheckoutSettingsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.Checkout.CustomerCheckoutSettingsClient.GetCustomerCheckoutSettingsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Modifies existing site checkout settings. Modify Payment, Customer Checkout, and Order Processing settings in one PUT. - /// - /// Use this field to include those fields which are not included by default. - /// The properties of the customer checkout settings such as whether shoppers must be logged in. - /// - /// - /// - /// - /// - /// var customercheckoutsettings = new CustomerCheckoutSettings(); - /// var customerCheckoutSettings = customercheckoutsettings.UpdateCustomerCheckoutSettings( customerCheckoutSettings, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings UpdateCustomerCheckoutSettings(Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings customerCheckoutSettings, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.Checkout.CustomerCheckoutSettingsClient.UpdateCustomerCheckoutSettingsClient( customerCheckoutSettings, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Modifies existing site checkout settings. Modify Payment, Customer Checkout, and Order Processing settings in one PUT. + /// /// - /// Use this field to include those fields which are not included by default. - /// The properties of the customer checkout settings such as whether shoppers must be logged in. + /// + /// All the properties to update in the checkout settings. /// /// /// @@ -123,12 +77,12 @@ public virtual Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings Up /// var customerCheckoutSettings = await customercheckoutsettings.UpdateCustomerCheckoutSettingsAsync( customerCheckoutSettings, responseFields); /// /// - public virtual async Task UpdateCustomerCheckoutSettingsAsync(Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings customerCheckoutSettings, string responseFields = null) + public virtual async Task UpdateCustomerCheckoutSettingsAsync(Mozu.Api.Contracts.SiteSettings.Order.CustomerCheckoutSettings customerCheckoutSettings, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.Checkout.CustomerCheckoutSettingsClient.UpdateCustomerCheckoutSettingsClient( customerCheckoutSettings, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Settings/Checkout/PaymentSettingsResource.cs b/Mozu.Api/Resources/Commerce/Settings/Checkout/PaymentSettingsResource.cs old mode 100644 new mode 100755 index ed04524d..dee4642b --- a/Mozu.Api/Resources/Commerce/Settings/Checkout/PaymentSettingsResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/Checkout/PaymentSettingsResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings.Checkout { @@ -37,36 +38,12 @@ public PaymentSettingsResource CloneWithApiContext(Action contextMo } - /// - /// Retrieves the schema and definition along with the actual instance values of the third-party payment service workflow configured for the corresponding fully qualified name. - /// - /// Fully qualified name of the attribute for the third-party payment workflow. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var paymentsettings = new PaymentSettings(); - /// var externalPaymentWorkflowDefinition = paymentsettings.GetThirdPartyPaymentWorkflowWithValues( fullyQualifiedName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefinition GetThirdPartyPaymentWorkflowWithValues(string fullyQualifiedName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.Checkout.PaymentSettingsClient.GetThirdPartyPaymentWorkflowWithValuesClient( fullyQualifiedName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the schema and definition along with the actual instance values of the third-party payment service workflow configured for the corresponding fully qualified name. + /// /// - /// Fully qualified name of the attribute for the third-party payment workflow. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -76,41 +53,19 @@ public virtual Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefi /// var externalPaymentWorkflowDefinition = await paymentsettings.GetThirdPartyPaymentWorkflowWithValuesAsync( fullyQualifiedName, responseFields); /// /// - public virtual async Task GetThirdPartyPaymentWorkflowWithValuesAsync(string fullyQualifiedName, string responseFields = null) + public virtual async Task GetThirdPartyPaymentWorkflowWithValuesAsync(string fullyQualifiedName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.Checkout.PaymentSettingsClient.GetThirdPartyPaymentWorkflowWithValuesClient( fullyQualifiedName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the schema and definition of all third-party payment service workflows configured for the site. - /// - /// - /// List{} - /// - /// - /// - /// var paymentsettings = new PaymentSettings(); - /// var externalPaymentWorkflowDefinition = paymentsettings.GetThirdPartyPaymentWorkflows(); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetThirdPartyPaymentWorkflows() - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Settings.Checkout.PaymentSettingsClient.GetThirdPartyPaymentWorkflowsClient(); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the schema and definition of all third-party payment service workflows configured for the site. + /// /// /// /// List{} @@ -121,43 +76,21 @@ public virtual Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefi /// var externalPaymentWorkflowDefinition = await paymentsettings.GetThirdPartyPaymentWorkflowsAsync(); /// /// - public virtual async Task> GetThirdPartyPaymentWorkflowsAsync() + public virtual async Task> GetThirdPartyPaymentWorkflowsAsync(CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Settings.Checkout.PaymentSettingsClient.GetThirdPartyPaymentWorkflowsClient(); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a third-party payment workflow to the site. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the platform. - /// - /// Properties of an external payment processing workflow defined for the site. At this time, only PayPal Express is supported. - /// - /// - /// - /// - /// - /// var paymentsettings = new PaymentSettings(); - /// paymentsettings.AddThirdPartyPaymentWorkflow( definition); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void AddThirdPartyPaymentWorkflow(Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefinition definition) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.Checkout.PaymentSettingsClient.AddThirdPartyPaymentWorkflowClient( definition); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Adds a third-party payment workflow to the site. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the platform. + /// /// - /// Properties of an external payment processing workflow defined for the site. At this time, only PayPal Express is supported. + /// /// /// /// @@ -167,42 +100,20 @@ public virtual void AddThirdPartyPaymentWorkflow(Mozu.Api.Contracts.SiteSettings /// await paymentsettings.AddThirdPartyPaymentWorkflowAsync( definition); /// /// - public virtual async Task AddThirdPartyPaymentWorkflowAsync(Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefinition definition) + public virtual async Task AddThirdPartyPaymentWorkflowAsync(Mozu.Api.Contracts.SiteSettings.Order.ExternalPaymentWorkflowDefinition definition, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.Checkout.PaymentSettingsClient.AddThirdPartyPaymentWorkflowClient( definition); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes a third-party payment workflow. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the platform. - /// - /// Fully qualified name of the attribute for the third-party payment workflow. - /// - /// - /// - /// - /// - /// var paymentsettings = new PaymentSettings(); - /// paymentsettings.DeleteThirdPartyPaymentWorkflow( fullyQualifiedName); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteThirdPartyPaymentWorkflow(string fullyQualifiedName) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.Checkout.PaymentSettingsClient.DeleteThirdPartyPaymentWorkflowClient( fullyQualifiedName); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a third-party payment workflow. A third-party payment workflow is a definition of a process by which a third-party payment provider (such as Amazon Payments or PayPal Express) interacts with the platform. + /// /// - /// Fully qualified name of the attribute for the third-party payment workflow. + /// /// /// /// @@ -212,12 +123,12 @@ public virtual void DeleteThirdPartyPaymentWorkflow(string fullyQualifiedName) /// await paymentsettings.DeleteThirdPartyPaymentWorkflowAsync( fullyQualifiedName); /// /// - public virtual async Task DeleteThirdPartyPaymentWorkflowAsync(string fullyQualifiedName) + public virtual async Task DeleteThirdPartyPaymentWorkflowAsync(string fullyQualifiedName, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.Checkout.PaymentSettingsClient.DeleteThirdPartyPaymentWorkflowClient( fullyQualifiedName); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Settings/CheckoutSettingsResource.cs b/Mozu.Api/Resources/Commerce/Settings/CheckoutSettingsResource.cs old mode 100644 new mode 100755 index 15bb05a4..06f57272 --- a/Mozu.Api/Resources/Commerce/Settings/CheckoutSettingsResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/CheckoutSettingsResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings { @@ -37,34 +38,11 @@ public CheckoutSettingsResource CloneWithApiContext(Action contextM } - /// - /// Retrieves all checkout settings defined for the site including payment settings (payment gateway ID and credentials), shopper checkout settings (login requirement or guest mode and custom attributes), and order processing settings (when payment is authorized and captured plus any custom attributes). - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var checkoutsettings = new CheckoutSettings(); - /// var checkoutSettings = checkoutsettings.GetCheckoutSettings( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Order.CheckoutSettings GetCheckoutSettings(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.CheckoutSettingsClient.GetCheckoutSettingsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves all checkout settings defined for the site including payment settings (payment gateway ID and credentials), shopper checkout settings (login requirement or guest mode and custom attributes), and order processing settings (when payment is authorized and captured plus any custom attributes). + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -74,12 +52,12 @@ public virtual Mozu.Api.Contracts.SiteSettings.Order.CheckoutSettings GetCheckou /// var checkoutSettings = await checkoutsettings.GetCheckoutSettingsAsync( responseFields); /// /// - public virtual async Task GetCheckoutSettingsAsync(string responseFields = null) + public virtual async Task GetCheckoutSettingsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.CheckoutSettingsClient.GetCheckoutSettingsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Settings/General/CustomRouteSettingsResource.cs b/Mozu.Api/Resources/Commerce/Settings/General/CustomRouteSettingsResource.cs old mode 100644 new mode 100755 index 2810131e..818f0a3f --- a/Mozu.Api/Resources/Commerce/Settings/General/CustomRouteSettingsResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/General/CustomRouteSettingsResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings.General { /// - /// Use the Custom Routes resource to manage your custom route settings. Custom routing allows you to display SEO-friendly URLs on your site that map behind-the-scenes to conventional resources such as a product page or a search results page. With custom routing, you gain advanced control over the URL structures on your site and can more visibly highlight the products or categories your shoppers are interested in purchasing.To learn more about custom routing, refer to the [Custom Route Settings](../../../guides/settings/custom-routes.htm) topic. + /// /// public partial class CustomRouteSettingsResource { /// @@ -37,34 +38,11 @@ public CustomRouteSettingsResource CloneWithApiContext(Action conte } - /// - /// Retrieves the custom route settings configured for a site. These are the same settings configured through in the Custom Routing JSON Editor. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var customroutesettings = new CustomRouteSettings(); - /// var customRouteSettings = customroutesettings.GetCustomRouteSettings( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRouteSettings GetCustomRouteSettings(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.General.CustomRouteSettingsClient.GetCustomRouteSettingsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the custom route settings configured for a site. These are the same settings configured through in the Custom Routing JSON Editor. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -74,46 +52,22 @@ public virtual Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRou /// var customRouteSettings = await customroutesettings.GetCustomRouteSettingsAsync( responseFields); /// /// - public virtual async Task GetCustomRouteSettingsAsync(string responseFields = null) + public virtual async Task GetCustomRouteSettingsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.General.CustomRouteSettingsClient.GetCustomRouteSettingsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Create new custom route settings. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new custom route setting. - /// - /// - /// - /// - /// - /// var customroutesettings = new CustomRouteSettings(); - /// var customRouteSettings = customroutesettings.CreateCustomRouteSettings( settings, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRouteSettings CreateCustomRouteSettings(Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRouteSettings settings, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.General.CustomRouteSettingsClient.CreateCustomRouteSettingsClient( settings, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Create new custom route settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the new custom route setting. + /// + /// /// /// /// @@ -123,46 +77,22 @@ public virtual Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRou /// var customRouteSettings = await customroutesettings.CreateCustomRouteSettingsAsync( settings, responseFields); /// /// - public virtual async Task CreateCustomRouteSettingsAsync(Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRouteSettings settings, string responseFields = null) + public virtual async Task CreateCustomRouteSettingsAsync(Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRouteSettings settings, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.General.CustomRouteSettingsClient.CreateCustomRouteSettingsClient( settings, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates custom route settings. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The updated details of the custom route settings. - /// - /// - /// - /// - /// - /// var customroutesettings = new CustomRouteSettings(); - /// var customRouteSettings = customroutesettings.UpdateCustomRouteSettings( settings, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRouteSettings UpdateCustomRouteSettings(Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRouteSettings settings, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.General.CustomRouteSettingsClient.UpdateCustomRouteSettingsClient( settings, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates custom route settings. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The updated details of the custom route settings. + /// + /// /// /// /// @@ -172,40 +102,19 @@ public virtual Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRou /// var customRouteSettings = await customroutesettings.UpdateCustomRouteSettingsAsync( settings, responseFields); /// /// - public virtual async Task UpdateCustomRouteSettingsAsync(Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRouteSettings settings, string responseFields = null) + public virtual async Task UpdateCustomRouteSettingsAsync(Mozu.Api.Contracts.SiteSettings.General.General.Routing.CustomRouteSettings settings, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.General.CustomRouteSettingsClient.UpdateCustomRouteSettingsClient( settings, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes all the custom route settings for a site, returning all routes to their defaults. - /// - /// - /// - /// - /// - /// - /// var customroutesettings = new CustomRouteSettings(); - /// customroutesettings.DeleteCustomRouteSettings(); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteCustomRouteSettings() - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.General.CustomRouteSettingsClient.DeleteCustomRouteSettingsClient(); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes all the custom route settings for a site, returning all routes to their defaults. + /// /// /// /// @@ -216,12 +125,12 @@ public virtual void DeleteCustomRouteSettings() /// await customroutesettings.DeleteCustomRouteSettingsAsync(); /// /// - public virtual async Task DeleteCustomRouteSettingsAsync() + public virtual async Task DeleteCustomRouteSettingsAsync(CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.General.CustomRouteSettingsClient.DeleteCustomRouteSettingsClient(); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Settings/General/TaxableTerritoryResource.cs b/Mozu.Api/Resources/Commerce/Settings/General/TaxableTerritoryResource.cs old mode 100644 new mode 100755 index 32a30684..9279bda9 --- a/Mozu.Api/Resources/Commerce/Settings/General/TaxableTerritoryResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/General/TaxableTerritoryResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings.General { @@ -37,31 +38,9 @@ public TaxableTerritoryResource CloneWithApiContext(Action contextM } - /// - /// Retrieves a list of the taxable territories configured for the site. - /// - /// - /// List{} - /// - /// - /// - /// var taxableterritory = new TaxableTerritory(); - /// var taxableTerritory = taxableterritory.GetTaxableTerritories(); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetTaxableTerritories() - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Settings.General.TaxableTerritoryClient.GetTaxableTerritoriesClient(); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the taxable territories configured for the site. + /// /// /// /// List{} @@ -72,46 +51,22 @@ public TaxableTerritoryResource CloneWithApiContext(Action contextM /// var taxableTerritory = await taxableterritory.GetTaxableTerritoriesAsync(); /// /// - public virtual async Task> GetTaxableTerritoriesAsync() + public virtual async Task> GetTaxableTerritoriesAsync(CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Settings.General.TaxableTerritoryClient.GetTaxableTerritoriesClient(); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new territory for which to calculate sales tax. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of the territory which is subject to sales tax. - /// - /// - /// - /// - /// - /// var taxableterritory = new TaxableTerritory(); - /// var taxableTerritory = taxableterritory.AddTaxableTerritory( taxableTerritory, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.General.TaxableTerritory AddTaxableTerritory(Mozu.Api.Contracts.SiteSettings.General.TaxableTerritory taxableTerritory, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.General.TaxableTerritoryClient.AddTaxableTerritoryClient( taxableTerritory, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new territory for which to calculate sales tax. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the territory which is subject to sales tax. + /// + /// Properties of the taxable territory to create. /// /// /// @@ -121,44 +76,21 @@ public virtual Mozu.Api.Contracts.SiteSettings.General.TaxableTerritory AddTaxab /// var taxableTerritory = await taxableterritory.AddTaxableTerritoryAsync( taxableTerritory, responseFields); /// /// - public virtual async Task AddTaxableTerritoryAsync(Mozu.Api.Contracts.SiteSettings.General.TaxableTerritory taxableTerritory, string responseFields = null) + public virtual async Task AddTaxableTerritoryAsync(Mozu.Api.Contracts.SiteSettings.General.TaxableTerritory taxableTerritory, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.General.TaxableTerritoryClient.AddTaxableTerritoryClient( taxableTerritory, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more taxable territories configured for a site. - /// - /// Properties of the territory which is subject to sales tax. - /// - /// List{} - /// - /// - /// - /// var taxableterritory = new TaxableTerritory(); - /// var taxableTerritory = taxableterritory.UpdateTaxableTerritories( taxableterritories); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateTaxableTerritories(List taxableterritories) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Settings.General.TaxableTerritoryClient.UpdateTaxableTerritoriesClient( taxableterritories); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more taxable territories configured for a site. + /// /// - /// Properties of the territory which is subject to sales tax. + /// Properties of the taxable territories to update. /// /// List{} /// @@ -168,12 +100,12 @@ public virtual Mozu.Api.Contracts.SiteSettings.General.TaxableTerritory AddTaxab /// var taxableTerritory = await taxableterritory.UpdateTaxableTerritoriesAsync( taxableterritories); /// /// - public virtual async Task> UpdateTaxableTerritoriesAsync(List taxableterritories) + public virtual async Task> UpdateTaxableTerritoriesAsync(List taxableterritories, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Settings.General.TaxableTerritoryClient.UpdateTaxableTerritoriesClient( taxableterritories); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Settings/GeneralSettingsResource.cs b/Mozu.Api/Resources/Commerce/Settings/GeneralSettingsResource.cs old mode 100644 new mode 100755 index 2aa7626b..cf5e5b8a --- a/Mozu.Api/Resources/Commerce/Settings/GeneralSettingsResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/GeneralSettingsResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings { @@ -37,34 +38,11 @@ public GeneralSettingsResource CloneWithApiContext(Action contextMo } - /// - /// Retrieve a site's general global settings. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var generalsettings = new GeneralSettings(); - /// var generalSettings = generalsettings.GetGeneralSettings( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.General.GeneralSettings GetGeneralSettings(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.GeneralSettingsClient.GetGeneralSettingsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve a site's general global settings. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -74,46 +52,22 @@ public virtual Mozu.Api.Contracts.SiteSettings.General.GeneralSettings GetGenera /// var generalSettings = await generalsettings.GetGeneralSettingsAsync( responseFields); /// /// - public virtual async Task GetGeneralSettingsAsync(string responseFields = null) + public virtual async Task GetGeneralSettingsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.GeneralSettingsClient.GetGeneralSettingsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a site's general global settings. - /// - /// Use this field to include those fields which are not included by default. - /// General settings used on the storefront site. - /// - /// - /// - /// - /// - /// var generalsettings = new GeneralSettings(); - /// var generalSettings = generalsettings.UpdateGeneralSettings( generalSettings, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.General.GeneralSettings UpdateGeneralSettings(Mozu.Api.Contracts.SiteSettings.General.GeneralSettings generalSettings, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.GeneralSettingsClient.UpdateGeneralSettingsClient( generalSettings, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a site's general global settings. + /// /// - /// Use this field to include those fields which are not included by default. - /// General settings used on the storefront site. + /// + /// The properties of the site's general settings to update. /// /// /// @@ -123,12 +77,12 @@ public virtual Mozu.Api.Contracts.SiteSettings.General.GeneralSettings UpdateGen /// var generalSettings = await generalsettings.UpdateGeneralSettingsAsync( generalSettings, responseFields); /// /// - public virtual async Task UpdateGeneralSettingsAsync(Mozu.Api.Contracts.SiteSettings.General.GeneralSettings generalSettings, string responseFields = null) + public virtual async Task UpdateGeneralSettingsAsync(Mozu.Api.Contracts.SiteSettings.General.GeneralSettings generalSettings, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.GeneralSettingsClient.UpdateGeneralSettingsClient( generalSettings, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Settings/LocationUsageResource.cs b/Mozu.Api/Resources/Commerce/Settings/LocationUsageResource.cs old mode 100644 new mode 100755 index 8633a936..11216b52 --- a/Mozu.Api/Resources/Commerce/Settings/LocationUsageResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/LocationUsageResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings { @@ -37,34 +38,11 @@ public LocationUsageResource CloneWithApiContext(Action contextModi } - /// - /// Retrieves the configured site location usages for the location usage code specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var locationusage = new LocationUsage(); - /// var locationUsageCollection = locationusage.GetLocationUsages( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.LocationUsageCollection GetLocationUsages(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.LocationUsageClient.GetLocationUsagesClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the configured site location usages for the location usage code specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -74,46 +52,22 @@ public virtual Mozu.Api.Contracts.Location.LocationUsageCollection GetLocationUs /// var locationUsageCollection = await locationusage.GetLocationUsagesAsync( responseFields); /// /// - public virtual async Task GetLocationUsagesAsync(string responseFields = null) + public virtual async Task GetLocationUsagesAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.LocationUsageClient.GetLocationUsagesClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the location usages for the site specified in the request header. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var locationusage = new LocationUsage(); - /// var locationUsage = locationusage.GetLocationUsage( code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.LocationUsage GetLocationUsage(string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.LocationUsageClient.GetLocationUsageClient( code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the location usages for the site specified in the request header. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// Code that identifies the location usage type, which is "DS" for direct ship, "SP" for in-store pickup, or "storeFinder" for store finder. + /// /// /// /// @@ -123,48 +77,23 @@ public virtual Mozu.Api.Contracts.Location.LocationUsage GetLocationUsage(string /// var locationUsage = await locationusage.GetLocationUsageAsync( code, responseFields); /// /// - public virtual async Task GetLocationUsageAsync(string code, string responseFields = null) + public virtual async Task GetLocationUsageAsync(string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.LocationUsageClient.GetLocationUsageClient( code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the location usage for the site based on the location usage code specified in the request. - /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// 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. - /// - /// - /// - /// - /// - /// var locationusage = new LocationUsage(); - /// var locationUsage = locationusage.UpdateLocationUsage( usage, code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Location.LocationUsage UpdateLocationUsage(Mozu.Api.Contracts.Location.LocationUsage usage, string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.LocationUsageClient.UpdateLocationUsageClient( usage, code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the location usage for the site based on the location usage code specified in the request. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. - /// 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. + /// Code that identifies the location usage type, which is "DS" for direct ship, "SP" for in-store pickup, or "storeFinder" for store finder. + /// + /// Properties of the location usage type to update. /// /// /// @@ -174,12 +103,12 @@ public virtual Mozu.Api.Contracts.Location.LocationUsage UpdateLocationUsage(Moz /// var locationUsage = await locationusage.UpdateLocationUsageAsync( usage, code, responseFields); /// /// - public virtual async Task UpdateLocationUsageAsync(Mozu.Api.Contracts.Location.LocationUsage usage, string code, string responseFields = null) + public virtual async Task UpdateLocationUsageAsync(Mozu.Api.Contracts.Location.LocationUsage usage, string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.LocationUsageClient.UpdateLocationUsageClient( usage, code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Settings/Shipping/SiteShippingHandlingFeeResource.cs b/Mozu.Api/Resources/Commerce/Settings/Shipping/SiteShippingHandlingFeeResource.cs old mode 100644 new mode 100755 index 05a1d616..46118cba --- a/Mozu.Api/Resources/Commerce/Settings/Shipping/SiteShippingHandlingFeeResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/Shipping/SiteShippingHandlingFeeResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings.Shipping { @@ -37,34 +38,11 @@ public SiteShippingHandlingFeeResource CloneWithApiContext(Action c } - /// - /// Retrieves the details of the order handling fee configured for the site. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var siteshippinghandlingfee = new SiteShippingHandlingFee(); - /// var siteShippingHandlingFee = siteshippinghandlingfee.GetOrderHandlingFee( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee GetOrderHandlingFee(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.Shipping.SiteShippingHandlingFeeClient.GetOrderHandlingFeeClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the order handling fee configured for the site. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -74,46 +52,22 @@ public virtual Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee /// var siteShippingHandlingFee = await siteshippinghandlingfee.GetOrderHandlingFeeAsync( responseFields); /// /// - public virtual async Task GetOrderHandlingFeeAsync(string responseFields = null) + public virtual async Task GetOrderHandlingFeeAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.Shipping.SiteShippingHandlingFeeClient.GetOrderHandlingFeeClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new order handling fee for the site. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of the handling fee to apply to order shipments for the site. - /// - /// - /// - /// - /// - /// var siteshippinghandlingfee = new SiteShippingHandlingFee(); - /// var siteShippingHandlingFee = siteshippinghandlingfee.CreateOrderHandlingFee( orderHandlingFee, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee CreateOrderHandlingFee(Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee orderHandlingFee, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.Shipping.SiteShippingHandlingFeeClient.CreateOrderHandlingFeeClient( orderHandlingFee, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new order handling fee for the site. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the handling fee to apply to order shipments for the site. + /// + /// Properties of the order handling fee to assess for order shipment. /// /// /// @@ -123,46 +77,22 @@ public virtual Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee /// var siteShippingHandlingFee = await siteshippinghandlingfee.CreateOrderHandlingFeeAsync( orderHandlingFee, responseFields); /// /// - public virtual async Task CreateOrderHandlingFeeAsync(Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee orderHandlingFee, string responseFields = null) + public virtual async Task CreateOrderHandlingFeeAsync(Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee orderHandlingFee, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.Shipping.SiteShippingHandlingFeeClient.CreateOrderHandlingFeeClient( orderHandlingFee, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the order handling fee amount for the site. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of the handling fee to apply to order shipments for the site. - /// - /// - /// - /// - /// - /// var siteshippinghandlingfee = new SiteShippingHandlingFee(); - /// var siteShippingHandlingFee = siteshippinghandlingfee.UpdateOrderHandlingFee( orderHandlingFee, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee UpdateOrderHandlingFee(Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee orderHandlingFee, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.Shipping.SiteShippingHandlingFeeClient.UpdateOrderHandlingFeeClient( orderHandlingFee, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the order handling fee amount for the site. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the handling fee to apply to order shipments for the site. + /// + /// The combined price for all items in the order, including all selected options but excluding any discounts. /// /// /// @@ -172,12 +102,12 @@ public virtual Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee /// var siteShippingHandlingFee = await siteshippinghandlingfee.UpdateOrderHandlingFeeAsync( orderHandlingFee, responseFields); /// /// - public virtual async Task UpdateOrderHandlingFeeAsync(Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee orderHandlingFee, string responseFields = null) + public virtual async Task UpdateOrderHandlingFeeAsync(Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingHandlingFee orderHandlingFee, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.Shipping.SiteShippingHandlingFeeClient.UpdateOrderHandlingFeeClient( orderHandlingFee, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Settings/SiteShippingSettingsResource.cs b/Mozu.Api/Resources/Commerce/Settings/SiteShippingSettingsResource.cs old mode 100644 new mode 100755 index e2996961..22cd4a4e --- a/Mozu.Api/Resources/Commerce/Settings/SiteShippingSettingsResource.cs +++ b/Mozu.Api/Resources/Commerce/Settings/SiteShippingSettingsResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Settings { @@ -37,34 +38,11 @@ public SiteShippingSettingsResource CloneWithApiContext(Action cont } - /// - /// Retrieves a list of the shipping settings configured for a site. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var siteshippingsettings = new SiteShippingSettings(); - /// var siteShippingSettings = siteshippingsettings.GetSiteShippingSettings( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingSettings GetSiteShippingSettings(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Settings.SiteShippingSettingsClient.GetSiteShippingSettingsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the shipping settings configured for a site. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -74,12 +52,12 @@ public virtual Mozu.Api.Contracts.SiteSettings.Shipping.SiteShippingSettings Get /// var siteShippingSettings = await siteshippingsettings.GetSiteShippingSettingsAsync( responseFields); /// /// - public virtual async Task GetSiteShippingSettingsAsync(string responseFields = null) + public virtual async Task GetSiteShippingSettingsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Settings.SiteShippingSettingsClient.GetSiteShippingSettingsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Shipping/Admin/CarrierConfigurationResource.cs b/Mozu.Api/Resources/Commerce/Shipping/Admin/CarrierConfigurationResource.cs old mode 100644 new mode 100755 index ef28e3ca..927e7d97 --- a/Mozu.Api/Resources/Commerce/Shipping/Admin/CarrierConfigurationResource.cs +++ b/Mozu.Api/Resources/Commerce/Shipping/Admin/CarrierConfigurationResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Shipping.Admin { /// - /// Use the Carriers resource to configure and manage your supported shipping carrier configurations. + /// /// public partial class CarrierConfigurationResource { /// @@ -37,42 +38,15 @@ public CarrierConfigurationResource CloneWithApiContext(Action cont } - /// - /// Retrieves a list of carrier configurations and their details according to any specified facets, filter criteria, and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var carrierconfiguration = new CarrierConfiguration(); - /// var carrierConfigurationCollection = carrierconfiguration.GetConfigurations( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.CarrierConfigurationCollection GetConfigurations(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.GetConfigurationsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of carrier configurations and their details according to any specified facets, filter criteria, and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.CarrierConfigurationCollection G /// var carrierConfigurationCollection = await carrierconfiguration.GetConfigurationsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetConfigurationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetConfigurationsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.GetConfigurationsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the specified carrier configuration. - /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var carrierconfiguration = new CarrierConfiguration(); - /// var carrierConfiguration = carrierconfiguration.GetConfiguration( carrierId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration GetConfiguration(string carrierId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.GetConfigurationClient( carrierId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified carrier configuration. + /// /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -131,48 +81,23 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration GetConfigur /// var carrierConfiguration = await carrierconfiguration.GetConfigurationAsync( carrierId, responseFields); /// /// - public virtual async Task GetConfigurationAsync(string carrierId, string responseFields = null) + public virtual async Task GetConfigurationAsync(string carrierId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.GetConfigurationClient( carrierId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new carrier configuration. - /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of a carrier configured in the shipping admin. - /// - /// - /// - /// - /// - /// var carrierconfiguration = new CarrierConfiguration(); - /// var carrierConfiguration = carrierconfiguration.CreateConfiguration( carrierConfiguration, carrierId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration CreateConfiguration(Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration carrierConfiguration, string carrierId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.CreateConfigurationClient( carrierConfiguration, carrierId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new carrier configuration. + /// /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of a carrier configured in the shipping admin. + /// + /// + /// /// /// /// @@ -182,48 +107,23 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration CreateConfi /// var carrierConfiguration = await carrierconfiguration.CreateConfigurationAsync( carrierConfiguration, carrierId, responseFields); /// /// - public virtual async Task CreateConfigurationAsync(Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration carrierConfiguration, string carrierId, string responseFields = null) + public virtual async Task CreateConfigurationAsync(Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration carrierConfiguration, string carrierId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.CreateConfigurationClient( carrierConfiguration, carrierId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the details of the specified carrier configuration. - /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of a carrier configured in the shipping admin. - /// - /// - /// - /// - /// - /// var carrierconfiguration = new CarrierConfiguration(); - /// var carrierConfiguration = carrierconfiguration.UpdateConfiguration( carrierConfiguration, carrierId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration UpdateConfiguration(Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration carrierConfiguration, string carrierId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.UpdateConfigurationClient( carrierConfiguration, carrierId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of the specified carrier configuration. + /// /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Properties of a carrier configured in the shipping admin. + /// + /// + /// /// /// /// @@ -233,43 +133,21 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration UpdateConfi /// var carrierConfiguration = await carrierconfiguration.UpdateConfigurationAsync( carrierConfiguration, carrierId, responseFields); /// /// - public virtual async Task UpdateConfigurationAsync(Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration carrierConfiguration, string carrierId, string responseFields = null) + public virtual async Task UpdateConfigurationAsync(Mozu.Api.Contracts.ShippingAdmin.CarrierConfiguration carrierConfiguration, string carrierId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.UpdateConfigurationClient( carrierConfiguration, carrierId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified carrier configuration. - /// - /// The unique identifier of the carrier configuration. - /// - /// - /// - /// - /// - /// var carrierconfiguration = new CarrierConfiguration(); - /// carrierconfiguration.DeleteConfiguration( carrierId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteConfiguration(string carrierId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.DeleteConfigurationClient( carrierId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified carrier configuration. + /// /// - /// The unique identifier of the carrier configuration. + /// /// /// /// @@ -279,12 +157,12 @@ public virtual void DeleteConfiguration(string carrierId) /// await carrierconfiguration.DeleteConfigurationAsync( carrierId); /// /// - public virtual async Task DeleteConfigurationAsync(string carrierId) + public virtual async Task DeleteConfigurationAsync(string carrierId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.CarrierConfigurationClient.DeleteConfigurationClient( carrierId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/HandlingFeeRuleResource.cs b/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/HandlingFeeRuleResource.cs deleted file mode 100644 index f8b19f5e..00000000 --- a/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/HandlingFeeRuleResource.cs +++ /dev/null @@ -1,313 +0,0 @@ - -//------------------------------------------------------------------------------ -// -// This code was generated by Codezu. -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -using System; -using System.Collections.Generic; -using Mozu.Api.Security; -using System.Threading.Tasks; -using Newtonsoft.Json.Linq; - -namespace Mozu.Api.Resources.Commerce.Shipping.Admin.Profiles -{ - /// - /// Use the ProductHandlingFeeRules sub-resource to manage your product handling fee rules that are associated with a specific shipping profile. - /// - public partial class HandlingFeeRuleResource { - /// - /// - /// - private readonly IApiContext _apiContext; - - private readonly DataViewMode _dataViewMode; - - public HandlingFeeRuleResource(IApiContext apiContext) - { - _apiContext = apiContext; - _dataViewMode = DataViewMode.Live; - } - - public HandlingFeeRuleResource CloneWithApiContext(Action contextModification) - { - return new HandlingFeeRuleResource(_apiContext.CloneWith(contextModification), _dataViewMode); - } - - public HandlingFeeRuleResource(IApiContext apiContext, DataViewMode dataViewMode) - { - _apiContext = apiContext; - _dataViewMode = dataViewMode; - } - - /// - /// Retrieves the details of the specified product handling fee rule. - /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// var handlingFeeRule = handlingfeerule.GetProductHandlingFeeRule(_dataViewMode, profilecode, id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule GetProductHandlingFeeRule(string profilecode, string id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.GetProductHandlingFeeRuleClient(_dataViewMode, profilecode, id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } - - /// - /// Retrieves the details of the specified product handling fee rule. - /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// var handlingFeeRule = await handlingfeerule.GetProductHandlingFeeRuleAsync(_dataViewMode, profilecode, id, responseFields); - /// - /// - public virtual async Task GetProductHandlingFeeRuleAsync(string profilecode, string id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.GetProductHandlingFeeRuleClient(_dataViewMode, profilecode, id, responseFields); - client.WithContext(_apiContext); - response = await client.ExecuteAsync(); - return await response.ResultAsync(); - - } - - /// - /// Retrieves a list of product handling fee rules and their details. - /// - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// var handlingFeeRuleCollection = handlingfeerule.GetProductHandlingFeeRules(_dataViewMode, profilecode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRuleCollection GetProductHandlingFeeRules(string profilecode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.GetProductHandlingFeeRulesClient(_dataViewMode, profilecode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } - - /// - /// Retrieves a list of product handling fee rules and their details. - /// - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// var handlingFeeRuleCollection = await handlingfeerule.GetProductHandlingFeeRulesAsync(_dataViewMode, profilecode, responseFields); - /// - /// - public virtual async Task GetProductHandlingFeeRulesAsync(string profilecode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.GetProductHandlingFeeRulesClient(_dataViewMode, profilecode, responseFields); - client.WithContext(_apiContext); - response = await client.ExecuteAsync(); - return await response.ResultAsync(); - - } - - /// - /// Creates a new product handling fee rule. - /// - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// The details of the new product handling fee rule. - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// var handlingFeeRule = handlingfeerule.CreateProductHandlingFeeRule( rule, profilecode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule CreateProductHandlingFeeRule(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.CreateProductHandlingFeeRuleClient( rule, profilecode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } - - /// - /// Creates a new product handling fee rule. - /// - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// The details of the new product handling fee rule. - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// var handlingFeeRule = await handlingfeerule.CreateProductHandlingFeeRuleAsync( rule, profilecode, responseFields); - /// - /// - public virtual async Task CreateProductHandlingFeeRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.CreateProductHandlingFeeRuleClient( rule, profilecode, responseFields); - client.WithContext(_apiContext); - response = await client.ExecuteAsync(); - return await response.ResultAsync(); - - } - - /// - /// Updates the details of the specified product handling fee rule. - /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// The updated details of the product handling fee rule. - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// var handlingFeeRule = handlingfeerule.UpdateProductHandlingFeeRule(_dataViewMode, rule, profilecode, id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule UpdateProductHandlingFeeRule(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.UpdateProductHandlingFeeRuleClient(_dataViewMode, rule, profilecode, id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } - - /// - /// Updates the details of the specified product handling fee rule. - /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// The updated details of the product handling fee rule. - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// var handlingFeeRule = await handlingfeerule.UpdateProductHandlingFeeRuleAsync(_dataViewMode, rule, profilecode, id, responseFields); - /// - /// - public virtual async Task UpdateProductHandlingFeeRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.UpdateProductHandlingFeeRuleClient(_dataViewMode, rule, profilecode, id, responseFields); - client.WithContext(_apiContext); - response = await client.ExecuteAsync(); - return await response.ResultAsync(); - - } - - /// - /// Deletes the specified product handling fee rule. - /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// {} - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// handlingfeerule.DeleteProductHandlingFeeRule(_dataViewMode, profilecode, id); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteProductHandlingFeeRule(string profilecode, string id) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.DeleteProductHandlingFeeRuleClient(_dataViewMode, profilecode, id); - client.WithContext(_apiContext); - response = client.Execute(); - - } - - /// - /// Deletes the specified product handling fee rule. - /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// {} - /// - /// - /// - /// - /// - /// var handlingfeerule = new HandlingFeeRule(); - /// await handlingfeerule.DeleteProductHandlingFeeRuleAsync(_dataViewMode, profilecode, id); - /// - /// - public virtual async Task DeleteProductHandlingFeeRuleAsync(string profilecode, string id) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.HandlingFeeRuleClient.DeleteProductHandlingFeeRuleClient(_dataViewMode, profilecode, id); - client.WithContext(_apiContext); - response = await client.ExecuteAsync(); - - } - - - } - -} - - diff --git a/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesResource.cs b/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesResource.cs new file mode 100755 index 00000000..5f01abd9 --- /dev/null +++ b/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesResource.cs @@ -0,0 +1,179 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce.Shipping.Admin.Profiles +{ + /// + /// + /// + public partial class OrderHandlingFeeRulesResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public OrderHandlingFeeRulesResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public OrderHandlingFeeRulesResource CloneWithApiContext(Action contextModification) + { + return new OrderHandlingFeeRulesResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// var orderhandlingfeerules = new OrderHandlingFeeRules(); + /// var handlingFeeRule = await orderhandlingfeerules.GetOrderHandlingFeeRuleAsync( profilecode, id, responseFields); + /// + /// + public virtual async Task GetOrderHandlingFeeRuleAsync(string profilecode, string id, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.GetOrderHandlingFeeRuleClient( profilecode, id, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// var orderhandlingfeerules = new OrderHandlingFeeRules(); + /// var handlingFeeRuleCollection = await orderhandlingfeerules.GetOrderHandlingFeeRulesAsync( profilecode, responseFields); + /// + /// + public virtual async Task GetOrderHandlingFeeRulesAsync(string profilecode, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.GetOrderHandlingFeeRulesClient( profilecode, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// + /// var orderhandlingfeerules = new OrderHandlingFeeRules(); + /// var handlingFeeRule = await orderhandlingfeerules.CreateOrderHandlingFeeRuleAsync( rule, profilecode, responseFields); + /// + /// + public virtual async Task CreateOrderHandlingFeeRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.CreateOrderHandlingFeeRuleClient( rule, profilecode, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// + /// var orderhandlingfeerules = new OrderHandlingFeeRules(); + /// var handlingFeeRule = await orderhandlingfeerules.UpdateOrderHandlingFeeRuleAsync( rule, profilecode, id, responseFields); + /// + /// + public virtual async Task UpdateOrderHandlingFeeRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string id, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.UpdateOrderHandlingFeeRuleClient( rule, profilecode, id, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// var orderhandlingfeerules = new OrderHandlingFeeRules(); + /// await orderhandlingfeerules.DeleteOrderHandlingFeeRuleAsync( profilecode, id); + /// + /// + public virtual async Task DeleteOrderHandlingFeeRuleAsync(string profilecode, string id, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.OrderHandlingFeeRulesClient.DeleteOrderHandlingFeeRuleClient( profilecode, id); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesResource.cs b/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesResource.cs new file mode 100755 index 00000000..7df95a9b --- /dev/null +++ b/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesResource.cs @@ -0,0 +1,186 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Commerce.Shipping.Admin.Profiles +{ + /// + /// + /// + public partial class ProductHandlingFeeRulesResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + private readonly DataViewMode _dataViewMode; + + public ProductHandlingFeeRulesResource(IApiContext apiContext) + { + _apiContext = apiContext; + _dataViewMode = DataViewMode.Live; + } + + public ProductHandlingFeeRulesResource CloneWithApiContext(Action contextModification) + { + return new ProductHandlingFeeRulesResource(_apiContext.CloneWith(contextModification), _dataViewMode); + } + + public ProductHandlingFeeRulesResource(IApiContext apiContext, DataViewMode dataViewMode) + { + _apiContext = apiContext; + _dataViewMode = dataViewMode; + } + + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// var producthandlingfeerules = new ProductHandlingFeeRules(); + /// var handlingFeeRule = await producthandlingfeerules.GetProductHandlingFeeRuleAsync(_dataViewMode, profilecode, id, responseFields); + /// + /// + public virtual async Task GetProductHandlingFeeRuleAsync(string profilecode, string id, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.GetProductHandlingFeeRuleClient(_dataViewMode, profilecode, id, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// var producthandlingfeerules = new ProductHandlingFeeRules(); + /// var handlingFeeRuleCollection = await producthandlingfeerules.GetProductHandlingFeeRulesAsync(_dataViewMode, profilecode, responseFields); + /// + /// + public virtual async Task GetProductHandlingFeeRulesAsync(string profilecode, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.GetProductHandlingFeeRulesClient(_dataViewMode, profilecode, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// + /// var producthandlingfeerules = new ProductHandlingFeeRules(); + /// var handlingFeeRule = await producthandlingfeerules.CreateProductHandlingFeeRuleAsync( rule, profilecode, responseFields); + /// + /// + public virtual async Task CreateProductHandlingFeeRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.CreateProductHandlingFeeRuleClient( rule, profilecode, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// + /// var producthandlingfeerules = new ProductHandlingFeeRules(); + /// var handlingFeeRule = await producthandlingfeerules.UpdateProductHandlingFeeRuleAsync(_dataViewMode, rule, profilecode, id, responseFields); + /// + /// + public virtual async Task UpdateProductHandlingFeeRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.HandlingFeeRule rule, string profilecode, string id, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.UpdateProductHandlingFeeRuleClient(_dataViewMode, rule, profilecode, id, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// {} + /// + /// + /// + /// + /// + /// var producthandlingfeerules = new ProductHandlingFeeRules(); + /// await producthandlingfeerules.DeleteProductHandlingFeeRuleAsync(_dataViewMode, profilecode, id); + /// + /// + public virtual async Task DeleteProductHandlingFeeRuleAsync(string profilecode, string id, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ProductHandlingFeeRulesClient.DeleteProductHandlingFeeRuleClient(_dataViewMode, profilecode, id); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleResource.cs b/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleResource.cs old mode 100644 new mode 100755 index b3619bb0..c111ee6f --- a/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleResource.cs +++ b/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Shipping.Admin.Profiles { /// - /// Use the ShippingInclusionRules sub-resource to manage your shipping inclusion rules that are associated with a specific shipping profile. + /// /// public partial class ShippingInclusionRuleResource { /// @@ -37,39 +38,13 @@ public ShippingInclusionRuleResource CloneWithApiContext(Action con } - /// - /// Retrieves the details of the specified shipping inclusion rule. - /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var shippinginclusionrule = new ShippingInclusionRule(); - /// var shippingInclusionRule = shippinginclusionrule.GetShippingInclusionRule( profilecode, id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule GetShippingInclusionRule(string profilecode, string id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.GetShippingInclusionRuleClient( profilecode, id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified shipping inclusion rule. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// {} /// /// @@ -80,47 +55,22 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule Ge /// var shippingInclusionRule = await shippinginclusionrule.GetShippingInclusionRuleAsync( profilecode, id, responseFields); /// /// - public virtual async Task GetShippingInclusionRuleAsync(string profilecode, string id, string responseFields = null) + public virtual async Task GetShippingInclusionRuleAsync(string profilecode, string id, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.GetShippingInclusionRuleClient( profilecode, id, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of shipping inclusion rules and their details. - /// - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var shippinginclusionrule = new ShippingInclusionRule(); - /// var shippingInclusionRuleCollection = shippinginclusionrule.GetShippingInclusionRules( profilecode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRuleCollection GetShippingInclusionRules(string profilecode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.GetShippingInclusionRulesClient( profilecode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of shipping inclusion rules and their details. + /// /// - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} /// /// @@ -131,50 +81,24 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRuleCol /// var shippingInclusionRuleCollection = await shippinginclusionrule.GetShippingInclusionRulesAsync( profilecode, responseFields); /// /// - public virtual async Task GetShippingInclusionRulesAsync(string profilecode, string responseFields = null) + public virtual async Task GetShippingInclusionRulesAsync(string profilecode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.GetShippingInclusionRulesClient( profilecode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new shipping inclusion rule. - /// - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// The details of the new shipping inclusion rule. - /// - /// - /// - /// - /// - /// var shippinginclusionrule = new ShippingInclusionRule(); - /// var shippingInclusionRule = shippinginclusionrule.CreateShippingInclusionRule( rule, profilecode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule CreateShippingInclusionRule(Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule rule, string profilecode, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.CreateShippingInclusionRuleClient( rule, profilecode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new shipping inclusion rule. + /// /// - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} - /// The details of the new shipping inclusion rule. + /// /// /// /// @@ -184,52 +108,25 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule Cr /// var shippingInclusionRule = await shippinginclusionrule.CreateShippingInclusionRuleAsync( rule, profilecode, responseFields); /// /// - public virtual async Task CreateShippingInclusionRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule rule, string profilecode, string responseFields = null) + public virtual async Task CreateShippingInclusionRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule rule, string profilecode, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.CreateShippingInclusionRuleClient( rule, profilecode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the details of the specified shipping inclusion rule. - /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// The updated details of the shipping inclusion rule. - /// - /// - /// - /// - /// - /// var shippinginclusionrule = new ShippingInclusionRule(); - /// var shippingInclusionRule = shippinginclusionrule.UpdateShippingInclusionRule( rule, profilecode, id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule UpdateShippingInclusionRule(Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule rule, string profilecode, string id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.UpdateShippingInclusionRuleClient( rule, profilecode, id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of the specified shipping inclusion rule. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// {} - /// The updated details of the shipping inclusion rule. + /// /// /// /// @@ -239,46 +136,22 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule Up /// var shippingInclusionRule = await shippinginclusionrule.UpdateShippingInclusionRuleAsync( rule, profilecode, id, responseFields); /// /// - public virtual async Task UpdateShippingInclusionRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule rule, string profilecode, string id, string responseFields = null) + public virtual async Task UpdateShippingInclusionRuleAsync(Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingInclusionRule rule, string profilecode, string id, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.UpdateShippingInclusionRuleClient( rule, profilecode, id, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified shipping inclusion rule. - /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// {} - /// - /// - /// - /// - /// - /// var shippinginclusionrule = new ShippingInclusionRule(); - /// shippinginclusionrule.DeleteShippingInclusionRule( profilecode, id); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteShippingInclusionRule(string profilecode, string id) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.DeleteShippingInclusionRuleClient( profilecode, id); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified shipping inclusion rule. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. + /// + /// /// {} /// /// @@ -289,12 +162,12 @@ public virtual void DeleteShippingInclusionRule(string profilecode, string id) /// await shippinginclusionrule.DeleteShippingInclusionRuleAsync( profilecode, id); /// /// - public virtual async Task DeleteShippingInclusionRuleAsync(string profilecode, string id) + public virtual async Task DeleteShippingInclusionRuleAsync(string profilecode, string id, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingInclusionRuleClient.DeleteShippingInclusionRuleClient( profilecode, id); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ShippingStatesResource.cs b/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ShippingStatesResource.cs old mode 100644 new mode 100755 index b355a167..0be1402d --- a/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ShippingStatesResource.cs +++ b/Mozu.Api/Resources/Commerce/Shipping/Admin/Profiles/ShippingStatesResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Shipping.Admin.Profiles { /// - /// Use the ShippingStates sub-resource to manage the states your shipping profile supports. For example, you can specify one of your shipping profiles to only support Texas, Oklahoma, Arkansas, Louisiana, and New Mexico.Each shipping state is composed of a user-definied code and name. + /// /// public partial class ShippingStatesResource { /// @@ -37,35 +38,11 @@ public ShippingStatesResource CloneWithApiContext(Action contextMod } - /// - /// Retrieves a list of shipping states and their details. - /// - /// The unique, user-defined code of the profile with which the shipping state is associated. - /// {} - /// - /// List{} - /// - /// - /// - /// var shippingstates = new ShippingStates(); - /// var shippingStates = shippingstates.GetStates( profileCode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetStates(string profileCode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingStatesClient.GetStatesClient( profileCode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of shipping states and their details. + /// /// - /// The unique, user-defined code of the profile with which the shipping state is associated. + /// /// {} /// /// List{} @@ -76,48 +53,23 @@ public ShippingStatesResource CloneWithApiContext(Action contextMod /// var shippingStates = await shippingstates.GetStatesAsync( profileCode); /// /// - public virtual async Task> GetStatesAsync(string profileCode) + public virtual async Task> GetStatesAsync(string profileCode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingStatesClient.GetStatesClient( profileCode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the details of the shipping states. - /// - /// The unique, user-defined code of the profile with which the shipping state is associated. - /// {} - /// The updated details of the shipping states associated with the specified profilecode. - /// - /// List{} - /// - /// - /// - /// var shippingstates = new ShippingStates(); - /// var shippingStates = shippingstates.UpdateStates( states, profilecode); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List UpdateStates(List states, string profilecode) - { - MozuClient> response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingStatesClient.UpdateStatesClient( states, profilecode); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of the shipping states. + /// /// - /// The unique, user-defined code of the profile with which the shipping state is associated. + /// /// {} - /// The updated details of the shipping states associated with the specified profilecode. + /// /// /// List{} /// @@ -127,12 +79,12 @@ public ShippingStatesResource CloneWithApiContext(Action contextMod /// var shippingStates = await shippingstates.UpdateStatesAsync( states, profilecode); /// /// - public virtual async Task> UpdateStatesAsync(List states, string profilecode) + public virtual async Task> UpdateStatesAsync(List states, string profilecode, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.Profiles.ShippingStatesClient.UpdateStatesClient( states, profilecode); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/Shipping/Admin/ShippingProfileResource.cs b/Mozu.Api/Resources/Commerce/Shipping/Admin/ShippingProfileResource.cs old mode 100644 new mode 100755 index a74fe2d2..77b7423f --- a/Mozu.Api/Resources/Commerce/Shipping/Admin/ShippingProfileResource.cs +++ b/Mozu.Api/Resources/Commerce/Shipping/Admin/ShippingProfileResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Shipping.Admin { /// - /// Use the Profiles resource to manage your shipping profiles. + /// /// public partial class ShippingProfileResource { /// @@ -37,35 +38,11 @@ public ShippingProfileResource CloneWithApiContext(Action contextMo } - /// - /// Retrieves a list of shipping profiles. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var shippingprofile = new ShippingProfile(); - /// var shippingProfileCollection = shippingprofile.GetProfiles( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingProfileCollection GetProfiles(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Shipping.Admin.ShippingProfileClient.GetProfilesClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of shipping profiles. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// {} /// /// @@ -76,12 +53,12 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.Profile.ShippingProfileCollectio /// var shippingProfileCollection = await shippingprofile.GetProfilesAsync( responseFields); /// /// - public virtual async Task GetProfilesAsync(string responseFields = null) + public virtual async Task GetProfilesAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Shipping.Admin.ShippingProfileClient.GetProfilesClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Commerce/TargetRuleResource.cs b/Mozu.Api/Resources/Commerce/TargetRuleResource.cs old mode 100644 new mode 100755 index 3155b5b6..5d37c470 --- a/Mozu.Api/Resources/Commerce/TargetRuleResource.cs +++ b/Mozu.Api/Resources/Commerce/TargetRuleResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce { /// - /// Use the TargetRules resource to manage your target rules for products and zones. For example, you can set specific rules that dictate shipping options for specific products. + /// /// public partial class TargetRuleResource { /// @@ -37,43 +38,15 @@ public TargetRuleResource CloneWithApiContext(Action contextModific } - /// - /// Retrieves a list of target rules and their details according to any specified facets, filter criteria, and sort options. - /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// {} - /// - /// - /// - /// - /// - /// var targetrule = new TargetRule(); - /// var targetRuleCollection = targetrule.GetTargetRules( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.TargetRuleCollection GetTargetRules(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.TargetRuleClient.GetTargetRulesClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of target rules and their details according to any specified facets, filter criteria, and sort options. + /// /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// {} /// /// @@ -84,47 +57,22 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.TargetRuleCollection GetTargetRu /// var targetRuleCollection = await targetrule.GetTargetRulesAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetTargetRulesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetTargetRulesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.TargetRuleClient.GetTargetRulesClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the specified target rule. - /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// - /// - /// - /// - /// - /// var targetrule = new TargetRule(); - /// var targetRule = targetrule.GetTargetRule( code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.TargetRule GetTargetRule(string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.TargetRuleClient.GetTargetRuleClient( code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified target rule. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} /// /// @@ -135,48 +83,23 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.TargetRule GetTargetRule(string /// var targetRule = await targetrule.GetTargetRuleAsync( code, responseFields); /// /// - public virtual async Task GetTargetRuleAsync(string code, string responseFields = null) + public virtual async Task GetTargetRuleAsync(string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.TargetRuleClient.GetTargetRuleClient( code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new target rule. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// The details of the new target rule. - /// - /// - /// - /// - /// - /// var targetrule = new TargetRule(); - /// var targetRule = targetrule.CreateTargetRule( targetRule, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.TargetRule CreateTargetRule(Mozu.Api.Contracts.ShippingAdmin.TargetRule targetRule, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.TargetRuleClient.CreateTargetRuleClient( targetRule, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new target rule. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// {} - /// The details of the new target rule. + /// /// /// /// @@ -186,45 +109,22 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.TargetRule CreateTargetRule(Mozu /// var targetRule = await targetrule.CreateTargetRuleAsync( targetRule, responseFields); /// /// - public virtual async Task CreateTargetRuleAsync(Mozu.Api.Contracts.ShippingAdmin.TargetRule targetRule, string responseFields = null) + public virtual async Task CreateTargetRuleAsync(Mozu.Api.Contracts.ShippingAdmin.TargetRule targetRule, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.TargetRuleClient.CreateTargetRuleClient( targetRule, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Validates the details of a target rule. - /// - /// {} - /// The details of the target rule you want to validate. - /// - /// - /// - /// - /// - /// var targetrule = new TargetRule(); - /// targetrule.ValidateTargetRule( targetRule); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void ValidateTargetRule(Mozu.Api.Contracts.ShippingAdmin.TargetRule targetRule) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.TargetRuleClient.ValidateTargetRuleClient( targetRule); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Validates the details of a target rule. + /// /// /// {} - /// The details of the target rule you want to validate. + /// /// /// /// @@ -234,49 +134,23 @@ public virtual void ValidateTargetRule(Mozu.Api.Contracts.ShippingAdmin.TargetRu /// await targetrule.ValidateTargetRuleAsync( targetRule); /// /// - public virtual async Task ValidateTargetRuleAsync(Mozu.Api.Contracts.ShippingAdmin.TargetRule targetRule) + public virtual async Task ValidateTargetRuleAsync(Mozu.Api.Contracts.ShippingAdmin.TargetRule targetRule, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.TargetRuleClient.ValidateTargetRuleClient( targetRule); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates the details of the specified target rule. - /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// {} - /// The details of the updated target rule. - /// - /// - /// - /// - /// - /// var targetrule = new TargetRule(); - /// var targetRule = targetrule.UpdateTargetRule( targetRule, code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.ShippingAdmin.TargetRule UpdateTargetRule(Mozu.Api.Contracts.ShippingAdmin.TargetRule targetRule, string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.TargetRuleClient.UpdateTargetRuleClient( targetRule, code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of the specified target rule. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// {} - /// The details of the updated target rule. + /// /// /// /// @@ -286,44 +160,21 @@ public virtual Mozu.Api.Contracts.ShippingAdmin.TargetRule UpdateTargetRule(Mozu /// var targetRule = await targetrule.UpdateTargetRuleAsync( targetRule, code, responseFields); /// /// - public virtual async Task UpdateTargetRuleAsync(Mozu.Api.Contracts.ShippingAdmin.TargetRule targetRule, string code, string responseFields = null) + public virtual async Task UpdateTargetRuleAsync(Mozu.Api.Contracts.ShippingAdmin.TargetRule targetRule, string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.TargetRuleClient.UpdateTargetRuleClient( targetRule, code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified target rule. - /// - /// User-defined code that uniqely identifies the channel group. - /// {} - /// - /// - /// - /// - /// - /// var targetrule = new TargetRule(); - /// targetrule.DeleteTargetRule( code); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteTargetRule(string code) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.TargetRuleClient.DeleteTargetRuleClient( code); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified target rule. + /// /// - /// User-defined code that uniqely identifies the channel group. + /// /// {} /// /// @@ -334,12 +185,12 @@ public virtual void DeleteTargetRule(string code) /// await targetrule.DeleteTargetRuleAsync( code); /// /// - public virtual async Task DeleteTargetRuleAsync(string code) + public virtual async Task DeleteTargetRuleAsync(string code, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.TargetRuleClient.DeleteTargetRuleClient( code); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/WishlistResource.cs b/Mozu.Api/Resources/Commerce/WishlistResource.cs old mode 100644 new mode 100755 index c0d363e0..8024d44f --- a/Mozu.Api/Resources/Commerce/WishlistResource.cs +++ b/Mozu.Api/Resources/Commerce/WishlistResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce { @@ -37,46 +38,17 @@ public WishlistResource CloneWithApiContext(Action contextModificat } - /// - /// Retrieves a list of shopper wish lists according to any filter and sort criteria. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. - /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var wishlist = new Wishlist(); - /// var wishlistCollection = wishlist.GetWishlists( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistCollection GetWishlists(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.WishlistClient.GetWishlistsClient( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of shopper wish lists according to any filter and sort criteria. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// + /// + /// A list of search terms to use in the query when searching across wish list name. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// /// /// /// @@ -86,46 +58,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistCollection G /// var wishlistCollection = await wishlist.GetWishlistsAsync( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); /// /// - public virtual async Task GetWishlistsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null) + public virtual async Task GetWishlistsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.WishlistClient.GetWishlistsClient( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the shopper wish list specified in the request. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// - /// - /// - /// - /// - /// var wishlist = new Wishlist(); - /// var wishlist = wishlist.GetWishlist( wishlistId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist GetWishlist(string wishlistId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.WishlistClient.GetWishlistClient( wishlistId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the shopper wish list specified in the request. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. + /// + /// Unique identifier of the shopper wish list to retrieve. /// /// /// @@ -135,47 +83,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist GetWishlist /// var wishlist = await wishlist.GetWishlistAsync( wishlistId, responseFields); /// /// - public virtual async Task GetWishlistAsync(string wishlistId, string responseFields = null) + public virtual async Task GetWishlistAsync(string wishlistId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.WishlistClient.GetWishlistClient( wishlistId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a wish list by supplying the wish list name. - /// - /// The unique identifier of the customer account for which to retrieve wish lists. - /// Use this field to include those fields which are not included by default. - /// The name of the wish list to retrieve. - /// - /// - /// - /// - /// - /// var wishlist = new Wishlist(); - /// var wishlist = wishlist.GetWishlistByName( customerAccountId, wishlistName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist GetWishlistByName(int customerAccountId, string wishlistName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.WishlistClient.GetWishlistByNameClient( customerAccountId, wishlistName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a wish list by supplying the wish list name. + /// /// /// The unique identifier of the customer account for which to retrieve wish lists. - /// Use this field to include those fields which are not included by default. + /// /// The name of the wish list to retrieve. /// /// @@ -186,46 +109,22 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist GetWishlist /// var wishlist = await wishlist.GetWishlistByNameAsync( customerAccountId, wishlistName, responseFields); /// /// - public virtual async Task GetWishlistByNameAsync(int customerAccountId, string wishlistName, string responseFields = null) + public virtual async Task GetWishlistByNameAsync(int customerAccountId, string wishlistName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.WishlistClient.GetWishlistByNameClient( customerAccountId, wishlistName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new shopper wish list for the associated customer account. Although customer accounts are maintained at the tenant level, the system stores wish lists at the site level. Newly created wish lists do not have any items. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of a shopper wish list defined for a site, associated with a customer account. - /// - /// - /// - /// - /// - /// var wishlist = new Wishlist(); - /// var wishlist = wishlist.CreateWishlist( wishlist, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist CreateWishlist(Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist wishlist, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.WishlistClient.CreateWishlistClient( wishlist, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new shopper wish list for the associated customer account. Although customer accounts are maintained at the tenant level, the system stores wish lists at the site level. Newly created wish lists do not have any items. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of a shopper wish list defined for a site, associated with a customer account. + /// + /// Properties of the wish list to create. /// /// /// @@ -235,48 +134,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist CreateWishl /// var wishlist = await wishlist.CreateWishlistAsync( wishlist, responseFields); /// /// - public virtual async Task CreateWishlistAsync(Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist wishlist, string responseFields = null) + public virtual async Task CreateWishlistAsync(Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist wishlist, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.WishlistClient.CreateWishlistClient( wishlist, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates one or more properties of a shopper wish list defined for a customer account. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Properties of a shopper wish list defined for a site, associated with a customer account. - /// - /// - /// - /// - /// - /// var wishlist = new Wishlist(); - /// var wishlist = wishlist.UpdateWishlist( wishlist, wishlistId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist UpdateWishlist(Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist wishlist, string wishlistId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.WishlistClient.UpdateWishlistClient( wishlist, wishlistId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates one or more properties of a shopper wish list defined for a customer account. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Properties of a shopper wish list defined for a site, associated with a customer account. + /// + /// Unique identifier of the shopper wish list to update. + /// Properties of the shopper wish list to update. /// /// /// @@ -286,43 +160,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist UpdateWishl /// var wishlist = await wishlist.UpdateWishlistAsync( wishlist, wishlistId, responseFields); /// /// - public virtual async Task UpdateWishlistAsync(Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist wishlist, string wishlistId, string responseFields = null) + public virtual async Task UpdateWishlistAsync(Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist wishlist, string wishlistId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.WishlistClient.UpdateWishlistClient( wishlist, wishlistId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the shopper wish list specified in the request and all items associated with it. - /// - /// Unique identifier of the wish list. - /// - /// - /// - /// - /// - /// var wishlist = new Wishlist(); - /// wishlist.DeleteWishlist( wishlistId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteWishlist(string wishlistId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.WishlistClient.DeleteWishlistClient( wishlistId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the shopper wish list specified in the request and all items associated with it. + /// /// - /// Unique identifier of the wish list. + /// Unique identifier of the wish list to delete. /// /// /// @@ -332,12 +184,12 @@ public virtual void DeleteWishlist(string wishlistId) /// await wishlist.DeleteWishlistAsync( wishlistId); /// /// - public virtual async Task DeleteWishlistAsync(string wishlistId) + public virtual async Task DeleteWishlistAsync(string wishlistId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.WishlistClient.DeleteWishlistClient( wishlistId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Commerce/Wishlists/WishlistItemResource.cs b/Mozu.Api/Resources/Commerce/Wishlists/WishlistItemResource.cs old mode 100644 new mode 100755 index d2d4b83e..8200b040 --- a/Mozu.Api/Resources/Commerce/Wishlists/WishlistItemResource.cs +++ b/Mozu.Api/Resources/Commerce/Wishlists/WishlistItemResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Commerce.Wishlists { @@ -37,38 +38,13 @@ public WishlistItemResource CloneWithApiContext(Action contextModif } - /// - /// Retrieves the details of an item in a shopper wish list. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. - /// - /// - /// - /// - /// - /// var wishlistitem = new WishlistItem(); - /// var wishlistItem = wishlistitem.GetWishlistItem( wishlistId, wishlistItemId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem GetWishlistItem(string wishlistId, string wishlistItemId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.GetWishlistItemClient( wishlistId, wishlistItemId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of an item in a shopper wish list. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. + /// + /// Unique identifier of the wish list item to retrieve. + /// Unique identifier of the wish list associated with the item to retrieve. /// /// /// @@ -78,54 +54,26 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem GetWish /// var wishlistItem = await wishlistitem.GetWishlistItemAsync( wishlistId, wishlistItemId, responseFields); /// /// - public virtual async Task GetWishlistItemAsync(string wishlistId, string wishlistItemId, string responseFields = null) + public virtual async Task GetWishlistItemAsync(string wishlistId, string wishlistItemId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.GetWishlistItemClient( wishlistId, wishlistItemId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of items in a shopper wish list according to any specified filter and sort criteria. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// Unique identifier of the wish list. - /// - /// - /// - /// - /// - /// var wishlistitem = new WishlistItem(); - /// var wishlistItemCollection = wishlistitem.GetWishlistItems( wishlistId, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItemCollection GetWishlistItems(string wishlistId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.GetWishlistItemsClient( wishlistId, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of items in a shopper wish list according to any specified filter and sort criteria. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// Unique identifier of the wish list. + /// + /// + /// + /// + /// + /// Unique identifier of the wish list associated with the items to retrieve. /// /// /// @@ -135,56 +83,27 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItemCollecti /// var wishlistItemCollection = await wishlistitem.GetWishlistItemsAsync( wishlistId, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetWishlistItemsAsync(string wishlistId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetWishlistItemsAsync(string wishlistId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.GetWishlistItemsClient( wishlistId, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieve a list of items in a customer wish list by supplying the wish list name. - /// - /// The unique identifier of the customer account for which to retrieve wish lists. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// The name of the wish list to retrieve. - /// - /// - /// - /// - /// - /// var wishlistitem = new WishlistItem(); - /// var wishlistItemCollection = wishlistitem.GetWishlistItemsByWishlistName( customerAccountId, wishlistName, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItemCollection GetWishlistItemsByWishlistName(int customerAccountId, string wishlistName, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.GetWishlistItemsByWishlistNameClient( customerAccountId, wishlistName, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve a list of items in a customer wish list by supplying the wish list name. + /// /// - /// The unique identifier of the customer account for which to retrieve wish lists. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// The name of the wish list to retrieve. + /// The unique identifier of the customer account associated with the wish list. + /// + /// + /// + /// + /// + /// The name of the wish list that contains the items to retrieve. /// /// /// @@ -194,48 +113,23 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItemCollecti /// var wishlistItemCollection = await wishlistitem.GetWishlistItemsByWishlistNameAsync( customerAccountId, wishlistName, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetWishlistItemsByWishlistNameAsync(int customerAccountId, string wishlistName, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetWishlistItemsByWishlistNameAsync(int customerAccountId, string wishlistName, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.GetWishlistItemsByWishlistNameClient( customerAccountId, wishlistName, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a product in a site's catalog as an item in a shopper wish list. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Properties of an item in a shopper wish list. - /// - /// - /// - /// - /// - /// var wishlistitem = new WishlistItem(); - /// var wishlistItem = wishlistitem.AddItemToWishlist( wishlistItem, wishlistId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem AddItemToWishlist(Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem wishlistItem, string wishlistId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.AddItemToWishlistClient( wishlistItem, wishlistId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a product in a site's catalog as an item in a shopper wish list. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Properties of an item in a shopper wish list. + /// + /// Unique identifier of the wish list associated with the item to add. + /// Properties of the item to add to the wish list. /// /// /// @@ -245,50 +139,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem AddItem /// var wishlistItem = await wishlistitem.AddItemToWishlistAsync( wishlistItem, wishlistId, responseFields); /// /// - public virtual async Task AddItemToWishlistAsync(Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem wishlistItem, string wishlistId, string responseFields = null) + public virtual async Task AddItemToWishlistAsync(Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem wishlistItem, string wishlistId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.AddItemToWishlistClient( wishlistItem, wishlistId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the quantity of an item in a shopper wish list. - /// - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. - /// - /// - /// - /// - /// - /// var wishlistitem = new WishlistItem(); - /// var wishlistItem = wishlistitem.UpdateWishlistItemQuantity( wishlistId, wishlistItemId, quantity, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem UpdateWishlistItemQuantity(string wishlistId, string wishlistItemId, int quantity, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.UpdateWishlistItemQuantityClient( wishlistId, wishlistItemId, quantity, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the quantity of an item in a shopper wish list. + /// /// - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. + /// The quantity of the item in the wish list. + /// + /// Unique identifier of the wish list associated with the item quantity to update. + /// Unique identifier of the item in the wish list to update quantity. /// /// /// @@ -298,50 +166,24 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem UpdateW /// var wishlistItem = await wishlistitem.UpdateWishlistItemQuantityAsync( wishlistId, wishlistItemId, quantity, responseFields); /// /// - public virtual async Task UpdateWishlistItemQuantityAsync(string wishlistId, string wishlistItemId, int quantity, string responseFields = null) + public virtual async Task UpdateWishlistItemQuantityAsync(string wishlistId, string wishlistItemId, int quantity, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.UpdateWishlistItemQuantityClient( wishlistId, wishlistItemId, quantity, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the details of an item in a shopper wish list. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. - /// Properties of an item in a shopper wish list. - /// - /// - /// - /// - /// - /// var wishlistitem = new WishlistItem(); - /// var wishlistItem = wishlistitem.UpdateWishlistItem( wishlistItem, wishlistId, wishlistItemId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem UpdateWishlistItem(Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem wishlistItem, string wishlistId, string wishlistItemId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.UpdateWishlistItemClient( wishlistItem, wishlistId, wishlistItemId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the details of an item in a shopper wish list. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. - /// Properties of an item in a shopper wish list. + /// + /// Unique identifier of the wish list associated with the item to update. + /// Unique identifier of the item in the shopper wish list to update. + /// Properties of the shopper wish list item to update. /// /// /// @@ -351,44 +193,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem UpdateW /// var wishlistItem = await wishlistitem.UpdateWishlistItemAsync( wishlistItem, wishlistId, wishlistItemId, responseFields); /// /// - public virtual async Task UpdateWishlistItemAsync(Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem wishlistItem, string wishlistId, string wishlistItemId, string responseFields = null) + public virtual async Task UpdateWishlistItemAsync(Mozu.Api.Contracts.CommerceRuntime.Wishlists.WishlistItem wishlistItem, string wishlistId, string wishlistItemId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.UpdateWishlistItemClient( wishlistItem, wishlistId, wishlistItemId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes all items associated with a shopper wish list. - /// - /// Unique identifier of the wish list. - /// - /// - /// - /// - /// - /// var wishlistitem = new WishlistItem(); - /// var wishlist = wishlistitem.RemoveAllWishlistItems( wishlistId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist RemoveAllWishlistItems(string wishlistId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.RemoveAllWishlistItemsClient( wishlistId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Removes all items associated with a shopper wish list. + /// /// - /// Unique identifier of the wish list. + /// Unique identifier of the wish list associated with the items to remove. /// /// /// @@ -398,44 +217,21 @@ public virtual Mozu.Api.Contracts.CommerceRuntime.Wishlists.Wishlist RemoveAllWi /// var wishlist = await wishlistitem.RemoveAllWishlistItemsAsync( wishlistId); /// /// - public virtual async Task RemoveAllWishlistItemsAsync(string wishlistId) + public virtual async Task RemoveAllWishlistItemsAsync(string wishlistId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.RemoveAllWishlistItemsClient( wishlistId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Removes an item from the wish list specified in the request. - /// - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. - /// - /// - /// - /// - /// - /// var wishlistitem = new WishlistItem(); - /// wishlistitem.DeleteWishlistItem( wishlistId, wishlistItemId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteWishlistItem(string wishlistId, string wishlistItemId) - { - MozuClient response; - var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.DeleteWishlistItemClient( wishlistId, wishlistItemId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes an item from the wish list specified in the request. + /// /// - /// Unique identifier of the wish list. + /// Unique identifier of the wish list associated with the item to remove. /// Unique identifier of the item to remove from the shopper wish list. /// /// @@ -446,12 +242,12 @@ public virtual void DeleteWishlistItem(string wishlistId, string wishlistItemId) /// await wishlistitem.DeleteWishlistItemAsync( wishlistId, wishlistItemId); /// /// - public virtual async Task DeleteWishlistItemAsync(string wishlistId, string wishlistItemId) + public virtual async Task DeleteWishlistItemAsync(string wishlistId, string wishlistItemId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Commerce.Wishlists.WishlistItemClient.DeleteWishlistItemClient( wishlistId, wishlistItemId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Content/DocumentDraftSummaryResource.cs b/Mozu.Api/Resources/Content/DocumentDraftSummaryResource.cs old mode 100644 new mode 100755 index e8b0f4d9..cded823f --- a/Mozu.Api/Resources/Content/DocumentDraftSummaryResource.cs +++ b/Mozu.Api/Resources/Content/DocumentDraftSummaryResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content { @@ -37,40 +38,14 @@ public DocumentDraftSummaryResource CloneWithApiContext(Action cont } - /// - /// Retrieves a list of the documents currently in draft state, according to any defined filter and sort criteria. - /// - /// List of document lists that contain documents to delete. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. - /// - /// - /// - /// - /// - /// var documentdraftsummary = new DocumentDraftSummary(); - /// var documentDraftSummaryPagedCollection = documentdraftsummary.ListDocumentDraftSummaries( pageSize, startIndex, documentLists, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection ListDocumentDraftSummaries(int? pageSize = null, int? startIndex = null, string documentLists = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.ListDocumentDraftSummariesClient( pageSize, startIndex, documentLists, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the documents currently in draft state, according to any defined filter and sort criteria. + /// /// - /// List of document lists that contain documents to delete. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. + /// Lists that contain the document drafts. + /// + /// + /// /// /// /// @@ -80,42 +55,19 @@ public virtual Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection Li /// var documentDraftSummaryPagedCollection = await documentdraftsummary.ListDocumentDraftSummariesAsync( pageSize, startIndex, documentLists, responseFields); /// /// - public virtual async Task ListDocumentDraftSummariesAsync(int? pageSize = null, int? startIndex = null, string documentLists = null, string responseFields = null) + public virtual async Task ListDocumentDraftSummariesAsync(int? pageSize = null, int? startIndex = null, string documentLists = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.ListDocumentDraftSummariesClient( pageSize, startIndex, documentLists, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the drafts of the specified documents. Published documents cannot be deleted. - /// - /// List of document lists that contain documents to delete. - /// Unique identifiers of the documents to delete. - /// - /// - /// - /// - /// - /// var documentdraftsummary = new DocumentDraftSummary(); - /// documentdraftsummary.DeleteDocumentDrafts( documentIds, documentLists); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDocumentDrafts(List documentIds, string documentLists = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.DeleteDocumentDraftsClient( documentIds, documentLists); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the drafts of the specified documents. Published documents cannot be deleted. + /// /// /// List of document lists that contain documents to delete. /// Unique identifiers of the documents to delete. @@ -128,44 +80,21 @@ public virtual void DeleteDocumentDrafts(List documentIds, string docume /// await documentdraftsummary.DeleteDocumentDraftsAsync( documentIds, documentLists); /// /// - public virtual async Task DeleteDocumentDraftsAsync(List documentIds, string documentLists = null) + public virtual async Task DeleteDocumentDraftsAsync(List documentIds, string documentLists = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.DeleteDocumentDraftsClient( documentIds, documentLists); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Publish one or more document drafts to live content on the site. - /// - /// List of document lists that contain documents to delete. - /// Unique identifiers of the documents to delete. - /// - /// - /// - /// - /// - /// var documentdraftsummary = new DocumentDraftSummary(); - /// documentdraftsummary.PublishDocuments( documentIds, documentLists); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void PublishDocuments(List documentIds, string documentLists = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.PublishDocumentsClient( documentIds, documentLists); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Publish one or more document drafts to live content on the site. + /// /// - /// List of document lists that contain documents to delete. - /// Unique identifiers of the documents to delete. + /// List of document lists that contain documents to publish. + /// List of unique identifiers of the document drafts to publish. /// /// /// @@ -175,12 +104,12 @@ public virtual void PublishDocuments(List documentIds, string documentLi /// await documentdraftsummary.PublishDocumentsAsync( documentIds, documentLists); /// /// - public virtual async Task PublishDocumentsAsync(List documentIds, string documentLists = null) + public virtual async Task PublishDocumentsAsync(List documentIds, string documentLists = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentDraftSummaryClient.PublishDocumentsClient( documentIds, documentLists); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Content/DocumentListResource.cs b/Mozu.Api/Resources/Content/DocumentListResource.cs old mode 100644 new mode 100755 index f797869b..fe9b8282 --- a/Mozu.Api/Resources/Content/DocumentListResource.cs +++ b/Mozu.Api/Resources/Content/DocumentListResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content { @@ -44,37 +45,12 @@ public DocumentListResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a collection of document lists. - /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// - /// var documentlist = new DocumentList(); - /// var documentListCollection = documentlist.GetDocumentLists(_dataViewMode, pageSize, startIndex, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentListCollection GetDocumentLists(int? pageSize = null, int? startIndex = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentListClient.GetDocumentListsClient(_dataViewMode, pageSize, startIndex, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of document lists. + /// /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// @@ -85,46 +61,22 @@ public virtual Mozu.Api.Contracts.Content.DocumentListCollection GetDocumentList /// var documentListCollection = await documentlist.GetDocumentListsAsync(_dataViewMode, pageSize, startIndex, responseFields); /// /// - public virtual async Task GetDocumentListsAsync(int? pageSize = null, int? startIndex = null, string responseFields = null) + public virtual async Task GetDocumentListsAsync(int? pageSize = null, int? startIndex = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentListClient.GetDocumentListsClient(_dataViewMode, pageSize, startIndex, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieve the details of a document list by providing the list name. - /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var documentlist = new DocumentList(); - /// var documentList = documentlist.GetDocumentList(_dataViewMode, documentListName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentList GetDocumentList(string documentListName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentListClient.GetDocumentListClient(_dataViewMode, documentListName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve the details of a document list by providing the list name. + /// /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. + /// The name of the document list. + /// /// /// /// @@ -134,46 +86,22 @@ public virtual Mozu.Api.Contracts.Content.DocumentList GetDocumentList(string do /// var documentList = await documentlist.GetDocumentListAsync(_dataViewMode, documentListName, responseFields); /// /// - public virtual async Task GetDocumentListAsync(string documentListName, string responseFields = null) + public virtual async Task GetDocumentListAsync(string documentListName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentListClient.GetDocumentListClient(_dataViewMode, documentListName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new documentList - /// - /// Use this field to include those fields which are not included by default. - /// The list of document types and related properties that define content used by the content management system (CMS). - /// - /// - /// - /// - /// - /// var documentlist = new DocumentList(); - /// var documentList = documentlist.CreateDocumentList(_dataViewMode, list, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentList CreateDocumentList(Mozu.Api.Contracts.Content.DocumentList list, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentListClient.CreateDocumentListClient(_dataViewMode, list, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new documentList + /// /// - /// Use this field to include those fields which are not included by default. - /// The list of document types and related properties that define content used by the content management system (CMS). + /// + /// /// /// /// @@ -183,48 +111,23 @@ public virtual Mozu.Api.Contracts.Content.DocumentList CreateDocumentList(Mozu.A /// var documentList = await documentlist.CreateDocumentListAsync(_dataViewMode, list, responseFields); /// /// - public virtual async Task CreateDocumentListAsync(Mozu.Api.Contracts.Content.DocumentList list, string responseFields = null) + public virtual async Task CreateDocumentListAsync(Mozu.Api.Contracts.Content.DocumentList list, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentListClient.CreateDocumentListClient(_dataViewMode, list, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a `DocumentListName`. - /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// The list of document types and related properties that define content used by the content management system (CMS). - /// - /// - /// - /// - /// - /// var documentlist = new DocumentList(); - /// var documentList = documentlist.UpdateDocumentList( list, documentListName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentList UpdateDocumentList(Mozu.Api.Contracts.Content.DocumentList list, string documentListName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentListClient.UpdateDocumentListClient( list, documentListName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a `DocumentListName`. + /// /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// The list of document types and related properties that define content used by the content management system (CMS). + /// + /// + /// /// /// /// @@ -234,43 +137,21 @@ public virtual Mozu.Api.Contracts.Content.DocumentList UpdateDocumentList(Mozu.A /// var documentList = await documentlist.UpdateDocumentListAsync( list, documentListName, responseFields); /// /// - public virtual async Task UpdateDocumentListAsync(Mozu.Api.Contracts.Content.DocumentList list, string documentListName, string responseFields = null) + public virtual async Task UpdateDocumentListAsync(Mozu.Api.Contracts.Content.DocumentList list, string documentListName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentListClient.UpdateDocumentListClient( list, documentListName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified `DocumentListName`. - /// - /// Name of content documentListName to delete - /// - /// - /// - /// - /// - /// var documentlist = new DocumentList(); - /// documentlist.DeleteDocumentList( documentListName); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDocumentList(string documentListName) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentListClient.DeleteDocumentListClient( documentListName); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified `DocumentListName`. + /// /// - /// Name of content documentListName to delete + /// /// /// /// @@ -280,12 +161,12 @@ public virtual void DeleteDocumentList(string documentListName) /// await documentlist.DeleteDocumentListAsync( documentListName); /// /// - public virtual async Task DeleteDocumentListAsync(string documentListName) + public virtual async Task DeleteDocumentListAsync(string documentListName, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentListClient.DeleteDocumentListClient( documentListName); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Content/DocumentListTypeResource.cs b/Mozu.Api/Resources/Content/DocumentListTypeResource.cs old mode 100644 new mode 100755 index 65a50a54..daa38d14 --- a/Mozu.Api/Resources/Content/DocumentListTypeResource.cs +++ b/Mozu.Api/Resources/Content/DocumentListTypeResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content { /// - /// Use the Document List Types resource to manage the types of document lists in your site's document hierarchy. The type denotes a content type for that list of folders, sub-folders, and documents such as `web_pages`. + /// /// public partial class DocumentListTypeResource { /// @@ -44,38 +45,13 @@ public DocumentListTypeResource(IApiContext apiContext, DataViewMode dataViewMod _dataViewMode = dataViewMode; } - /// - /// Gets all the available documentListTypes. - /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var documentlisttype = new DocumentListType(); - /// var documentListTypeCollection = documentlisttype.GetDocumentListTypes(_dataViewMode, pageSize, startIndex, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentListTypeCollection GetDocumentListTypes(int? pageSize = null, int? startIndex = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentListTypeClient.GetDocumentListTypesClient(_dataViewMode, pageSize, startIndex, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Gets all the available documentListTypes. + /// /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// /// /// /// @@ -85,46 +61,22 @@ public virtual Mozu.Api.Contracts.Content.DocumentListTypeCollection GetDocument /// var documentListTypeCollection = await documentlisttype.GetDocumentListTypesAsync(_dataViewMode, pageSize, startIndex, responseFields); /// /// - public virtual async Task GetDocumentListTypesAsync(int? pageSize = null, int? startIndex = null, string responseFields = null) + public virtual async Task GetDocumentListTypesAsync(int? pageSize = null, int? startIndex = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentListTypeClient.GetDocumentListTypesClient(_dataViewMode, pageSize, startIndex, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Gets a documentListType. - /// - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var documentlisttype = new DocumentListType(); - /// var documentListType = documentlisttype.GetDocumentListType(_dataViewMode, documentListTypeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentListType GetDocumentListType(string documentListTypeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentListTypeClient.GetDocumentListTypeClient(_dataViewMode, documentListTypeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Gets a documentListType. + /// /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -134,46 +86,22 @@ public virtual Mozu.Api.Contracts.Content.DocumentListType GetDocumentListType(s /// var documentListType = await documentlisttype.GetDocumentListTypeAsync(_dataViewMode, documentListTypeFQN, responseFields); /// /// - public virtual async Task GetDocumentListTypeAsync(string documentListTypeFQN, string responseFields = null) + public virtual async Task GetDocumentListTypeAsync(string documentListTypeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentListTypeClient.GetDocumentListTypeClient(_dataViewMode, documentListTypeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new documentListType. - /// - /// Use this field to include those fields which are not included by default. - /// Properties for the document list type. Document lists contain documents with an associated document type, such as web pages. - /// - /// - /// - /// - /// - /// var documentlisttype = new DocumentListType(); - /// var documentListType = documentlisttype.CreateDocumentListType(_dataViewMode, list, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentListType CreateDocumentListType(Mozu.Api.Contracts.Content.DocumentListType list, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentListTypeClient.CreateDocumentListTypeClient(_dataViewMode, list, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new documentListType. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties for the document list type. Document lists contain documents with an associated document type, such as web pages. + /// + /// /// /// /// @@ -183,48 +111,23 @@ public virtual Mozu.Api.Contracts.Content.DocumentListType CreateDocumentListTyp /// var documentListType = await documentlisttype.CreateDocumentListTypeAsync(_dataViewMode, list, responseFields); /// /// - public virtual async Task CreateDocumentListTypeAsync(Mozu.Api.Contracts.Content.DocumentListType list, string responseFields = null) + public virtual async Task CreateDocumentListTypeAsync(Mozu.Api.Contracts.Content.DocumentListType list, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentListTypeClient.CreateDocumentListTypeClient(_dataViewMode, list, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a DocumentListType - /// - /// - /// Use this field to include those fields which are not included by default. - /// Properties for the document list type. Document lists contain documents with an associated document type, such as web pages. - /// - /// - /// - /// - /// - /// var documentlisttype = new DocumentListType(); - /// var documentListType = documentlisttype.UpdateDocumentListType( list, documentListTypeFQN, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentListType UpdateDocumentListType(Mozu.Api.Contracts.Content.DocumentListType list, string documentListTypeFQN, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentListTypeClient.UpdateDocumentListTypeClient( list, documentListTypeFQN, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a DocumentListType + /// /// /// - /// Use this field to include those fields which are not included by default. - /// Properties for the document list type. Document lists contain documents with an associated document type, such as web pages. + /// + /// /// /// /// @@ -234,12 +137,12 @@ public virtual Mozu.Api.Contracts.Content.DocumentListType UpdateDocumentListTyp /// var documentListType = await documentlisttype.UpdateDocumentListTypeAsync( list, documentListTypeFQN, responseFields); /// /// - public virtual async Task UpdateDocumentListTypeAsync(Mozu.Api.Contracts.Content.DocumentListType list, string documentListTypeFQN, string responseFields = null) + public virtual async Task UpdateDocumentListTypeAsync(Mozu.Api.Contracts.Content.DocumentListType list, string documentListTypeFQN, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentListTypeClient.UpdateDocumentListTypeClient( list, documentListTypeFQN, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Content/DocumentTypeResource.cs b/Mozu.Api/Resources/Content/DocumentTypeResource.cs old mode 100644 new mode 100755 index e5cd665a..cd77d9bf --- a/Mozu.Api/Resources/Content/DocumentTypeResource.cs +++ b/Mozu.Api/Resources/Content/DocumentTypeResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content { @@ -44,38 +45,13 @@ public DocumentTypeResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a paged list of the system-defined document types. - /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. - /// - /// - /// - /// - /// - /// var documenttype = new DocumentType(); - /// var documentTypeCollection = documenttype.GetDocumentTypes(_dataViewMode, pageSize, startIndex, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentTypeCollection GetDocumentTypes(int? pageSize = null, int? startIndex = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentTypeClient.GetDocumentTypesClient(_dataViewMode, pageSize, startIndex, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a paged list of the system-defined document types. + /// /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. + /// + /// + /// /// /// /// @@ -85,46 +61,22 @@ public virtual Mozu.Api.Contracts.Content.DocumentTypeCollection GetDocumentType /// var documentTypeCollection = await documenttype.GetDocumentTypesAsync(_dataViewMode, pageSize, startIndex, responseFields); /// /// - public virtual async Task GetDocumentTypesAsync(int? pageSize = null, int? startIndex = null, string responseFields = null) + public virtual async Task GetDocumentTypesAsync(int? pageSize = null, int? startIndex = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentTypeClient.GetDocumentTypesClient(_dataViewMode, pageSize, startIndex, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a system-defined document type. - /// - /// The name of the document type to retrieve. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var documenttype = new DocumentType(); - /// var documentType = documenttype.GetDocumentType(_dataViewMode, documentTypeName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentType GetDocumentType(string documentTypeName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentTypeClient.GetDocumentTypeClient(_dataViewMode, documentTypeName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a system-defined document type. + /// /// /// The name of the document type to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -134,46 +86,22 @@ public virtual Mozu.Api.Contracts.Content.DocumentType GetDocumentType(string do /// var documentType = await documenttype.GetDocumentTypeAsync(_dataViewMode, documentTypeName, responseFields); /// /// - public virtual async Task GetDocumentTypeAsync(string documentTypeName, string responseFields = null) + public virtual async Task GetDocumentTypeAsync(string documentTypeName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentTypeClient.GetDocumentTypeClient(_dataViewMode, documentTypeName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new DocumentType - /// - /// Use this field to include those fields which are not included by default. - /// The type of documents used in the CMS such as "web_page" or "template" or "image_url". - /// - /// - /// - /// - /// - /// var documenttype = new DocumentType(); - /// var documentType = documenttype.CreateDocumentType(_dataViewMode, documentType, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentType CreateDocumentType(Mozu.Api.Contracts.Content.DocumentType documentType, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentTypeClient.CreateDocumentTypeClient(_dataViewMode, documentType, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new DocumentType + /// /// - /// Use this field to include those fields which are not included by default. - /// The type of documents used in the CMS such as "web_page" or "template" or "image_url". + /// + /// /// /// /// @@ -183,48 +111,23 @@ public virtual Mozu.Api.Contracts.Content.DocumentType CreateDocumentType(Mozu.A /// var documentType = await documenttype.CreateDocumentTypeAsync(_dataViewMode, documentType, responseFields); /// /// - public virtual async Task CreateDocumentTypeAsync(Mozu.Api.Contracts.Content.DocumentType documentType, string responseFields = null) + public virtual async Task CreateDocumentTypeAsync(Mozu.Api.Contracts.Content.DocumentType documentType, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentTypeClient.CreateDocumentTypeClient(_dataViewMode, documentType, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a DocumentType - /// - /// The name of the document type to retrieve. - /// Use this field to include those fields which are not included by default. - /// The type of documents used in the CMS such as "web_page" or "template" or "image_url". - /// - /// - /// - /// - /// - /// var documenttype = new DocumentType(); - /// var documentType = documenttype.UpdateDocumentType( documentType, documentTypeName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentType UpdateDocumentType(Mozu.Api.Contracts.Content.DocumentType documentType, string documentTypeName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.DocumentTypeClient.UpdateDocumentTypeClient( documentType, documentTypeName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a DocumentType + /// /// - /// The name of the document type to retrieve. - /// Use this field to include those fields which are not included by default. - /// The type of documents used in the CMS such as "web_page" or "template" or "image_url". + /// + /// + /// /// /// /// @@ -234,12 +137,12 @@ public virtual Mozu.Api.Contracts.Content.DocumentType UpdateDocumentType(Mozu.A /// var documentType = await documenttype.UpdateDocumentTypeAsync( documentType, documentTypeName, responseFields); /// /// - public virtual async Task UpdateDocumentTypeAsync(Mozu.Api.Contracts.Content.DocumentType documentType, string documentTypeName, string responseFields = null) + public virtual async Task UpdateDocumentTypeAsync(Mozu.Api.Contracts.Content.DocumentType documentType, string documentTypeName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.DocumentTypeClient.UpdateDocumentTypeClient( documentType, documentTypeName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Content/Documentlists/DocumentResource.cs b/Mozu.Api/Resources/Content/Documentlists/DocumentResource.cs old mode 100644 new mode 100755 index 7d2e2298..5cc297d6 --- a/Mozu.Api/Resources/Content/Documentlists/DocumentResource.cs +++ b/Mozu.Api/Resources/Content/Documentlists/DocumentResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content.Documentlists { @@ -44,36 +45,12 @@ public DocumentResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieve the content associated with a document, such as a product image or PDF specifications file, by supplying the document ID. - /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// - /// - /// - /// - /// - /// var document = new Document(); - /// var stream = document.GetDocumentContent(_dataViewMode, documentListName, documentId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual System.IO.Stream GetDocumentContent(string documentListName, string documentId) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.GetDocumentContentClient(_dataViewMode, documentListName, documentId); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve the content associated with a document, such as a product image or PDF specifications file, by supplying the document ID. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Unique identifier of the document. + /// The name of the document list associated with the document. /// /// /// @@ -83,60 +60,29 @@ public virtual System.IO.Stream GetDocumentContent(string documentListName, stri /// var stream = await document.GetDocumentContentAsync(_dataViewMode, documentListName, documentId); /// /// - public virtual async Task GetDocumentContentAsync(string documentListName, string documentId) + public virtual async Task GetDocumentContentAsync(string documentListName, string documentId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.GetDocumentContentClient(_dataViewMode, documentListName, documentId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Performs transformations on a document. For example, resizing an image. - /// - /// Crops the image based on the specified coordinates. The reference point for positive coordinates is the top-left corner of the image, and the reference point for negative coordinates is the bottom-right corner of the image.Usage: Example: removes 10 pixels from all edges of the image. leaves the image uncropped. - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Specifies an exact height dimension for the image, in pixels. - /// Specifies a pixel limitation for the largest side of an image. - /// Specifies a pixel limitation for the height of the image, preserving the aspect ratio if the image needs resizing. - /// Specifies a pixel limitation for the width of the image, preserving the aspect ratio if the image needs resizing. - /// Adjusts the image compression. Accepts values from 0-100, where 100 = highest quality, least compression. - /// Specifies an exact width dimension for the image, in pixels. - /// - /// - /// - /// - /// - /// var document = new Document(); - /// var stream = document.TransformDocumentContent( documentListName, documentId, width, height, max, maxWidth, maxHeight, crop, quality); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual System.IO.Stream TransformDocumentContent(string documentListName, string documentId, int? width = null, int? height = null, int? max = null, int? maxWidth = null, int? maxHeight = null, string crop = null, int? quality = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.TransformDocumentContentClient( documentListName, documentId, width, height, max, maxWidth, maxHeight, crop, quality); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Performs transformations on a document. For example, resizing an image. + /// /// - /// Crops the image based on the specified coordinates. The reference point for positive coordinates is the top-left corner of the image, and the reference point for negative coordinates is the bottom-right corner of the image.Usage: Example: removes 10 pixels from all edges of the image. leaves the image uncropped. - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Specifies an exact height dimension for the image, in pixels. - /// Specifies a pixel limitation for the largest side of an image. - /// Specifies a pixel limitation for the height of the image, preserving the aspect ratio if the image needs resizing. - /// Specifies a pixel limitation for the width of the image, preserving the aspect ratio if the image needs resizing. - /// Adjusts the image compression. Accepts values from 0-100, where 100 = highest quality, least compression. - /// Specifies an exact width dimension for the image, in pixels. + /// + /// + /// + /// + /// + /// + /// + /// + /// /// /// /// @@ -146,50 +92,24 @@ public virtual System.IO.Stream TransformDocumentContent(string documentListName /// var stream = await document.TransformDocumentContentAsync( documentListName, documentId, width, height, max, maxWidth, maxHeight, crop, quality); /// /// - public virtual async Task TransformDocumentContentAsync(string documentListName, string documentId, int? width = null, int? height = null, int? max = null, int? maxWidth = null, int? maxHeight = null, string crop = null, int? quality = null) + public virtual async Task TransformDocumentContentAsync(string documentListName, string documentId, int? width = null, int? height = null, int? max = null, int? maxWidth = null, int? maxHeight = null, string crop = null, int? quality = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.TransformDocumentContentClient( documentListName, documentId, width, height, max, maxWidth, maxHeight, crop, quality); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a document within the specified document list. - /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Include inactive content. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var document = new Document(); - /// var document = document.GetDocument(_dataViewMode, documentListName, documentId, includeInactive, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.Document GetDocument(string documentListName, string documentId, bool? includeInactive = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.GetDocumentClient(_dataViewMode, documentListName, documentId, includeInactive, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a document within the specified document list. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Include inactive content. - /// Use this field to include those fields which are not included by default. + /// Identifier of the document being retrieved. + /// The name of the document list associated with the document to retrieve. + /// + /// /// /// /// @@ -199,56 +119,27 @@ public virtual Mozu.Api.Contracts.Content.Document GetDocument(string documentLi /// var document = await document.GetDocumentAsync(_dataViewMode, documentListName, documentId, includeInactive, responseFields); /// /// - public virtual async Task GetDocumentAsync(string documentListName, string documentId, bool? includeInactive = null, string responseFields = null) + public virtual async Task GetDocumentAsync(string documentListName, string documentId, bool? includeInactive = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.GetDocumentClient(_dataViewMode, documentListName, documentId, includeInactive, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of documents according to any filter and sort criteria. - /// - /// Name of content documentListName to delete - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Include inactive content. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// - /// - /// - /// - /// - /// var document = new Document(); - /// var documentCollection = document.GetDocuments(_dataViewMode, documentListName, filter, sortBy, pageSize, startIndex, includeInactive, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentCollection GetDocuments(string documentListName, string filter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, bool? includeInactive = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.GetDocumentsClient(_dataViewMode, documentListName, filter, sortBy, pageSize, startIndex, includeInactive, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of documents according to any filter and sort criteria. + /// /// - /// Name of content documentListName to delete - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Include inactive content. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// The name of the document list. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter a document's search results by any of its properties, including its name or folder path. 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=Name+sw+Events" + /// + /// + /// + /// + /// /// /// /// @@ -258,48 +149,23 @@ public virtual Mozu.Api.Contracts.Content.DocumentCollection GetDocuments(string /// var documentCollection = await document.GetDocumentsAsync(_dataViewMode, documentListName, filter, sortBy, pageSize, startIndex, includeInactive, responseFields); /// /// - public virtual async Task GetDocumentsAsync(string documentListName, string filter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, bool? includeInactive = null, string responseFields = null) + public virtual async Task GetDocumentsAsync(string documentListName, string filter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, bool? includeInactive = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.GetDocumentsClient(_dataViewMode, documentListName, filter, sortBy, pageSize, startIndex, includeInactive, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new document in an defined document list. - /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// The document properties that define the content used by the content management system (CMS). - /// - /// - /// - /// - /// - /// var document = new Document(); - /// var document = document.CreateDocument(_dataViewMode, document, documentListName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.Document CreateDocument(Mozu.Api.Contracts.Content.Document document, string documentListName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.CreateDocumentClient(_dataViewMode, document, documentListName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new document in an defined document list. + /// /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// The document properties that define the content used by the content management system (CMS). + /// The descriptive alphanumeric document list name being created. + /// + /// The descriptive name of the newly created document. /// /// /// @@ -309,47 +175,23 @@ public virtual Mozu.Api.Contracts.Content.Document CreateDocument(Mozu.Api.Contr /// var document = await document.CreateDocumentAsync(_dataViewMode, document, documentListName, responseFields); /// /// - public virtual async Task CreateDocumentAsync(Mozu.Api.Contracts.Content.Document document, string documentListName, string responseFields = null) + public virtual async Task CreateDocumentAsync(Mozu.Api.Contracts.Content.Document document, string documentListName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.CreateDocumentClient(_dataViewMode, document, documentListName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the binary data or content associated with a document, such as a product image or PDF specifications file, by supplying the document ID. - /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Data stream that delivers information. Used to input and output data. - /// - /// - /// - /// - /// - /// var document = new Document(); - /// document.UpdateDocumentContent( stream, documentListName, documentId, contentType); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void UpdateDocumentContent(System.IO.Stream stream, string documentListName, string documentId, String contentType= null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.UpdateDocumentContentClient( stream, documentListName, documentId, contentType); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Updates the binary data or content associated with a document, such as a product image or PDF specifications file, by supplying the document ID. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Data stream that delivers information. Used to input and output data. + /// Unique identifier of the document. + /// The name of the document list associated with the document. + /// Input output stream that delivers information. /// /// /// @@ -359,49 +201,23 @@ public virtual void UpdateDocumentContent(System.IO.Stream stream, string docume /// await document.UpdateDocumentContentAsync( stream, documentListName, documentId, contentType); /// /// - public virtual async Task UpdateDocumentContentAsync(System.IO.Stream stream, string documentListName, string documentId, String contentType= null) + public virtual async Task UpdateDocumentContentAsync(System.IO.Stream stream, string documentListName, string documentId, String contentType= null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.UpdateDocumentContentClient( stream, documentListName, documentId, contentType); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates a document in a document list. - /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// The document properties that define the content used by the content management system (CMS). - /// - /// - /// - /// - /// - /// var document = new Document(); - /// var document = document.UpdateDocument( document, documentListName, documentId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.Document UpdateDocument(Mozu.Api.Contracts.Content.Document document, string documentListName, string documentId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.UpdateDocumentClient( document, documentListName, documentId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a document in a document list. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. - /// The document properties that define the content used by the content management system (CMS). + /// Unique identifier of the document to update. + /// Name of the document list associated with the document. + /// + /// Properties of the document to update. /// /// /// @@ -411,45 +227,22 @@ public virtual Mozu.Api.Contracts.Content.Document UpdateDocument(Mozu.Api.Contr /// var document = await document.UpdateDocumentAsync( document, documentListName, documentId, responseFields); /// /// - public virtual async Task UpdateDocumentAsync(Mozu.Api.Contracts.Content.Document document, string documentListName, string documentId, string responseFields = null) + public virtual async Task UpdateDocumentAsync(Mozu.Api.Contracts.Content.Document document, string documentListName, string documentId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.UpdateDocumentClient( document, documentListName, documentId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes a specific document based on the specified document ID. - /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// - /// - /// - /// - /// - /// var document = new Document(); - /// document.DeleteDocument( documentListName, documentId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDocument(string documentListName, string documentId) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.DeleteDocumentClient( documentListName, documentId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes a specific document based on the specified document ID. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Identifier of the document being deleted. + /// The name of the document list associated with the document list being deleted. /// /// /// @@ -459,44 +252,21 @@ public virtual void DeleteDocument(string documentListName, string documentId) /// await document.DeleteDocumentAsync( documentListName, documentId); /// /// - public virtual async Task DeleteDocumentAsync(string documentListName, string documentId) + public virtual async Task DeleteDocumentAsync(string documentListName, string documentId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.DeleteDocumentClient( documentListName, documentId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the content associated with a document, such as a product image or PDF specification, by supplying the document ID. - /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// - /// - /// - /// - /// - /// var document = new Document(); - /// document.DeleteDocumentContent( documentListName, documentId); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDocumentContent(string documentListName, string documentId) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.DeleteDocumentContentClient( documentListName, documentId); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the content associated with a document, such as a product image or PDF specification, by supplying the document ID. + /// /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Unique identifier of the document. + /// The name of the document list associated with the document. /// /// /// @@ -506,12 +276,12 @@ public virtual void DeleteDocumentContent(string documentListName, string docume /// await document.DeleteDocumentContentAsync( documentListName, documentId); /// /// - public virtual async Task DeleteDocumentContentAsync(string documentListName, string documentId) + public virtual async Task DeleteDocumentContentAsync(string documentListName, string documentId, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentClient.DeleteDocumentContentClient( documentListName, documentId); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Content/Documentlists/DocumentTreeResource.cs b/Mozu.Api/Resources/Content/Documentlists/DocumentTreeResource.cs old mode 100644 new mode 100755 index e9e071cc..0d57d411 --- a/Mozu.Api/Resources/Content/Documentlists/DocumentTreeResource.cs +++ b/Mozu.Api/Resources/Content/Documentlists/DocumentTreeResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content.Documentlists { @@ -44,36 +45,12 @@ public DocumentTreeResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieve the content associated with the document, such as a product image or PDF specifications file. - /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// - /// - /// - /// - /// - /// var documenttree = new DocumentTree(); - /// var stream = documenttree.GetTreeDocumentContent(_dataViewMode, documentListName, documentName); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual System.IO.Stream GetTreeDocumentContent(string documentListName, string documentName) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.GetTreeDocumentContentClient(_dataViewMode, documentListName, documentName); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve the content associated with the document, such as a product image or PDF specifications file. + /// /// - /// Name of content documentListName to delete - /// The name of the document in the site. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. /// /// /// @@ -83,60 +60,29 @@ public virtual System.IO.Stream GetTreeDocumentContent(string documentListName, /// var stream = await documenttree.GetTreeDocumentContentAsync(_dataViewMode, documentListName, documentName); /// /// - public virtual async Task GetTreeDocumentContentAsync(string documentListName, string documentName) + public virtual async Task GetTreeDocumentContentAsync(string documentListName, string documentName, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.GetTreeDocumentContentClient(_dataViewMode, documentListName, documentName); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Performs transformations on a document. For example, resizing an image. - /// - /// Crops the image based on the specified coordinates. The reference point for positive coordinates is the top-left corner of the image, and the reference point for negative coordinates is the bottom-right corner of the image.Usage: Example: removes 10 pixels from all edges of the image. leaves the image uncropped. - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Specifies an exact height dimension for the image, in pixels. - /// Specifies a pixel limitation for the largest side of an image. - /// Specifies a pixel limitation for the height of the image, preserving the aspect ratio if the image needs resizing. - /// Specifies a pixel limitation for the width of the image, preserving the aspect ratio if the image needs resizing. - /// Adjusts the image compression. Accepts values from 0-100, where 100 = highest quality, least compression. - /// Specifies an exact width dimension for the image, in pixels. - /// - /// - /// - /// - /// - /// var documenttree = new DocumentTree(); - /// var stream = documenttree.TransformTreeDocumentContent( documentListName, documentName, width, height, max, maxWidth, maxHeight, crop, quality); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual System.IO.Stream TransformTreeDocumentContent(string documentListName, string documentName, int? width = null, int? height = null, int? max = null, int? maxWidth = null, int? maxHeight = null, string crop = null, int? quality = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.TransformTreeDocumentContentClient( documentListName, documentName, width, height, max, maxWidth, maxHeight, crop, quality); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Performs transformations on a document. For example, resizing an image. + /// /// - /// Crops the image based on the specified coordinates. The reference point for positive coordinates is the top-left corner of the image, and the reference point for negative coordinates is the bottom-right corner of the image.Usage: Example: removes 10 pixels from all edges of the image. leaves the image uncropped. - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Specifies an exact height dimension for the image, in pixels. - /// Specifies a pixel limitation for the largest side of an image. - /// Specifies a pixel limitation for the height of the image, preserving the aspect ratio if the image needs resizing. - /// Specifies a pixel limitation for the width of the image, preserving the aspect ratio if the image needs resizing. - /// Adjusts the image compression. Accepts values from 0-100, where 100 = highest quality, least compression. - /// Specifies an exact width dimension for the image, in pixels. + /// + /// + /// + /// + /// + /// + /// + /// + /// /// /// /// @@ -146,50 +92,24 @@ public virtual System.IO.Stream TransformTreeDocumentContent(string documentList /// var stream = await documenttree.TransformTreeDocumentContentAsync( documentListName, documentName, width, height, max, maxWidth, maxHeight, crop, quality); /// /// - public virtual async Task TransformTreeDocumentContentAsync(string documentListName, string documentName, int? width = null, int? height = null, int? max = null, int? maxWidth = null, int? maxHeight = null, string crop = null, int? quality = null) + public virtual async Task TransformTreeDocumentContentAsync(string documentListName, string documentName, int? width = null, int? height = null, int? max = null, int? maxWidth = null, int? maxHeight = null, string crop = null, int? quality = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.TransformTreeDocumentContentClient( documentListName, documentName, width, height, max, maxWidth, maxHeight, crop, quality); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a document based on its document list and folder path in the document hierarchy. - /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Include inactive content. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var documenttree = new DocumentTree(); - /// var document = documenttree.GetTreeDocument(_dataViewMode, documentListName, documentName, includeInactive, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.Document GetTreeDocument(string documentListName, string documentName, bool? includeInactive = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.GetTreeDocumentClient(_dataViewMode, documentListName, documentName, includeInactive, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a document based on its document list and folder path in the document hierarchy. + /// /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Include inactive content. - /// Use this field to include those fields which are not included by default. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. + /// + /// /// /// /// @@ -199,47 +119,23 @@ public virtual Mozu.Api.Contracts.Content.Document GetTreeDocument(string docume /// var document = await documenttree.GetTreeDocumentAsync(_dataViewMode, documentListName, documentName, includeInactive, responseFields); /// /// - public virtual async Task GetTreeDocumentAsync(string documentListName, string documentName, bool? includeInactive = null, string responseFields = null) + public virtual async Task GetTreeDocumentAsync(string documentListName, string documentName, bool? includeInactive = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.GetTreeDocumentClient(_dataViewMode, documentListName, documentName, includeInactive, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the binary data or content associated with a document, such as a product image or PDF specifications file, by supplying the document name. - /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Data stream that delivers information. Used to input and output data. - /// - /// - /// - /// - /// - /// var documenttree = new DocumentTree(); - /// documenttree.UpdateTreeDocumentContent( stream, documentListName, documentName, contentType); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void UpdateTreeDocumentContent(System.IO.Stream stream, string documentListName, string documentName, String contentType= null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.UpdateTreeDocumentContentClient( stream, documentListName, documentName, contentType); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Updates the binary data or content associated with a document, such as a product image or PDF specifications file, by supplying the document name. + /// /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Data stream that delivers information. Used to input and output data. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. + /// Input output stream that delivers information. /// /// /// @@ -249,46 +145,22 @@ public virtual void UpdateTreeDocumentContent(System.IO.Stream stream, string do /// await documenttree.UpdateTreeDocumentContentAsync( stream, documentListName, documentName, contentType); /// /// - public virtual async Task UpdateTreeDocumentContentAsync(System.IO.Stream stream, string documentListName, string documentName, String contentType= null) + public virtual async Task UpdateTreeDocumentContentAsync(System.IO.Stream stream, string documentListName, string documentName, String contentType= null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.UpdateTreeDocumentContentClient( stream, documentListName, documentName, contentType); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Deletes the content associated with a document, such as a product image or PDF specifications file. - /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Data stream that delivers information. Used to input and output data. - /// - /// - /// - /// - /// - /// var documenttree = new DocumentTree(); - /// documenttree.DeleteTreeDocumentContent( stream, documentListName, documentName, contentType); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteTreeDocumentContent(System.IO.Stream stream, string documentListName, string documentName, String contentType= null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.DeleteTreeDocumentContentClient( stream, documentListName, documentName, contentType); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the content associated with a document, such as a product image or PDF specifications file. + /// /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Data stream that delivers information. Used to input and output data. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. + /// Input output stream that delivers information. /// /// /// @@ -298,12 +170,12 @@ public virtual void DeleteTreeDocumentContent(System.IO.Stream stream, string do /// await documenttree.DeleteTreeDocumentContentAsync( stream, documentListName, documentName, contentType); /// /// - public virtual async Task DeleteTreeDocumentContentAsync(System.IO.Stream stream, string documentListName, string documentName, String contentType= null) + public virtual async Task DeleteTreeDocumentContentAsync(System.IO.Stream stream, string documentListName, string documentName, String contentType= null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.DocumentTreeClient.DeleteTreeDocumentContentClient( stream, documentListName, documentName, contentType); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Content/Documentlists/FacetResource.cs b/Mozu.Api/Resources/Content/Documentlists/FacetResource.cs old mode 100644 new mode 100755 index 68f913cb..dc6540fe --- a/Mozu.Api/Resources/Content/Documentlists/FacetResource.cs +++ b/Mozu.Api/Resources/Content/Documentlists/FacetResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content.Documentlists { @@ -37,35 +38,11 @@ public FacetResource CloneWithApiContext(Action contextModification } - /// - /// Retrieves the properties of facets that aid in indexing and searching. - /// - /// Name of content documentListName to delete - /// The property name associated with the facets to retrieve. - /// - /// List{} - /// - /// - /// - /// var facet = new Facet(); - /// var facet = facet.GetFacets( documentListName, propertyName); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual List GetFacets(string documentListName, string propertyName) - { - MozuClient> response; - var client = Mozu.Api.Clients.Content.Documentlists.FacetClient.GetFacetsClient( documentListName, propertyName); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the properties of facets that aid in indexing and searching. + /// /// - /// Name of content documentListName to delete + /// The document list associated with the facets to retrieve. /// The property name associated with the facets to retrieve. /// /// List{} @@ -76,12 +53,12 @@ public FacetResource CloneWithApiContext(Action contextModification /// var facet = await facet.GetFacetsAsync( documentListName, propertyName); /// /// - public virtual async Task> GetFacetsAsync(string documentListName, string propertyName) + public virtual async Task> GetFacetsAsync(string documentListName, string propertyName, CancellationToken ct = default(CancellationToken)) { MozuClient> response; var client = Mozu.Api.Clients.Content.Documentlists.FacetClient.GetFacetsClient( documentListName, propertyName); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Content/Documentlists/ViewResource.cs b/Mozu.Api/Resources/Content/Documentlists/ViewResource.cs old mode 100644 new mode 100755 index a4e7fd13..194818a0 --- a/Mozu.Api/Resources/Content/Documentlists/ViewResource.cs +++ b/Mozu.Api/Resources/Content/Documentlists/ViewResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content.Documentlists { /// - /// Properties and content for views within a site/tenant. Views provide the schema, formatting, and associated content and entities for displaying content within a site/tenant. + /// /// public partial class ViewResource { /// @@ -37,48 +38,18 @@ public ViewResource CloneWithApiContext(Action contextModification) } - /// - /// Retrieves a collection of documents associated with a view. - /// - /// Name of content documentListName to delete - /// 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" - /// Include inactive content. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// - /// - /// - /// - /// - /// var view = new View(); - /// var documentCollection = view.GetViewDocuments( documentListName, viewName, filter, sortBy, pageSize, startIndex, includeInactive, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentCollection GetViewDocuments(string documentListName, string viewName, string filter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, bool? includeInactive = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.Documentlists.ViewClient.GetViewDocumentsClient( documentListName, viewName, filter, sortBy, pageSize, startIndex, includeInactive, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of documents associated with a view. + /// /// - /// Name of content documentListName to delete - /// 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" - /// Include inactive content. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// + /// + /// + /// + /// /// /// /// @@ -88,12 +59,12 @@ public virtual Mozu.Api.Contracts.Content.DocumentCollection GetViewDocuments(st /// var documentCollection = await view.GetViewDocumentsAsync( documentListName, viewName, filter, sortBy, pageSize, startIndex, includeInactive, responseFields); /// /// - public virtual async Task GetViewDocumentsAsync(string documentListName, string viewName, string filter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, bool? includeInactive = null, string responseFields = null) + public virtual async Task GetViewDocumentsAsync(string documentListName, string viewName, string filter = null, string sortBy = null, int? pageSize = null, int? startIndex = null, bool? includeInactive = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.Documentlists.ViewClient.GetViewDocumentsClient( documentListName, viewName, filter, sortBy, pageSize, startIndex, includeInactive, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Content/PropertyTypeResource.cs b/Mozu.Api/Resources/Content/PropertyTypeResource.cs old mode 100644 new mode 100755 index 14990528..e2989874 --- a/Mozu.Api/Resources/Content/PropertyTypeResource.cs +++ b/Mozu.Api/Resources/Content/PropertyTypeResource.cs @@ -13,6 +13,7 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content { @@ -44,38 +45,13 @@ public PropertyTypeResource(IApiContext apiContext, DataViewMode dataViewMode) _dataViewMode = dataViewMode; } - /// - /// Retrieves a list of the content property types. - /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. - /// - /// - /// - /// - /// - /// var propertytype = new PropertyType(); - /// var propertyTypeCollection = propertytype.GetPropertyTypes(_dataViewMode, pageSize, startIndex, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.PropertyTypeCollection GetPropertyTypes(int? pageSize = null, int? startIndex = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.PropertyTypeClient.GetPropertyTypesClient(_dataViewMode, pageSize, startIndex, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the content property types. + /// /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. + /// + /// + /// /// /// /// @@ -85,46 +61,22 @@ public virtual Mozu.Api.Contracts.Content.PropertyTypeCollection GetPropertyType /// var propertyTypeCollection = await propertytype.GetPropertyTypesAsync(_dataViewMode, pageSize, startIndex, responseFields); /// /// - public virtual async Task GetPropertyTypesAsync(int? pageSize = null, int? startIndex = null, string responseFields = null) + public virtual async Task GetPropertyTypesAsync(int? pageSize = null, int? startIndex = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.PropertyTypeClient.GetPropertyTypesClient(_dataViewMode, pageSize, startIndex, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the content property type. - /// - /// The name of the property type. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var propertytype = new PropertyType(); - /// var propertyType = propertytype.GetPropertyType(_dataViewMode, propertyTypeName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.PropertyType GetPropertyType(string propertyTypeName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.PropertyTypeClient.GetPropertyTypeClient(_dataViewMode, propertyTypeName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the content property type. + /// /// - /// The name of the property type. - /// Use this field to include those fields which are not included by default. + /// The name of the content property type. + /// /// /// /// @@ -134,46 +86,22 @@ public virtual Mozu.Api.Contracts.Content.PropertyType GetPropertyType(string pr /// var propertyType = await propertytype.GetPropertyTypeAsync(_dataViewMode, propertyTypeName, responseFields); /// /// - public virtual async Task GetPropertyTypeAsync(string propertyTypeName, string responseFields = null) + public virtual async Task GetPropertyTypeAsync(string propertyTypeName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.PropertyTypeClient.GetPropertyTypeClient(_dataViewMode, propertyTypeName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new - /// - /// Use this field to include those fields which are not included by default. - /// Property type available for content. Property types are like templates that can be reused. - /// - /// - /// - /// - /// - /// var propertytype = new PropertyType(); - /// var propertyType = propertytype.CreatePropertyType( propertyType, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.PropertyType CreatePropertyType(Mozu.Api.Contracts.Content.PropertyType propertyType, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.PropertyTypeClient.CreatePropertyTypeClient( propertyType, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates a new + /// /// - /// Use this field to include those fields which are not included by default. - /// Property type available for content. Property types are like templates that can be reused. + /// + /// /// /// /// @@ -183,48 +111,23 @@ public virtual Mozu.Api.Contracts.Content.PropertyType CreatePropertyType(Mozu.A /// var propertyType = await propertytype.CreatePropertyTypeAsync( propertyType, responseFields); /// /// - public virtual async Task CreatePropertyTypeAsync(Mozu.Api.Contracts.Content.PropertyType propertyType, string responseFields = null) + public virtual async Task CreatePropertyTypeAsync(Mozu.Api.Contracts.Content.PropertyType propertyType, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.PropertyTypeClient.CreatePropertyTypeClient( propertyType, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates a - /// - /// The name of the property type. - /// Use this field to include those fields which are not included by default. - /// Property type available for content. Property types are like templates that can be reused. - /// - /// - /// - /// - /// - /// var propertytype = new PropertyType(); - /// var propertyType = propertytype.UpdatePropertyType(_dataViewMode, propertyType, propertyTypeName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.PropertyType UpdatePropertyType(Mozu.Api.Contracts.Content.PropertyType propertyType, string propertyTypeName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.PropertyTypeClient.UpdatePropertyTypeClient(_dataViewMode, propertyType, propertyTypeName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates a + /// /// - /// The name of the property type. - /// Use this field to include those fields which are not included by default. - /// Property type available for content. Property types are like templates that can be reused. + /// + /// + /// /// /// /// @@ -234,43 +137,21 @@ public virtual Mozu.Api.Contracts.Content.PropertyType UpdatePropertyType(Mozu.A /// var propertyType = await propertytype.UpdatePropertyTypeAsync(_dataViewMode, propertyType, propertyTypeName, responseFields); /// /// - public virtual async Task UpdatePropertyTypeAsync(Mozu.Api.Contracts.Content.PropertyType propertyType, string propertyTypeName, string responseFields = null) + public virtual async Task UpdatePropertyTypeAsync(Mozu.Api.Contracts.Content.PropertyType propertyType, string propertyTypeName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.PropertyTypeClient.UpdatePropertyTypeClient(_dataViewMode, propertyType, propertyTypeName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Delete a specific - /// - /// The name of the property type. - /// - /// - /// - /// - /// - /// var propertytype = new PropertyType(); - /// propertytype.DeletePropertyType(_dataViewMode, propertyTypeName); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeletePropertyType(string propertyTypeName) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.PropertyTypeClient.DeletePropertyTypeClient(_dataViewMode, propertyTypeName); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Delete a specific + /// /// - /// The name of the property type. + /// /// /// /// @@ -280,12 +161,12 @@ public virtual void DeletePropertyType(string propertyTypeName) /// await propertytype.DeletePropertyTypeAsync(_dataViewMode, propertyTypeName); /// /// - public virtual async Task DeletePropertyTypeAsync(string propertyTypeName) + public virtual async Task DeletePropertyTypeAsync(string propertyTypeName, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.PropertyTypeClient.DeletePropertyTypeClient(_dataViewMode, propertyTypeName); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Content/PublishSetSummaryResource.cs b/Mozu.Api/Resources/Content/PublishSetSummaryResource.cs old mode 100644 new mode 100755 index 1f7f3079..1f2c96e2 --- a/Mozu.Api/Resources/Content/PublishSetSummaryResource.cs +++ b/Mozu.Api/Resources/Content/PublishSetSummaryResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Content { /// - /// Use the Content Publish Set resource to manage content publish sets and the pending content drafts.You can use content publish sets to group pending content changes together and publish them all at the same time. + /// /// public partial class PublishSetSummaryResource { /// @@ -37,38 +38,13 @@ public PublishSetSummaryResource CloneWithApiContext(Action context } - /// - /// Returns a list of content publish sets. - /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var publishsetsummary = new PublishSetSummary(); - /// var publishSetSummaryPagedCollection = publishsetsummary.GetPublishSets( pageSize, startIndex, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.PublishSetSummaryPagedCollection GetPublishSets(int? pageSize = null, int? startIndex = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.PublishSetSummaryClient.GetPublishSetsClient( pageSize, startIndex, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Returns a list of content publish sets. + /// /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// /// /// /// @@ -78,54 +54,26 @@ public virtual Mozu.Api.Contracts.Content.PublishSetSummaryPagedCollection GetPu /// var publishSetSummaryPagedCollection = await publishsetsummary.GetPublishSetsAsync( pageSize, startIndex, responseFields); /// /// - public virtual async Task GetPublishSetsAsync(int? pageSize = null, int? startIndex = null, string responseFields = null) + public virtual async Task GetPublishSetsAsync(int? pageSize = null, int? startIndex = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.PublishSetSummaryClient.GetPublishSetsClient( pageSize, startIndex, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of content publish sets and their properties. - /// - /// User-defined code that uniqely identifies the channel group. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var publishsetsummary = new PublishSetSummary(); - /// var documentDraftSummaryPagedCollection = publishsetsummary.GetPublishSetItems( code, pageSize, startIndex, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection GetPublishSetItems(string code, int? pageSize = null, int? startIndex = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.PublishSetSummaryClient.GetPublishSetItemsClient( code, pageSize, startIndex, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of content publish sets and their properties. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// /// @@ -135,48 +83,23 @@ public virtual Mozu.Api.Contracts.Content.DocumentDraftSummaryPagedCollection Ge /// var documentDraftSummaryPagedCollection = await publishsetsummary.GetPublishSetItemsAsync( code, pageSize, startIndex, sortBy, filter, responseFields); /// /// - public virtual async Task GetPublishSetItemsAsync(string code, int? pageSize = null, int? startIndex = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetPublishSetItemsAsync(string code, int? pageSize = null, int? startIndex = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.PublishSetSummaryClient.GetPublishSetItemsClient( code, pageSize, startIndex, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified content publish set. You can use the shouldDiscard parameter to specify whether to discard the content drafts assigned to the content publish set. - /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Specifies whether to discard the pending content changes assigned to the content publish set when the publish set is deleted. - /// - /// object - /// - /// - /// - /// var publishsetsummary = new PublishSetSummary(); - /// var object = publishsetsummary.DeletePublishSet( code, shouldDiscard, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual object DeletePublishSet(string code, bool? shouldDiscard = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.PublishSetSummaryClient.DeletePublishSetClient( code, shouldDiscard, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Deletes the specified content publish set. You can use the shouldDiscard parameter to specify whether to discard the content drafts assigned to the content publish set. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Specifies whether to discard the pending content changes assigned to the content publish set when the publish set is deleted. + /// + /// + /// /// /// object /// @@ -186,48 +109,23 @@ public virtual object DeletePublishSet(string code, bool? shouldDiscard = null, /// var object = await publishsetsummary.DeletePublishSetAsync( code, shouldDiscard, responseFields); /// /// - public virtual async Task DeletePublishSetAsync(string code, bool? shouldDiscard = null, string responseFields = null) + public virtual async Task DeletePublishSetAsync(string code, bool? shouldDiscard = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.PublishSetSummaryClient.DeletePublishSetClient( code, shouldDiscard, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Adds a set of documents by id to a specified publish set. - /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the items that you want to add to a specified publish set. - /// - /// object - /// - /// - /// - /// var publishsetsummary = new PublishSetSummary(); - /// var object = publishsetsummary.AddPublishSetItems( itemsToPublish, code, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual object AddPublishSetItems(List itemsToPublish, string code, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Content.PublishSetSummaryClient.AddPublishSetItemsClient( itemsToPublish, code, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Adds a set of documents by id to a specified publish set. + /// /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The details of the items that you want to add to a specified publish set. + /// + /// + /// /// /// object /// @@ -237,12 +135,12 @@ public virtual object AddPublishSetItems(List /// - public virtual async Task AddPublishSetItemsAsync(List itemsToPublish, string code, string responseFields = null) + public virtual async Task AddPublishSetItemsAsync(List itemsToPublish, string code, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Content.PublishSetSummaryClient.AddPublishSetItemsClient( itemsToPublish, code, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Event/EventNotificationResource.cs b/Mozu.Api/Resources/Event/EventNotificationResource.cs old mode 100644 new mode 100755 index e941c1d2..f72d660a --- a/Mozu.Api/Resources/Event/EventNotificationResource.cs +++ b/Mozu.Api/Resources/Event/EventNotificationResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Event { /// - /// Events are notifications publishes to the application when a create, read, update, or delete operation is performed. If the application subscribes to the event, you can use the Events resource to query for recent events published to your application or events that were not published successfully. + /// Events are notifications Mozu publishes to the application when a create, read, update, or delete operation is performed. If the application subscribes to the event, you can use the Events resource to query for recent events Mozu published to your application or events that were not published successfully. /// public partial class EventNotificationResource { /// @@ -41,40 +42,13 @@ public EventNotificationResource CloneWithApiContext(Action context } - /// - /// Retrieves a list of events. - /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// - /// - /// var eventnotification = new EventNotification(); - /// var eventCollection = eventnotification.GetEvents( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Event.EventCollection GetEvents(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Event.EventNotificationClient.GetEventsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of events. + /// /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -86,46 +60,22 @@ public virtual Mozu.Api.Contracts.Event.EventCollection GetEvents(int? startInde /// var eventCollection = await eventnotification.GetEventsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetEventsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetEventsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Event.EventNotificationClient.GetEventsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves an event by providing the event ID. - /// - /// The unique identifier of the event being retrieved. An event is a notification about a create, read, update, or delete on an order, product, discount or category. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var eventnotification = new EventNotification(); - /// var event = eventnotification.GetEvent( eventId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Event.Event GetEvent(string eventId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Event.EventNotificationClient.GetEventClient( eventId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves an event by providing the event ID. + /// /// /// The unique identifier of the event being retrieved. An event is a notification about a create, read, update, or delete on an order, product, discount or category. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -135,12 +85,12 @@ public virtual Mozu.Api.Contracts.Event.Event GetEvent(string eventId, string re /// var event = await eventnotification.GetEventAsync( eventId, responseFields); /// /// - public virtual async Task GetEventAsync(string eventId, string responseFields = null) + public virtual async Task GetEventAsync(string eventId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Event.EventNotificationClient.GetEventClient( eventId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Event/Push/SubscriptionResource.cs b/Mozu.Api/Resources/Event/Push/SubscriptionResource.cs old mode 100644 new mode 100755 index bb983a0b..0da9d770 --- a/Mozu.Api/Resources/Event/Push/SubscriptionResource.cs +++ b/Mozu.Api/Resources/Event/Push/SubscriptionResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Event.Push { /// - /// The Subscriptions resource triggers a push service to sent immediate notifications to the subscribed tenants and applications when triggers. The resource sends messages regarding a subscription event tha occurs in the tenant or site. + /// /// public partial class SubscriptionResource { /// @@ -37,42 +38,15 @@ public SubscriptionResource CloneWithApiContext(Action contextModif } - /// - /// Retrieves a list of events according to any specified filter criteria and sort options. - /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var subscription = new Subscription(); - /// var subscriptionCollection = subscription.GetSubscriptions( startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Event.SubscriptionCollection GetSubscriptions(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Event.Push.SubscriptionClient.GetSubscriptionsClient( startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of events according to any specified filter criteria and sort options. + /// /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// /// @@ -82,12 +56,12 @@ public virtual Mozu.Api.Contracts.Event.SubscriptionCollection GetSubscriptions( /// var subscriptionCollection = await subscription.GetSubscriptionsAsync( startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetSubscriptionsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetSubscriptionsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Event.Push.SubscriptionClient.GetSubscriptionsClient( startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Event/Push/Subscriptions/EventDeliverySummaryResource.cs b/Mozu.Api/Resources/Event/Push/Subscriptions/EventDeliverySummaryResource.cs old mode 100644 new mode 100755 index 39ea7a92..1a5ef604 --- a/Mozu.Api/Resources/Event/Push/Subscriptions/EventDeliverySummaryResource.cs +++ b/Mozu.Api/Resources/Event/Push/Subscriptions/EventDeliverySummaryResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Event.Push.Subscriptions { /// - /// Provides details for each attempted delivery of the event to the endpoint. + /// /// public partial class EventDeliverySummaryResource { /// @@ -37,95 +38,42 @@ public EventDeliverySummaryResource CloneWithApiContext(Action cont } - /// - /// This operation method is the external/public event entity used specifically in pull/poll event scenarios. - /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// Unique identifier for a subscription, such as subscribing tenants for an event or to receive a notification. - /// - /// - /// - /// - /// - /// var eventdeliverysummary = new EventDeliverySummary(); - /// var eventDeliverySummary = eventdeliverysummary.GetDeliveryAttemptSummary( subscriptionId, id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Event.EventDeliverySummary GetDeliveryAttemptSummary(string subscriptionId, int? id = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Event.Push.Subscriptions.EventDeliverySummaryClient.GetDeliveryAttemptSummaryClient( subscriptionId, id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// This operation method is the external/public event entity used specifically in pull/poll event scenarios. + /// /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// Unique identifier for a subscription, such as subscribing tenants for an event or to receive a notification. + /// + /// + /// This operation paramenter is the unique identifer for a subscription. /// /// /// /// /// /// var eventdeliverysummary = new EventDeliverySummary(); - /// var eventDeliverySummary = await eventdeliverysummary.GetDeliveryAttemptSummaryAsync( subscriptionId, id, responseFields); + /// var eventDeliverySummary = await eventdeliverysummary.GetDeliveryAttemptSummaryAsync( subscriptionId, processId, responseFields); /// /// - public virtual async Task GetDeliveryAttemptSummaryAsync(string subscriptionId, int? id = null, string responseFields = null) + public virtual async Task GetDeliveryAttemptSummaryAsync(string subscriptionId, int? processId = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; - var client = Mozu.Api.Clients.Event.Push.Subscriptions.EventDeliverySummaryClient.GetDeliveryAttemptSummaryClient( subscriptionId, id, responseFields); + var client = Mozu.Api.Clients.Event.Push.Subscriptions.EventDeliverySummaryClient.GetDeliveryAttemptSummaryClient( subscriptionId, processId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of data for delivery attempts of events and notifications. These are notifications sent to subscribing sites and tenants. A paged list is returned sorted and filtered per the entered parameters. - /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// Unique identifier for a subscription, such as subscribing tenants for an event or to receive a notification. - /// - /// - /// - /// - /// - /// var eventdeliverysummary = new EventDeliverySummary(); - /// var eventDeliverySummaryCollection = eventdeliverysummary.GetDeliveryAttemptSummaries( subscriptionId, startIndex, pageSize, sortBy, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Event.EventDeliverySummaryCollection GetDeliveryAttemptSummaries(string subscriptionId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Event.Push.Subscriptions.EventDeliverySummaryClient.GetDeliveryAttemptSummariesClient( subscriptionId, startIndex, pageSize, sortBy, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of data for delivery attempts of events and notifications. These are notifications sent to subscribing sites and tenants. A paged list is returned sorted and filtered per the entered parameters. + /// /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// Unique identifier for a subscription, such as subscribing tenants for an event or to receive a notification. + /// + /// + /// + /// + /// + /// /// /// /// @@ -135,12 +83,12 @@ public virtual Mozu.Api.Contracts.Event.EventDeliverySummaryCollection GetDelive /// var eventDeliverySummaryCollection = await eventdeliverysummary.GetDeliveryAttemptSummariesAsync( subscriptionId, startIndex, pageSize, sortBy, filter, responseFields); /// /// - public virtual async Task GetDeliveryAttemptSummariesAsync(string subscriptionId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public virtual async Task GetDeliveryAttemptSummariesAsync(string subscriptionId, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Event.Push.Subscriptions.EventDeliverySummaryClient.GetDeliveryAttemptSummariesClient( subscriptionId, startIndex, pageSize, sortBy, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Platform/Adminuser/AdminUserResource.cs b/Mozu.Api/Resources/Platform/Adminuser/AdminUserResource.cs old mode 100644 new mode 100755 index 2d897150..1fb74018 --- a/Mozu.Api/Resources/Platform/Adminuser/AdminUserResource.cs +++ b/Mozu.Api/Resources/Platform/Adminuser/AdminUserResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform.Adminuser { /// - /// The Accounts resource displays the user accounts and account details associated with a developer or tenant administrator. Email addresses uniquely identify admin user accounts. + /// Displays the user accounts and account details associated with a developer or Mozu tenant administrator. Email addresses uniquely identify admin user accounts. /// public partial class AdminUserResource { /// @@ -41,35 +42,11 @@ public AdminUserResource CloneWithApiContext(Action contextModifica } - /// - /// Retrieves a list of the tenants or development stores for which the specified user has an assigned role. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. - /// - /// - /// - /// - /// - /// var adminuser = new AdminUser(); - /// var tenantCollection = adminuser.GetTenantScopesForUser( userId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Tenant.TenantCollection GetTenantScopesForUser(string userId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Adminuser.AdminUserClient.GetTenantScopesForUserClient( userId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of the tenants or development stores for which the specified user has an assigned role. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// Unique identifier of the user whose tenant scopes you want to retrieve. /// /// @@ -80,46 +57,22 @@ public virtual Mozu.Api.Contracts.Tenant.TenantCollection GetTenantScopesForUser /// var tenantCollection = await adminuser.GetTenantScopesForUserAsync( userId, responseFields); /// /// - public virtual async Task GetTenantScopesForUserAsync(string userId, string responseFields = null) + public virtual async Task GetTenantScopesForUserAsync(string userId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Adminuser.AdminUserClient.GetTenantScopesForUserClient( userId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the specified administrator user account. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. - /// - /// - /// - /// - /// - /// var adminuser = new AdminUser(); - /// var user = adminuser.GetUser( userId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.User GetUser(string userId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Adminuser.AdminUserClient.GetUserClient( userId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the specified administrator user account. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. + /// + /// Unique identifier of the administrator account to retrieve. /// /// /// @@ -129,12 +82,12 @@ public virtual Mozu.Api.Contracts.Core.User GetUser(string userId, string respon /// var user = await adminuser.GetUserAsync( userId, responseFields); /// /// - public virtual async Task GetUserAsync(string userId, string responseFields = null) + public virtual async Task GetUserAsync(string userId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Adminuser.AdminUserClient.GetUserClient( userId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Platform/Adminuser/TenantAdminUserAuthTicketResource.cs b/Mozu.Api/Resources/Platform/Adminuser/TenantAdminUserAuthTicketResource.cs old mode 100644 new mode 100755 index fd2ff303..37b3b59e --- a/Mozu.Api/Resources/Platform/Adminuser/TenantAdminUserAuthTicketResource.cs +++ b/Mozu.Api/Resources/Platform/Adminuser/TenantAdminUserAuthTicketResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform.Adminuser { /// - /// Use the Admin User authentication tickets resource to generate and refresh authentication tickets that enable administrator or developer account users to access development or production tenants. + /// Use the Admin User authentication tickets resource to generate and refresh authentication tickets that enable Mozu administrator or developer account users to access development or production tenants. /// public partial class TenantAdminUserAuthTicketResource { /// @@ -41,38 +42,13 @@ public TenantAdminUserAuthTicketResource CloneWithApiContext(Action } - /// - /// Creates an authentication ticket for the supplied user to specify in API requests associated with the supplied tenant. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the development or production tenant for which to generate the user authentication ticket. - /// Information required to authenticate a user. - /// - /// - /// - /// - /// - /// var tenantadminuserauthticket = new TenantAdminUserAuthTicket(); - /// var tenantAdminUserAuthTicket = tenantadminuserauthticket.CreateUserAuthTicket( userAuthInfo, tenantId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket CreateUserAuthTicket(Mozu.Api.Contracts.Core.UserAuthInfo userAuthInfo, int? tenantId = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Adminuser.TenantAdminUserAuthTicketClient.CreateUserAuthTicketClient( userAuthInfo, tenantId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates an authentication ticket for the supplied user to specify in API requests associated with the supplied tenant. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// Unique identifier of the development or production tenant for which to generate the user authentication ticket. - /// Information required to authenticate a user. + /// The user authentication information required to generate the user authentication ticket, which consists of a user name and password. /// /// /// @@ -82,48 +58,23 @@ public virtual Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket CreateUser /// var tenantAdminUserAuthTicket = await tenantadminuserauthticket.CreateUserAuthTicketAsync( userAuthInfo, tenantId, responseFields); /// /// - public virtual async Task CreateUserAuthTicketAsync(Mozu.Api.Contracts.Core.UserAuthInfo userAuthInfo, int? tenantId = null, string responseFields = null) + public virtual async Task CreateUserAuthTicketAsync(Mozu.Api.Contracts.Core.UserAuthInfo userAuthInfo, int? tenantId = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Adminuser.TenantAdminUserAuthTicketClient.CreateUserAuthTicketClient( userAuthInfo, tenantId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Generates a new user authentication ticket for the specified tenant by supplying the user's existing refresh token information. - /// - /// Use this field to include those fields which are not included by default. - /// - /// Properties of the authentication ticket to be used in user claims with the API. - /// - /// - /// - /// - /// - /// var tenantadminuserauthticket = new TenantAdminUserAuthTicket(); - /// var tenantAdminUserAuthTicket = tenantadminuserauthticket.RefreshAuthTicket( existingAuthTicket, tenantId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket RefreshAuthTicket(Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket existingAuthTicket, int? tenantId = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Adminuser.TenantAdminUserAuthTicketClient.RefreshAuthTicketClient( existingAuthTicket, tenantId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Generates a new user authentication ticket for the specified tenant by supplying the user's existing refresh token information. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// - /// Properties of the authentication ticket to be used in user claims with the API. + /// Properties of the authentication ticket to refresh. The refresh token is required to complete this request. /// /// /// @@ -133,43 +84,21 @@ public virtual Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket RefreshAut /// var tenantAdminUserAuthTicket = await tenantadminuserauthticket.RefreshAuthTicketAsync( existingAuthTicket, tenantId, responseFields); /// /// - public virtual async Task RefreshAuthTicketAsync(Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket existingAuthTicket, int? tenantId = null, string responseFields = null) + public virtual async Task RefreshAuthTicketAsync(Mozu.Api.Contracts.AdminUser.TenantAdminUserAuthTicket existingAuthTicket, int? tenantId = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Adminuser.TenantAdminUserAuthTicketClient.RefreshAuthTicketClient( existingAuthTicket, tenantId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the authentication ticket for the user by supplying the refresh token. - /// - /// 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. - /// - /// - /// - /// - /// - /// var tenantadminuserauthticket = new TenantAdminUserAuthTicket(); - /// tenantadminuserauthticket.DeleteUserAuthTicket( refreshToken); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteUserAuthTicket(string refreshToken) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Adminuser.TenantAdminUserAuthTicketClient.DeleteUserAuthTicketClient( refreshToken); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the authentication ticket for the user by supplying the refresh token. + /// /// - /// 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. + /// Refresh token string associated with the user authentication ticket. /// /// /// @@ -179,12 +108,12 @@ public virtual void DeleteUserAuthTicket(string refreshToken) /// await tenantadminuserauthticket.DeleteUserAuthTicketAsync( refreshToken); /// /// - public virtual async Task DeleteUserAuthTicketAsync(string refreshToken) + public virtual async Task DeleteUserAuthTicketAsync(string refreshToken, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Adminuser.TenantAdminUserAuthTicketClient.DeleteUserAuthTicketClient( refreshToken); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/Appdev/AppPackageResource.cs b/Mozu.Api/Resources/Platform/Appdev/AppPackageResource.cs new file mode 100755 index 00000000..f1ddb183 --- /dev/null +++ b/Mozu.Api/Resources/Platform/Appdev/AppPackageResource.cs @@ -0,0 +1,308 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Platform.Appdev +{ + /// + /// + /// + public partial class AppPackageResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public AppPackageResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public AppPackageResource CloneWithApiContext(Action contextModification) + { + return new AppPackageResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var apppackage = new AppPackage(); + /// var packageSummaryCollection = await apppackage.GetAllPackagesAsync( startIndex, pageSize, sortBy, filter, responseFields); + /// + /// + public virtual async Task GetAllPackagesAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetAllPackagesClient( startIndex, pageSize, sortBy, filter, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var apppackage = new AppPackage(); + /// var package = await apppackage.GetPackageAsync( applicationKey, includeChildren, skipDevAccountCheck, responseFields); + /// + /// + public virtual async Task GetPackageAsync(string applicationKey, bool? includeChildren = null, bool? skipDevAccountCheck = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetPackageClient( applicationKey, includeChildren, skipDevAccountCheck, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var apppackage = new AppPackage(); + /// var packageCollection = await apppackage.GetPackagesAsync( applicationKey, startIndex, pageSize, sortBy, filter, responseFields); + /// + /// + public virtual async Task GetPackagesAsync(string applicationKey, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetPackagesClient( applicationKey, startIndex, pageSize, sortBy, filter, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// List{} + /// + /// + /// + /// var apppackage = new AppPackage(); + /// var applicationSummary = await apppackage.GetApplicationSummaryChildrenAsync( appId); + /// + /// + public virtual async Task> GetApplicationSummaryChildrenAsync(string appId, CancellationToken ct = default(CancellationToken)) + { + MozuClient> response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetApplicationSummaryChildrenClient( appId); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var apppackage = new AppPackage(); + /// var applicationSummaryCollection = await apppackage.GetApplicationSummaryParentsAsync( startIndex, pageSize, sortBy, filter, responseFields); + /// + /// + public virtual async Task GetApplicationSummaryParentsAsync(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.GetApplicationSummaryParentsClient( startIndex, pageSize, sortBy, filter, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var apppackage = new AppPackage(); + /// var package = await apppackage.ClonePackageAsync( applicationKey, packageName, responseFields); + /// + /// + public virtual async Task ClonePackageAsync(string applicationKey, string packageName, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.ClonePackageClient( applicationKey, packageName, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var apppackage = new AppPackage(); + /// var package = await apppackage.CreateNewCorePackageAsync( packageRequest, responseFields); + /// + /// + public virtual async Task CreateNewCorePackageAsync(Mozu.Api.Contracts.AppDev.PackageRequest packageRequest, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.CreateNewCorePackageClient( packageRequest, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var apppackage = new AppPackage(); + /// var package = await apppackage.CreatePackageAsync( pkg, projectId, responseFields); + /// + /// + public virtual async Task CreatePackageAsync(Mozu.Api.Contracts.AppDev.Package pkg, int? projectId = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.CreatePackageClient( pkg, projectId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var apppackage = new AppPackage(); + /// var package = await apppackage.UpdatePackageAsync( pkg, applicationKey, responseFields); + /// + /// + public virtual async Task UpdatePackageAsync(Mozu.Api.Contracts.AppDev.Package pkg, string applicationKey, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.UpdatePackageClient( pkg, applicationKey, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// var apppackage = new AppPackage(); + /// await apppackage.DeletePackageAsync( applicationKey); + /// + /// + public virtual async Task DeletePackageAsync(string applicationKey, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.Appdev.AppPackageClient.DeletePackageClient( applicationKey); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Platform/Appdev/PackageResource.cs b/Mozu.Api/Resources/Platform/Appdev/PackageResource.cs old mode 100644 new mode 100755 index c307c409..9684dfc9 --- a/Mozu.Api/Resources/Platform/Appdev/PackageResource.cs +++ b/Mozu.Api/Resources/Platform/Appdev/PackageResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform.Appdev { /// - /// This resource is not public. + /// /// public partial class PackageResource { /// @@ -41,35 +42,11 @@ public PackageResource CloneWithApiContext(Action contextModificati } - /// - /// This operation is not public. - /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// - /// - /// - /// - /// - /// - /// var package = new Package(); - /// var stream = package.GetFile( applicationKey, fileName); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual System.IO.Stream GetFile(string applicationKey, string fileName) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Appdev.PackageClient.GetFileClient( applicationKey, fileName); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// This operation is not public. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. + /// /// /// /// @@ -80,12 +57,12 @@ public virtual System.IO.Stream GetFile(string applicationKey, string fileName) /// var stream = await package.GetFileAsync( applicationKey, fileName); /// /// - public virtual async Task GetFileAsync(string applicationKey, string fileName) + public virtual async Task GetFileAsync(string applicationKey, string fileName, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Appdev.PackageClient.GetFileClient( applicationKey, fileName); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Platform/ApplicationResource.cs b/Mozu.Api/Resources/Platform/ApplicationResource.cs old mode 100644 new mode 100755 index 2898bd5b..927ab0ee --- a/Mozu.Api/Resources/Platform/ApplicationResource.cs +++ b/Mozu.Api/Resources/Platform/ApplicationResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform { /// - /// Use the Developer resource to view and update information and files related to application packages. + /// /// public partial class ApplicationResource { /// @@ -41,36 +42,12 @@ public ApplicationResource CloneWithApiContext(Action contextModifi } - /// - /// Returns a collection of package names for the application specified in the request. - /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var application = new Application(); - /// var packageNamesCollection = application.GetAppPackageNames( applicationKey, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AppDev.PackageNamesCollection GetAppPackageNames(string applicationKey, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ApplicationClient.GetAppPackageNamesClient( applicationKey, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Returns a collection of package names for the application specified in the request. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -80,46 +57,22 @@ public virtual Mozu.Api.Contracts.AppDev.PackageNamesCollection GetAppPackageNam /// var packageNamesCollection = await application.GetAppPackageNamesAsync( applicationKey, responseFields); /// /// - public virtual async Task GetAppPackageNamesAsync(string applicationKey, string responseFields = null) + public virtual async Task GetAppPackageNamesAsync(string applicationKey, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ApplicationClient.GetAppPackageNamesClient( applicationKey, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the available versions for the application specified in the request. - /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var application = new Application(); - /// var applicationVersionsCollection = application.GetAppVersions( nsAndAppId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AppDev.ApplicationVersionsCollection GetAppVersions(string nsAndAppId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ApplicationClient.GetAppVersionsClient( nsAndAppId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the available versions for the application specified in the request. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -129,48 +82,23 @@ public virtual Mozu.Api.Contracts.AppDev.ApplicationVersionsCollection GetAppVer /// var applicationVersionsCollection = await application.GetAppVersionsAsync( nsAndAppId, responseFields); /// /// - public virtual async Task GetAppVersionsAsync(string nsAndAppId, string responseFields = null) + public virtual async Task GetAppVersionsAsync(string nsAndAppId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ApplicationClient.GetAppVersionsClient( nsAndAppId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the metadata for a file in an application package. - /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Represents the file name and location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var application = new Application(); - /// var fileMetadata = application.GetPackageFileMetadata( applicationKey, filepath, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AppDev.FileMetadata GetPackageFileMetadata(string applicationKey, string filepath, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ApplicationClient.GetPackageFileMetadataClient( applicationKey, filepath, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the metadata for a file in an application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Represents the file name and location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// /// @@ -180,46 +108,22 @@ public virtual Mozu.Api.Contracts.AppDev.FileMetadata GetPackageFileMetadata(str /// var fileMetadata = await application.GetPackageFileMetadataAsync( applicationKey, filepath, responseFields); /// /// - public virtual async Task GetPackageFileMetadataAsync(string applicationKey, string filepath, string responseFields = null) + public virtual async Task GetPackageFileMetadataAsync(string applicationKey, string filepath, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ApplicationClient.GetPackageFileMetadataClient( applicationKey, filepath, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the metadata for a folder in an application package. - /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var application = new Application(); - /// var folderMetadata = application.GetPackageMetadata( applicationKey, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AppDev.FolderMetadata GetPackageMetadata(string applicationKey, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ApplicationClient.GetPackageMetadataClient( applicationKey, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the metadata for a folder in an application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// /// @@ -229,52 +133,25 @@ public virtual Mozu.Api.Contracts.AppDev.FolderMetadata GetPackageMetadata(strin /// var folderMetadata = await application.GetPackageMetadataAsync( applicationKey, responseFields); /// /// - public virtual async Task GetPackageMetadataAsync(string applicationKey, string responseFields = null) + public virtual async Task GetPackageMetadataAsync(string applicationKey, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ApplicationClient.GetPackageMetadataClient( applicationKey, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Insert or update the specified file into the specified application package. - /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// The date and time of the last file insert or update. This parameter is optional. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Data stream that delivers information. Used to input and output data. - /// - /// - /// - /// - /// - /// var application = new Application(); - /// var fileMetadata = application.UpsertPackageFile( stream, applicationKey, filepath, lastModifiedTime, responseFields, contentType); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AppDev.FileMetadata UpsertPackageFile(System.IO.Stream stream, string applicationKey, string filepath, string lastModifiedTime = null, string responseFields = null, String contentType= null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ApplicationClient.UpsertPackageFileClient( stream, applicationKey, filepath, lastModifiedTime, responseFields, contentType); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Insert or update the specified file into the specified application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// The date and time of the last file insert or update. This parameter is optional. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Data stream that delivers information. Used to input and output data. + /// + /// + /// + /// + /// /// /// /// @@ -284,48 +161,23 @@ public virtual Mozu.Api.Contracts.AppDev.FileMetadata UpsertPackageFile(System.I /// var fileMetadata = await application.UpsertPackageFileAsync( stream, applicationKey, filepath, lastModifiedTime, responseFields, contentType); /// /// - public virtual async Task UpsertPackageFileAsync(System.IO.Stream stream, string applicationKey, string filepath, string lastModifiedTime = null, string responseFields = null, String contentType= null) + public virtual async Task UpsertPackageFileAsync(System.IO.Stream stream, string applicationKey, string filepath, string lastModifiedTime = null, string responseFields = null, String contentType= null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ApplicationClient.UpsertPackageFileClient( stream, applicationKey, filepath, lastModifiedTime, responseFields, contentType); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Renames a file in an application package. - /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Information required to update the name of a file in a package, which consists of the original name and the new name. - /// - /// - /// - /// - /// - /// var application = new Application(); - /// var fileMetadata = application.RenamePackageFile( renameInfo, applicationKey, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AppDev.FileMetadata RenamePackageFile(Mozu.Api.Contracts.AppDev.RenameInfo renameInfo, string applicationKey, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ApplicationClient.RenamePackageFileClient( renameInfo, applicationKey, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Renames a file in an application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Information required to update the name of a file in a package, which consists of the original name and the new name. + /// + /// + /// /// /// /// @@ -335,45 +187,22 @@ public virtual Mozu.Api.Contracts.AppDev.FileMetadata RenamePackageFile(Mozu.Api /// var fileMetadata = await application.RenamePackageFileAsync( renameInfo, applicationKey, responseFields); /// /// - public virtual async Task RenamePackageFileAsync(Mozu.Api.Contracts.AppDev.RenameInfo renameInfo, string applicationKey, string responseFields = null) + public virtual async Task RenamePackageFileAsync(Mozu.Api.Contracts.AppDev.RenameInfo renameInfo, string applicationKey, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ApplicationClient.RenamePackageFileClient( renameInfo, applicationKey, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the specified file from the specified application package. - /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Represents the file name and location. - /// - /// - /// - /// - /// - /// var application = new Application(); - /// application.DeletePackageFile( applicationKey, filepath); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeletePackageFile(string applicationKey, string filepath) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ApplicationClient.DeletePackageFileClient( applicationKey, filepath); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the specified file from the specified application package. + /// /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Represents the file name and location. + /// + /// /// /// /// @@ -383,12 +212,12 @@ public virtual void DeletePackageFile(string applicationKey, string filepath) /// await application.DeletePackageFileAsync( applicationKey, filepath); /// /// - public virtual async Task DeletePackageFileAsync(string applicationKey, string filepath) + public virtual async Task DeletePackageFileAsync(string applicationKey, string filepath, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ApplicationClient.DeletePackageFileClient( applicationKey, filepath); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/Applications/AuthTicketResource.cs b/Mozu.Api/Resources/Platform/Applications/AuthTicketResource.cs old mode 100644 new mode 100755 index 7e078ea6..cd20fcdc --- a/Mozu.Api/Resources/Platform/Applications/AuthTicketResource.cs +++ b/Mozu.Api/Resources/Platform/Applications/AuthTicketResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform.Applications { /// - /// Use the Authetickets for applications resource to manage authentication tickets for your apps. + /// Use this resource to manage authentication tickets for your applications. /// public partial class AuthTicketResource { /// @@ -41,36 +42,12 @@ public AuthTicketResource CloneWithApiContext(Action contextModific } - /// - /// Generate an authentication ticket for an application. - /// - /// Use this field to include those fields which are not included by default. - /// The information required to authenticate third party applications against the API. - /// - /// - /// - /// - /// - /// var authticket = new AuthTicket(); - /// var authTicket = authticket.AuthenticateApp( appAuthInfo, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AppDev.AuthTicket AuthenticateApp(Mozu.Api.Contracts.AppDev.AppAuthInfo appAuthInfo, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Applications.AuthTicketClient.AuthenticateAppClient( appAuthInfo, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Generate an authentication ticket for an application. + /// /// - /// Use this field to include those fields which are not included by default. - /// The information required to authenticate third party applications against the API. + /// + /// Authentication information required to generate an authentication ticket includes the application id and the shared secret. /// /// /// @@ -80,46 +57,22 @@ public virtual Mozu.Api.Contracts.AppDev.AuthTicket AuthenticateApp(Mozu.Api.Con /// var authTicket = await authticket.AuthenticateAppAsync( appAuthInfo, responseFields); /// /// - public virtual async Task AuthenticateAppAsync(Mozu.Api.Contracts.AppDev.AppAuthInfo appAuthInfo, string responseFields = null) + public virtual async Task AuthenticateAppAsync(Mozu.Api.Contracts.AppDev.AppAuthInfo appAuthInfo, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Applications.AuthTicketClient.AuthenticateAppClient( appAuthInfo, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Refreshes the application's authentication ticket and generates a new access token by providing the refresh token string. - /// - /// Use this field to include those fields which are not included by default. - /// Properties of the authentication ticket refresh requests, which includes the refresh token string. - /// - /// - /// - /// - /// - /// var authticket = new AuthTicket(); - /// var authTicket = authticket.RefreshAppAuthTicket( authTicketRequest, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AppDev.AuthTicket RefreshAppAuthTicket(Mozu.Api.Contracts.AppDev.AuthTicketRequest authTicketRequest, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Applications.AuthTicketClient.RefreshAppAuthTicketClient( authTicketRequest, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Refreshes the application's authentication ticket and generates a new access token by providing the refresh token string. + /// /// - /// Use this field to include those fields which are not included by default. - /// Properties of the authentication ticket refresh requests, which includes the refresh token string. + /// + /// The refresh token string required to update the application authentication ticket. /// /// /// @@ -129,43 +82,21 @@ public virtual Mozu.Api.Contracts.AppDev.AuthTicket RefreshAppAuthTicket(Mozu.Ap /// var authTicket = await authticket.RefreshAppAuthTicketAsync( authTicketRequest, responseFields); /// /// - public virtual async Task RefreshAppAuthTicketAsync(Mozu.Api.Contracts.AppDev.AuthTicketRequest authTicketRequest, string responseFields = null) + public virtual async Task RefreshAppAuthTicketAsync(Mozu.Api.Contracts.AppDev.AuthTicketRequest authTicketRequest, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Applications.AuthTicketClient.RefreshAppAuthTicketClient( authTicketRequest, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes an authentication for an application based on the specified refresh token. - /// - /// 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. - /// - /// - /// - /// - /// - /// var authticket = new AuthTicket(); - /// authticket.DeleteAppAuthTicket( refreshToken); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteAppAuthTicket(string refreshToken) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Applications.AuthTicketClient.DeleteAppAuthTicketClient( refreshToken); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes an authentication for an application based on the specified refresh token. + /// /// - /// 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. + /// The refresh token string from the application's authentication ticket. /// /// /// @@ -175,12 +106,12 @@ public virtual void DeleteAppAuthTicket(string refreshToken) /// await authticket.DeleteAppAuthTicketAsync( refreshToken); /// /// - public virtual async Task DeleteAppAuthTicketAsync(string refreshToken) + public virtual async Task DeleteAppAuthTicketAsync(string refreshToken, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Applications.AuthTicketClient.DeleteAppAuthTicketClient( refreshToken); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/Developer/DeveloperAdminUserAuthTicketResource.cs b/Mozu.Api/Resources/Platform/Developer/DeveloperAdminUserAuthTicketResource.cs old mode 100644 new mode 100755 index 34f9cd9c..0a03023c --- a/Mozu.Api/Resources/Platform/Developer/DeveloperAdminUserAuthTicketResource.cs +++ b/Mozu.Api/Resources/Platform/Developer/DeveloperAdminUserAuthTicketResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform.Developer { /// - /// Use the Authtickets resource to manage authentication tickets for your developer account. + /// Use this resource to manage authentication tickets for your developer account. /// public partial class DeveloperAdminUserAuthTicketResource { /// @@ -41,38 +42,13 @@ public DeveloperAdminUserAuthTicketResource CloneWithApiContext(Action - /// Generate an authentication ticket for a developer account. - /// - /// Unique identifier of the developer account. - /// Use this field to include those fields which are not included by default. - /// Information required to authenticate a user. - /// - /// - /// - /// - /// - /// var developeradminuserauthticket = new DeveloperAdminUserAuthTicket(); - /// var developerAdminUserAuthTicket = developeradminuserauthticket.CreateDeveloperUserAuthTicket( userAuthInfo, developerAccountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket CreateDeveloperUserAuthTicket(Mozu.Api.Contracts.Core.UserAuthInfo userAuthInfo, int? developerAccountId = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Developer.DeveloperAdminUserAuthTicketClient.CreateDeveloperUserAuthTicketClient( userAuthInfo, developerAccountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Generate an authentication ticket for a developer account. + /// /// /// Unique identifier of the developer account. - /// Use this field to include those fields which are not included by default. - /// Information required to authenticate a user. + /// + /// The user authentication information required to generate the developer account user authentication ticket, which consists of a user name and password. /// /// /// @@ -82,48 +58,23 @@ public virtual Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket CreateD /// var developerAdminUserAuthTicket = await developeradminuserauthticket.CreateDeveloperUserAuthTicketAsync( userAuthInfo, developerAccountId, responseFields); /// /// - public virtual async Task CreateDeveloperUserAuthTicketAsync(Mozu.Api.Contracts.Core.UserAuthInfo userAuthInfo, int? developerAccountId = null, string responseFields = null) + public virtual async Task CreateDeveloperUserAuthTicketAsync(Mozu.Api.Contracts.Core.UserAuthInfo userAuthInfo, int? developerAccountId = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Developer.DeveloperAdminUserAuthTicketClient.CreateDeveloperUserAuthTicketClient( userAuthInfo, developerAccountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Generates a new developer account authentication ticket for the specified tenant by supplying the defined refresh token information. - /// - /// Unique identifier of the developer account. - /// Use this field to include those fields which are not included by default. - /// Properties of the authentication ticket to be used in developer account claims with the API. - /// - /// - /// - /// - /// - /// var developeradminuserauthticket = new DeveloperAdminUserAuthTicket(); - /// var developerAdminUserAuthTicket = developeradminuserauthticket.RefreshDeveloperAuthTicket( existingAuthTicket, developerAccountId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket RefreshDeveloperAuthTicket(Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket existingAuthTicket, int? developerAccountId = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Developer.DeveloperAdminUserAuthTicketClient.RefreshDeveloperAuthTicketClient( existingAuthTicket, developerAccountId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Generates a new developer account authentication ticket for the specified tenant by supplying the defined refresh token information. + /// /// /// Unique identifier of the developer account. - /// Use this field to include those fields which are not included by default. - /// Properties of the authentication ticket to be used in developer account claims with the API. + /// + /// Properties of the authentication ticket to refresh. The refresh token is required to complete this request. /// /// /// @@ -133,43 +84,21 @@ public virtual Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket Refresh /// var developerAdminUserAuthTicket = await developeradminuserauthticket.RefreshDeveloperAuthTicketAsync( existingAuthTicket, developerAccountId, responseFields); /// /// - public virtual async Task RefreshDeveloperAuthTicketAsync(Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket existingAuthTicket, int? developerAccountId = null, string responseFields = null) + public virtual async Task RefreshDeveloperAuthTicketAsync(Mozu.Api.Contracts.AdminUser.DeveloperAdminUserAuthTicket existingAuthTicket, int? developerAccountId = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Developer.DeveloperAdminUserAuthTicketClient.RefreshDeveloperAuthTicketClient( existingAuthTicket, developerAccountId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes the authentication ticket for the developer account by supplying the refresh token. - /// - /// 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. - /// - /// - /// - /// - /// - /// var developeradminuserauthticket = new DeveloperAdminUserAuthTicket(); - /// developeradminuserauthticket.DeleteUserAuthTicket( refreshToken); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteUserAuthTicket(string refreshToken) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Developer.DeveloperAdminUserAuthTicketClient.DeleteUserAuthTicketClient( refreshToken); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes the authentication ticket for the developer account by supplying the refresh token. + /// /// - /// 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. + /// Refresh token string associated with the developer account authentication ticket. /// /// /// @@ -179,12 +108,12 @@ public virtual void DeleteUserAuthTicket(string refreshToken) /// await developeradminuserauthticket.DeleteUserAuthTicketAsync( refreshToken); /// /// - public virtual async Task DeleteUserAuthTicketAsync(string refreshToken) + public virtual async Task DeleteUserAuthTicketAsync(string refreshToken, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Developer.DeveloperAdminUserAuthTicketClient.DeleteUserAuthTicketClient( refreshToken); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/EntityListResource.cs b/Mozu.Api/Resources/Platform/EntityListResource.cs old mode 100644 new mode 100755 index 6d719f5a..3b7a952a --- a/Mozu.Api/Resources/Platform/EntityListResource.cs +++ b/Mozu.Api/Resources/Platform/EntityListResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform { /// - /// The Entity Lists resource manages all dynamic entities in your document store of the cloud. The content is JSON and can have up to five indexed properties (integer, decimal, string, date, and boolean) with support for additional customized elements as needed. Every document in the entity list has a validated unique ID. + /// /// public partial class EntityListResource { /// @@ -37,42 +38,15 @@ public EntityListResource CloneWithApiContext(Action contextModific } - /// - /// Get a filtered list of EntityLists for a specific tenant. - /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var entitylist = new EntityList(); - /// var entityListCollection = entitylist.GetEntityLists( pageSize, startIndex, filter, sortBy, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityListCollection GetEntityLists(int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.EntityListClient.GetEntityListsClient( pageSize, startIndex, filter, sortBy, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Get a filtered list of EntityLists for a specific tenant. + /// /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// /// @@ -82,46 +56,22 @@ public virtual Mozu.Api.Contracts.MZDB.EntityListCollection GetEntityLists(int? /// var entityListCollection = await entitylist.GetEntityListsAsync( pageSize, startIndex, filter, sortBy, responseFields); /// /// - public virtual async Task GetEntityListsAsync(int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null) + public virtual async Task GetEntityListsAsync(int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.EntityListClient.GetEntityListsClient( pageSize, startIndex, filter, sortBy, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Get an existing EntityList definition for a specific tenant - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var entitylist = new EntityList(); - /// var entityList = entitylist.GetEntityList( entityListFullName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityList GetEntityList(string entityListFullName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.EntityListClient.GetEntityListClient( entityListFullName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Get an existing EntityList definition for a specific tenant + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// @@ -131,46 +81,22 @@ public virtual Mozu.Api.Contracts.MZDB.EntityList GetEntityList(string entityLis /// var entityList = await entitylist.GetEntityListAsync( entityListFullName, responseFields); /// /// - public virtual async Task GetEntityListAsync(string entityListFullName, string responseFields = null) + public virtual async Task GetEntityListAsync(string entityListFullName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.EntityListClient.GetEntityListClient( entityListFullName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Create a new EntityList for a specific tenant. - /// - /// Use this field to include those fields which are not included by default. - /// The definition of an MZDB EntityList which describes the characteristics of the EntityList on a per tenant basis. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList. - /// - /// - /// - /// - /// - /// var entitylist = new EntityList(); - /// var entityList = entitylist.CreateEntityList( entityList, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityList CreateEntityList(Mozu.Api.Contracts.MZDB.EntityList entityList, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.EntityListClient.CreateEntityListClient( entityList, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Create a new EntityList for a specific tenant. + /// /// - /// Use this field to include those fields which are not included by default. - /// The definition of an MZDB EntityList which describes the characteristics of the EntityList on a per tenant basis. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList. + /// + /// /// /// /// @@ -180,48 +106,23 @@ public virtual Mozu.Api.Contracts.MZDB.EntityList CreateEntityList(Mozu.Api.Cont /// var entityList = await entitylist.CreateEntityListAsync( entityList, responseFields); /// /// - public virtual async Task CreateEntityListAsync(Mozu.Api.Contracts.MZDB.EntityList entityList, string responseFields = null) + public virtual async Task CreateEntityListAsync(Mozu.Api.Contracts.MZDB.EntityList entityList, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.EntityListClient.CreateEntityListClient( entityList, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Update an existing Entitylist for a specific tenant. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The definition of an MZDB EntityList which describes the characteristics of the EntityList on a per tenant basis. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList. - /// - /// - /// - /// - /// - /// var entitylist = new EntityList(); - /// var entityList = entitylist.UpdateEntityList( entityList, entityListFullName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityList UpdateEntityList(Mozu.Api.Contracts.MZDB.EntityList entityList, string entityListFullName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.EntityListClient.UpdateEntityListClient( entityList, entityListFullName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Update an existing Entitylist for a specific tenant. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The definition of an MZDB EntityList which describes the characteristics of the EntityList on a per tenant basis. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList. + /// + /// + /// /// /// /// @@ -231,43 +132,21 @@ public virtual Mozu.Api.Contracts.MZDB.EntityList UpdateEntityList(Mozu.Api.Cont /// var entityList = await entitylist.UpdateEntityListAsync( entityList, entityListFullName, responseFields); /// /// - public virtual async Task UpdateEntityListAsync(Mozu.Api.Contracts.MZDB.EntityList entityList, string entityListFullName, string responseFields = null) + public virtual async Task UpdateEntityListAsync(Mozu.Api.Contracts.MZDB.EntityList entityList, string entityListFullName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.EntityListClient.UpdateEntityListClient( entityList, entityListFullName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Delete an existing EntityList for a specific tenant. This will also delete all Entities in all instances of this EntityList for the tenant. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// - /// - /// - /// - /// - /// var entitylist = new EntityList(); - /// entitylist.DeleteEntityList( entityListFullName); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteEntityList(string entityListFullName) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.EntityListClient.DeleteEntityListClient( entityListFullName); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Delete an existing EntityList for a specific tenant. This will also delete all Entities in all instances of this EntityList for the tenant. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format + /// /// /// /// @@ -277,12 +156,12 @@ public virtual void DeleteEntityList(string entityListFullName) /// await entitylist.DeleteEntityListAsync( entityListFullName); /// /// - public virtual async Task DeleteEntityListAsync(string entityListFullName) + public virtual async Task DeleteEntityListAsync(string entityListFullName, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.EntityListClient.DeleteEntityListClient( entityListFullName); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/Entitylists/EntityContainerResource.cs b/Mozu.Api/Resources/Platform/Entitylists/EntityContainerResource.cs old mode 100644 new mode 100755 index 473ff7ca..88cab81b --- a/Mozu.Api/Resources/Platform/Entitylists/EntityContainerResource.cs +++ b/Mozu.Api/Resources/Platform/Entitylists/EntityContainerResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform.Entitylists { /// - /// Entity containers provide all properties and data for entities within a site/tenant. This data encapsulates all associated IDs including entity lists, entity views, site, tenant, entities, and more. + /// /// public partial class EntityContainerResource { /// @@ -37,38 +38,13 @@ public EntityContainerResource CloneWithApiContext(Action contextMo } - /// - /// Retrieves an entity container, providing all schema and rules and associated IDs for entities. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var entitycontainer = new EntityContainer(); - /// var entityContainer = entitycontainer.GetEntityContainer( entityListFullName, id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityContainer GetEntityContainer(string entityListFullName, string id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.EntityContainerClient.GetEntityContainerClient( entityListFullName, id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves an entity container, providing all schema and rules and associated IDs for entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -78,54 +54,26 @@ public virtual Mozu.Api.Contracts.MZDB.EntityContainer GetEntityContainer(string /// var entityContainer = await entitycontainer.GetEntityContainerAsync( entityListFullName, id, responseFields); /// /// - public virtual async Task GetEntityContainerAsync(string entityListFullName, string id, string responseFields = null) + public virtual async Task GetEntityContainerAsync(string entityListFullName, string id, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.EntityContainerClient.GetEntityContainerClient( entityListFullName, id, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of entity containers. Each container holds a set of entities per ID. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var entitycontainer = new EntityContainer(); - /// var entityContainerCollection = entitycontainer.GetEntityContainers( entityListFullName, pageSize, startIndex, filter, sortBy, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityContainerCollection GetEntityContainers(string entityListFullName, int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.EntityContainerClient.GetEntityContainersClient( entityListFullName, pageSize, startIndex, filter, sortBy, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of entity containers. Each container holds a set of entities per ID. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// /// @@ -135,12 +83,12 @@ public virtual Mozu.Api.Contracts.MZDB.EntityContainerCollection GetEntityContai /// var entityContainerCollection = await entitycontainer.GetEntityContainersAsync( entityListFullName, pageSize, startIndex, filter, sortBy, responseFields); /// /// - public virtual async Task GetEntityContainersAsync(string entityListFullName, int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null) + public virtual async Task GetEntityContainersAsync(string entityListFullName, int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.EntityContainerClient.GetEntityContainersClient( entityListFullName, pageSize, startIndex, filter, sortBy, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Platform/Entitylists/EntityResource.cs b/Mozu.Api/Resources/Platform/Entitylists/EntityResource.cs old mode 100644 new mode 100755 index 7cfc44d4..ec97cb33 --- a/Mozu.Api/Resources/Platform/Entitylists/EntityResource.cs +++ b/Mozu.Api/Resources/Platform/Entitylists/EntityResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform.Entitylists { /// - /// Entities are JSON entries within the MZDB ( Mongo DB) for handling large data sets to heavily filter (>2,000 items). Each entity is associated to an EntityList with schema, rules, and formatting for storing the content. This content can be accessed via the API and Hypr tags. + /// /// public partial class EntityResource { /// @@ -37,38 +38,13 @@ public EntityResource CloneWithApiContext(Action contextModificatio } - /// - /// Retrieves an entity with an associated entity list and context level at tenant, master catalog, catalog, or site. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// - /// JObject - /// - /// - /// - /// var entity = new Entity(); - /// var json = entity.GetEntity( entityListFullName, id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual JObject GetEntity(string entityListFullName, string id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.GetEntityClient( entityListFullName, id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves an entity with an associated entity list and context level at tenant, master catalog, catalog, or site. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// JObject /// @@ -78,54 +54,26 @@ public virtual JObject GetEntity(string entityListFullName, string id, string re /// var json = await entity.GetEntityAsync( entityListFullName, id, responseFields); /// /// - public virtual async Task GetEntityAsync(string entityListFullName, string id, string responseFields = null) + public virtual async Task GetEntityAsync(string entityListFullName, string id, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.GetEntityClient( entityListFullName, id, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of entities with an associated entity list and context level at tenant, master catalog, catalog, or site. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// - /// - /// - /// - /// - /// var entity = new Entity(); - /// var entityCollection = entity.GetEntities( entityListFullName, pageSize, startIndex, filter, sortBy, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityCollection GetEntities(string entityListFullName, int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.GetEntitiesClient( entityListFullName, pageSize, startIndex, filter, sortBy, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of entities with an associated entity list and context level at tenant, master catalog, catalog, or site. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// /// @@ -135,48 +83,23 @@ public virtual Mozu.Api.Contracts.MZDB.EntityCollection GetEntities(string entit /// var entityCollection = await entity.GetEntitiesAsync( entityListFullName, pageSize, startIndex, filter, sortBy, responseFields); /// /// - public virtual async Task GetEntitiesAsync(string entityListFullName, int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null) + public virtual async Task GetEntitiesAsync(string entityListFullName, int? pageSize = null, int? startIndex = null, string filter = null, string sortBy = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.GetEntitiesClient( entityListFullName, pageSize, startIndex, filter, sortBy, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Inserts a new entity per the entered item, the entity list full name, and associated response fields. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// JSON code for objects. - /// - /// JObject - /// - /// - /// - /// var entity = new Entity(); - /// var json = entity.InsertEntity( item, entityListFullName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual JObject InsertEntity(JObject item, string entityListFullName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.InsertEntityClient( item, entityListFullName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Inserts a new entity per the entered item, the entity list full name, and associated response fields. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// JSON code for objects. + /// + /// + /// /// /// JObject /// @@ -186,50 +109,24 @@ public virtual JObject InsertEntity(JObject item, string entityListFullName, str /// var json = await entity.InsertEntityAsync( item, entityListFullName, responseFields); /// /// - public virtual async Task InsertEntityAsync(JObject item, string entityListFullName, string responseFields = null) + public virtual async Task InsertEntityAsync(JObject item, string entityListFullName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.InsertEntityClient( item, entityListFullName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the content and associations for an existing entity. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// JSON code for objects. - /// - /// JObject - /// - /// - /// - /// var entity = new Entity(); - /// var json = entity.UpdateEntity( item, entityListFullName, id, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual JObject UpdateEntity(JObject item, string entityListFullName, string id, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.UpdateEntityClient( item, entityListFullName, id, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the content and associations for an existing entity. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// JSON code for objects. + /// + /// + /// + /// /// /// JObject /// @@ -239,45 +136,22 @@ public virtual JObject UpdateEntity(JObject item, string entityListFullName, str /// var json = await entity.UpdateEntityAsync( item, entityListFullName, id, responseFields); /// /// - public virtual async Task UpdateEntityAsync(JObject item, string entityListFullName, string id, string responseFields = null) + public virtual async Task UpdateEntityAsync(JObject item, string entityListFullName, string id, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.UpdateEntityClient( item, entityListFullName, id, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes an entity depending on the context of tenant, master catalog, catalog, or site level. Entities are associated to an entity list (schema and formatting) for displaying within a namespace and context level. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// - /// - /// - /// - /// - /// var entity = new Entity(); - /// entity.DeleteEntity( entityListFullName, id); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteEntity(string entityListFullName, string id) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.DeleteEntityClient( entityListFullName, id); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes an entity depending on the context of tenant, master catalog, catalog, or site level. Entities are associated to an entity list (schema and formatting) for displaying within a namespace and context level. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. + /// + /// /// /// /// @@ -287,12 +161,12 @@ public virtual void DeleteEntity(string entityListFullName, string id) /// await entity.DeleteEntityAsync( entityListFullName, id); /// /// - public virtual async Task DeleteEntityAsync(string entityListFullName, string id) + public virtual async Task DeleteEntityAsync(string entityListFullName, string id, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.EntityClient.DeleteEntityClient( entityListFullName, id); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/Entitylists/ListViewResource.cs b/Mozu.Api/Resources/Platform/Entitylists/ListViewResource.cs old mode 100644 new mode 100755 index 6933edb5..5346e219 --- a/Mozu.Api/Resources/Platform/Entitylists/ListViewResource.cs +++ b/Mozu.Api/Resources/Platform/Entitylists/ListViewResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform.Entitylists { /// - /// Provides settings and options for displaying associated content within a context level of site, tenant, catalog, or master catalog. ListViews can be associated with entity lists and entities. + /// /// public partial class ListViewResource { /// @@ -37,40 +38,14 @@ public ListViewResource CloneWithApiContext(Action contextModificat } - /// - /// Retrieves a view for associated entities. A view provides display context levels (site, tenant, catalog, master catalog) and settings. - /// - /// Unique identifier for an entity, which defines the schema, rules, and formats for JSON entities within the MZDB ( Mongo DB). - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// - /// JObject - /// - /// - /// - /// var listview = new ListView(); - /// var json = listview.GetViewEntity( entityListFullName, viewName, entityId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual JObject GetViewEntity(string entityListFullName, string viewName, string entityId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetViewEntityClient( entityListFullName, viewName, entityId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a view for associated entities. A view provides display context levels (site, tenant, catalog, master catalog) and settings. + /// /// - /// Unique identifier for an entity, which defines the schema, rules, and formats for JSON entities within the MZDB ( Mongo DB). - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// /// /// JObject /// @@ -80,54 +55,26 @@ public virtual JObject GetViewEntity(string entityListFullName, string viewName, /// var json = await listview.GetViewEntityAsync( entityListFullName, viewName, entityId, responseFields); /// /// - public virtual async Task GetViewEntityAsync(string entityListFullName, string viewName, string entityId, string responseFields = null) + public virtual async Task GetViewEntityAsync(string entityListFullName, string viewName, string entityId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetViewEntityClient( entityListFullName, viewName, entityId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of views for associated entities. Each view provides display context levels (site, tenant, catalog, master catalog) and settings. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// - /// - /// - /// - /// - /// var listview = new ListView(); - /// var entityCollection = listview.GetViewEntities( entityListFullName, viewName, pageSize, startIndex, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityCollection GetViewEntities(string entityListFullName, string viewName, int? pageSize = null, int? startIndex = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetViewEntitiesClient( entityListFullName, viewName, pageSize, startIndex, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of views for associated entities. Each view provides display context levels (site, tenant, catalog, master catalog) and settings. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// + /// + /// /// /// /// @@ -137,50 +84,24 @@ public virtual Mozu.Api.Contracts.MZDB.EntityCollection GetViewEntities(string e /// var entityCollection = await listview.GetViewEntitiesAsync( entityListFullName, viewName, pageSize, startIndex, filter, responseFields); /// /// - public virtual async Task GetViewEntitiesAsync(string entityListFullName, string viewName, int? pageSize = null, int? startIndex = null, string filter = null, string responseFields = null) + public virtual async Task GetViewEntitiesAsync(string entityListFullName, string viewName, int? pageSize = null, int? startIndex = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetViewEntitiesClient( entityListFullName, viewName, pageSize, startIndex, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of container data for creating and displaying a view of entities. - /// - /// Unique identifier for an entity, which defines the schema, rules, and formats for JSON entities within the MZDB ( Mongo DB). - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// - /// - /// - /// - /// - /// var listview = new ListView(); - /// var entityContainer = listview.GetViewEntityContainer( entityListFullName, viewName, entityId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityContainer GetViewEntityContainer(string entityListFullName, string viewName, string entityId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetViewEntityContainerClient( entityListFullName, viewName, entityId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of container data for creating and displaying a view of entities. + /// /// - /// Unique identifier for an entity, which defines the schema, rules, and formats for JSON entities within the MZDB ( Mongo DB). - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// /// /// /// @@ -190,54 +111,26 @@ public virtual Mozu.Api.Contracts.MZDB.EntityContainer GetViewEntityContainer(st /// var entityContainer = await listview.GetViewEntityContainerAsync( entityListFullName, viewName, entityId, responseFields); /// /// - public virtual async Task GetViewEntityContainerAsync(string entityListFullName, string viewName, string entityId, string responseFields = null) + public virtual async Task GetViewEntityContainerAsync(string entityListFullName, string viewName, string entityId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetViewEntityContainerClient( entityListFullName, viewName, entityId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of container data for creating and displaying a view of entities. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// - /// - /// - /// - /// - /// var listview = new ListView(); - /// var entityContainerCollection = listview.GetViewEntityContainers( entityListFullName, viewName, pageSize, startIndex, filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.EntityContainerCollection GetViewEntityContainers(string entityListFullName, string viewName, int? pageSize = null, int? startIndex = null, string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetViewEntityContainersClient( entityListFullName, viewName, pageSize, startIndex, filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of container data for creating and displaying a view of entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// + /// + /// /// /// /// @@ -247,48 +140,23 @@ public virtual Mozu.Api.Contracts.MZDB.EntityContainerCollection GetViewEntityCo /// var entityContainerCollection = await listview.GetViewEntityContainersAsync( entityListFullName, viewName, pageSize, startIndex, filter, responseFields); /// /// - public virtual async Task GetViewEntityContainersAsync(string entityListFullName, string viewName, int? pageSize = null, int? startIndex = null, string filter = null, string responseFields = null) + public virtual async Task GetViewEntityContainersAsync(string entityListFullName, string viewName, int? pageSize = null, int? startIndex = null, string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetViewEntityContainersClient( entityListFullName, viewName, pageSize, startIndex, filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a specific `EntityListView`. These views provide schema, rules, and formatting for all associated entities. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// - /// - /// - /// - /// - /// var listview = new ListView(); - /// var listView = listview.GetEntityListView( entityListFullName, viewName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.ListView GetEntityListView(string entityListFullName, string viewName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetEntityListViewClient( entityListFullName, viewName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a specific `EntityListView`. These views provide schema, rules, and formatting for all associated entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// /// /// /// @@ -298,46 +166,22 @@ public virtual Mozu.Api.Contracts.MZDB.ListView GetEntityListView(string entityL /// var listView = await listview.GetEntityListViewAsync( entityListFullName, viewName, responseFields); /// /// - public virtual async Task GetEntityListViewAsync(string entityListFullName, string viewName, string responseFields = null) + public virtual async Task GetEntityListViewAsync(string entityListFullName, string viewName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetEntityListViewClient( entityListFullName, viewName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a collection of `EntityListViews`. These views provide schema, rules, and formatting for all associated entities. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var listview = new ListView(); - /// var listViewCollection = listview.GetEntityListViews( entityListFullName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.ListViewCollection GetEntityListViews(string entityListFullName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetEntityListViewsClient( entityListFullName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a collection of `EntityListViews`. These views provide schema, rules, and formatting for all associated entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// @@ -347,48 +191,23 @@ public virtual Mozu.Api.Contracts.MZDB.ListViewCollection GetEntityListViews(str /// var listViewCollection = await listview.GetEntityListViewsAsync( entityListFullName, responseFields); /// /// - public virtual async Task GetEntityListViewsAsync(string entityListFullName, string responseFields = null) + public virtual async Task GetEntityListViewsAsync(string entityListFullName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.GetEntityListViewsClient( entityListFullName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates an entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// Properties for the list view that specifies what fields and content display per page load. All associated fields in the list view correspond with object data. - /// - /// - /// - /// - /// - /// var listview = new ListView(); - /// var listView = listview.CreateEntityListView( listView, entityListFullName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.ListView CreateEntityListView(Mozu.Api.Contracts.MZDB.ListView listView, string entityListFullName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.CreateEntityListViewClient( listView, entityListFullName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Creates an entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// Properties for the list view that specifies what fields and content display per page load. All associated fields in the list view correspond with object data. + /// + /// + /// /// /// /// @@ -398,50 +217,24 @@ public virtual Mozu.Api.Contracts.MZDB.ListView CreateEntityListView(Mozu.Api.Co /// var listView = await listview.CreateEntityListViewAsync( listView, entityListFullName, responseFields); /// /// - public virtual async Task CreateEntityListViewAsync(Mozu.Api.Contracts.MZDB.ListView listView, string entityListFullName, string responseFields = null) + public virtual async Task CreateEntityListViewAsync(Mozu.Api.Contracts.MZDB.ListView listView, string entityListFullName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.CreateEntityListViewClient( listView, entityListFullName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates an existing entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// Properties for the list view that specifies what fields and content display per page load. All associated fields in the list view correspond with object data. - /// - /// - /// - /// - /// - /// var listview = new ListView(); - /// var listView = listview.UpdateEntityListView( listView, entityListFullName, viewName, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.MZDB.ListView UpdateEntityListView(Mozu.Api.Contracts.MZDB.ListView listView, string entityListFullName, string viewName, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.UpdateEntityListViewClient( listView, entityListFullName, viewName, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates an existing entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// Properties for the list view that specifies what fields and content display per page load. All associated fields in the list view correspond with object data. + /// + /// + /// + /// /// /// /// @@ -451,45 +244,22 @@ public virtual Mozu.Api.Contracts.MZDB.ListView UpdateEntityListView(Mozu.Api.Co /// var listView = await listview.UpdateEntityListViewAsync( listView, entityListFullName, viewName, responseFields); /// /// - public virtual async Task UpdateEntityListViewAsync(Mozu.Api.Contracts.MZDB.ListView listView, string entityListFullName, string viewName, string responseFields = null) + public virtual async Task UpdateEntityListViewAsync(Mozu.Api.Contracts.MZDB.ListView listView, string entityListFullName, string viewName, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.UpdateEntityListViewClient( listView, entityListFullName, viewName, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Deletes an entity list view. Any associated entities have the association removed. - /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. - /// - /// - /// - /// - /// - /// var listview = new ListView(); - /// listview.DeleteEntityListView( entityListFullName, viewName); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteEntityListView(string entityListFullName, string viewName) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.DeleteEntityListViewClient( entityListFullName, viewName); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Deletes an entity list view. Any associated entities have the association removed. + /// /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// /// /// /// @@ -499,12 +269,12 @@ public virtual void DeleteEntityListView(string entityListFullName, string viewN /// await listview.DeleteEntityListViewAsync( entityListFullName, viewName); /// /// - public virtual async Task DeleteEntityListViewAsync(string entityListFullName, string viewName) + public virtual async Task DeleteEntityListViewAsync(string entityListFullName, string viewName, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Entitylists.ListViewClient.DeleteEntityListViewClient( entityListFullName, viewName); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/Extensions/CredentialStoreEntryResource.cs b/Mozu.Api/Resources/Platform/Extensions/CredentialStoreEntryResource.cs old mode 100644 new mode 100755 index a1b399f0..66ab42db --- a/Mozu.Api/Resources/Platform/Extensions/CredentialStoreEntryResource.cs +++ b/Mozu.Api/Resources/Platform/Extensions/CredentialStoreEntryResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform.Extensions { /// - /// The CredentialStore resource allows you to encrypt and store sensitive data on your tenant. You can then decrypt and access that data using an Arc.js application, as described in the Arc.js [Programming Patterns](https://www.mozu.com/docs/developer/arcjs-guides/programming-patterns.htm#securely_store_and_access_sensitive_data) topic. + /// /// public partial class CredentialStoreEntryResource { /// @@ -37,31 +38,9 @@ public CredentialStoreEntryResource CloneWithApiContext(Action cont } - /// - /// Encrypts and stores data contained in the JSON object. You can decrypt and access the secured data using an Arc.js application, as described in the Arc.js [Programming Patterns](https://www.mozu.com/docs/developer/arcjs-guides/programming-patterns.htm#securely_store_and_access_sensitive_data) topic. - /// - /// - /// - /// - /// - /// - /// - /// var credentialstoreentry = new CredentialStoreEntry(); - /// credentialstoreentry.StoreCredentials( credentials); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void StoreCredentials(Mozu.Api.Contracts.InstalledApplications.CredentialStoreEntry credentials) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.Extensions.CredentialStoreEntryClient.StoreCredentialsClient( credentials); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Encrypts and stores data contained in the JSON object. You can decrypt and access the secured data using an Arc.js application, as described in the Arc.js [Programming Patterns](https://www.mozu.com/docs/developer/arcjs-guides/programming-patterns.htm#securely_store_and_access_sensitive_data) topic. + /// /// /// /// @@ -73,12 +52,12 @@ public virtual void StoreCredentials(Mozu.Api.Contracts.InstalledApplications.Cr /// await credentialstoreentry.StoreCredentialsAsync( credentials); /// /// - public virtual async Task StoreCredentialsAsync(Mozu.Api.Contracts.InstalledApplications.CredentialStoreEntry credentials) + public virtual async Task StoreCredentialsAsync(Mozu.Api.Contracts.InstalledApplications.CredentialStoreEntry credentials, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.Extensions.CredentialStoreEntryClient.StoreCredentialsClient( credentials); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/InstalledApplicationsResource.cs b/Mozu.Api/Resources/Platform/InstalledApplicationsResource.cs new file mode 100755 index 00000000..e51e7ba7 --- /dev/null +++ b/Mozu.Api/Resources/Platform/InstalledApplicationsResource.cs @@ -0,0 +1,97 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Mozu.Api.Security; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; +using System.Threading; + +namespace Mozu.Api.Resources.Platform +{ + /// + /// Use the Applications resource to update and retrieve details about the applications installed for your tenant. + /// + public partial class InstalledApplicationsResource { + /// + /// + /// + private readonly IApiContext _apiContext; + + + public InstalledApplicationsResource(IApiContext apiContext) + { + _apiContext = apiContext; + } + + public InstalledApplicationsResource CloneWithApiContext(Action contextModification) + { + return new InstalledApplicationsResource(_apiContext.CloneWith(contextModification)); + } + + + + /// + /// + /// + /// The application ID that represents the application to retrieve. + /// + /// + /// + /// + /// + /// + /// var installedapplications = new InstalledApplications(); + /// var application = await installedapplications.GetApplicationAsync( appId, responseFields); + /// + /// + public virtual async Task GetApplicationAsync(string appId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.InstalledApplicationsClient.GetApplicationClient( appId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + /// + /// + /// + /// The application ID that represents the application to update. + /// + /// Properties of the application to update. + /// + /// + /// + /// + /// + /// var installedapplications = new InstalledApplications(); + /// var application = await installedapplications.UpdateApplicationAsync( application, appId, responseFields); + /// + /// + public virtual async Task UpdateApplicationAsync(Mozu.Api.Contracts.InstalledApplications.Application application, string appId, string responseFields = null, CancellationToken ct = default(CancellationToken)) + { + MozuClient response; + var client = Mozu.Api.Clients.Platform.InstalledApplicationsClient.UpdateApplicationClient( application, appId, responseFields); + client.WithContext(_apiContext); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); + return await response.ResultAsync(); + + } + + + } + +} + + diff --git a/Mozu.Api/Resources/Platform/ReferenceDataResource.cs b/Mozu.Api/Resources/Platform/ReferenceDataResource.cs old mode 100644 new mode 100755 index c080eb21..ebf43698 --- a/Mozu.Api/Resources/Platform/ReferenceDataResource.cs +++ b/Mozu.Api/Resources/Platform/ReferenceDataResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform { /// - /// The Reference resource retrieves collections of standards the system currently supports. This includes content locales, top-level domains, units of measure, countries, currencies, time zones, and shipping or billing address schemas. + /// The Reference resource retrieves collections of standards the Mozu system currently supports. This includes content locales, top-level domains, units of measure, countries, currencies, time zones, and shipping or billing address schemas. /// public partial class ReferenceDataResource { /// @@ -41,36 +42,12 @@ public ReferenceDataResource CloneWithApiContext(Action contextModi } - /// - /// Retrieves a specific address schema based on the country code provided. This operation allows the creation of custom shipping and billing address fields. - /// - /// The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var addressSchema = referencedata.GetAddressSchema( countryCode, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Reference.AddressSchema GetAddressSchema(string countryCode = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetAddressSchemaClient( countryCode, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a specific address schema based on the country code provided. This operation allows the creation of custom shipping and billing address fields. + /// /// - /// The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// Use this field to include those fields which are not included by default. + /// The 2-letter country code used to retrieve a specified address schema. + /// /// /// /// @@ -80,44 +57,21 @@ public virtual Mozu.Api.Contracts.Reference.AddressSchema GetAddressSchema(strin /// var addressSchema = await referencedata.GetAddressSchemaAsync( countryCode, responseFields); /// /// - public virtual async Task GetAddressSchemaAsync(string countryCode = null, string responseFields = null) + public virtual async Task GetAddressSchemaAsync(string countryCode = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetAddressSchemaClient( countryCode, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the entire list of address schemas that the system supports. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var addressSchemaCollection = referencedata.GetAddressSchemas( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Reference.AddressSchemaCollection GetAddressSchemas(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetAddressSchemasClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the entire list of address schemas that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -127,46 +81,22 @@ public virtual Mozu.Api.Contracts.Reference.AddressSchemaCollection GetAddressSc /// var addressSchemaCollection = await referencedata.GetAddressSchemasAsync( responseFields); /// /// - public virtual async Task GetAddressSchemasAsync(string responseFields = null) + public virtual async Task GetAddressSchemasAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetAddressSchemasClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of a behavior based on the behavior ID specified in the request. - /// - /// Unique identifier of the behavior. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var behavior = referencedata.GetBehavior( behaviorId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.Behavior GetBehavior(int behaviorId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetBehaviorClient( behaviorId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of a behavior based on the behavior ID specified in the request. + /// /// /// Unique identifier of the behavior. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -176,46 +106,22 @@ public virtual Mozu.Api.Contracts.Core.Behavior GetBehavior(int behaviorId, stri /// var behavior = await referencedata.GetBehaviorAsync( behaviorId, responseFields); /// /// - public virtual async Task GetBehaviorAsync(int behaviorId, string responseFields = null) + public virtual async Task GetBehaviorAsync(int behaviorId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetBehaviorClient( behaviorId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the details of the behavior category specified in the request. - /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var behaviorCategory = referencedata.GetBehaviorCategory( categoryId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.BehaviorCategory GetBehaviorCategory(int categoryId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetBehaviorCategoryClient( categoryId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the details of the behavior category specified in the request. + /// /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the behavior category. + /// /// /// /// @@ -225,44 +131,21 @@ public virtual Mozu.Api.Contracts.Core.BehaviorCategory GetBehaviorCategory(int /// var behaviorCategory = await referencedata.GetBehaviorCategoryAsync( categoryId, responseFields); /// /// - public virtual async Task GetBehaviorCategoryAsync(int categoryId, string responseFields = null) + public virtual async Task GetBehaviorCategoryAsync(int categoryId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetBehaviorCategoryClient( categoryId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the list of behavior categories. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var behaviorCategoryCollection = referencedata.GetBehaviorCategories( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.BehaviorCategoryCollection GetBehaviorCategories(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetBehaviorCategoriesClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the list of behavior categories. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -272,45 +155,21 @@ public virtual Mozu.Api.Contracts.Core.BehaviorCategoryCollection GetBehaviorCat /// var behaviorCategoryCollection = await referencedata.GetBehaviorCategoriesAsync( responseFields); /// /// - public virtual async Task GetBehaviorCategoriesAsync(string responseFields = null) + public virtual async Task GetBehaviorCategoriesAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetBehaviorCategoriesClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves a list of application behaviors. - /// - /// Use this field to include those fields which are not included by default. - /// The user type associated with the behaviors to retrieve. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var behaviorCollection = referencedata.GetBehaviors( userType, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Core.BehaviorCollection GetBehaviors(string userType = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetBehaviorsClient( userType, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves a list of application behaviors. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// The user type associated with the behaviors to retrieve. /// /// @@ -321,44 +180,21 @@ public virtual Mozu.Api.Contracts.Core.BehaviorCollection GetBehaviors(string us /// var behaviorCollection = await referencedata.GetBehaviorsAsync( userType, responseFields); /// /// - public virtual async Task GetBehaviorsAsync(string userType = null, string responseFields = null) + public virtual async Task GetBehaviorsAsync(string userType = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetBehaviorsClient( userType, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the list of content locales the system supports. Content locales indicate the language used and the country where the language is used. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var contentLocaleCollection = referencedata.GetContentLocales( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Reference.ContentLocaleCollection GetContentLocales(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetContentLocalesClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the list of content locales the system supports. Content locales indicate the language used and the country where the language is used. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -368,44 +204,21 @@ public virtual Mozu.Api.Contracts.Reference.ContentLocaleCollection GetContentLo /// var contentLocaleCollection = await referencedata.GetContentLocalesAsync( responseFields); /// /// - public virtual async Task GetContentLocalesAsync(string responseFields = null) + public virtual async Task GetContentLocalesAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetContentLocalesClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the entire list of countries that the system supports. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var countryCollection = referencedata.GetCountries( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Reference.CountryCollection GetCountries(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetCountriesClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the entire list of countries that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -415,44 +228,21 @@ public virtual Mozu.Api.Contracts.Reference.CountryCollection GetCountries(strin /// var countryCollection = await referencedata.GetCountriesAsync( responseFields); /// /// - public virtual async Task GetCountriesAsync(string responseFields = null) + public virtual async Task GetCountriesAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetCountriesClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the entire list of countries that the system supports. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var countryWithStatesCollection = referencedata.GetCountriesWithStates( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Reference.CountryWithStatesCollection GetCountriesWithStates(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetCountriesWithStatesClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the entire list of countries that the system supports. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -462,44 +252,21 @@ public virtual Mozu.Api.Contracts.Reference.CountryWithStatesCollection GetCount /// var countryWithStatesCollection = await referencedata.GetCountriesWithStatesAsync( responseFields); /// /// - public virtual async Task GetCountriesWithStatesAsync(string responseFields = null) + public virtual async Task GetCountriesWithStatesAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetCountriesWithStatesClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the entire list of currencies that the system supports. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var currencyCollection = referencedata.GetCurrencies( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Reference.CurrencyCollection GetCurrencies(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetCurrenciesClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the entire list of currencies that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -509,44 +276,21 @@ public virtual Mozu.Api.Contracts.Reference.CurrencyCollection GetCurrencies(str /// var currencyCollection = await referencedata.GetCurrenciesAsync( responseFields); /// /// - public virtual async Task GetCurrenciesAsync(string responseFields = null) + public virtual async Task GetCurrenciesAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetCurrenciesClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the entire list of time zones that the system supports. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var timeZoneCollection = referencedata.GetTimeZones( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Reference.TimeZoneCollection GetTimeZones(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetTimeZonesClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the entire list of time zones that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -556,44 +300,21 @@ public virtual Mozu.Api.Contracts.Reference.TimeZoneCollection GetTimeZones(stri /// var timeZoneCollection = await referencedata.GetTimeZonesAsync( responseFields); /// /// - public virtual async Task GetTimeZonesAsync(string responseFields = null) + public virtual async Task GetTimeZonesAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetTimeZonesClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves the entire list of top-level internet domains that the system supports. - /// - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var topLevelDomainCollection = referencedata.GetTopLevelDomains( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Reference.TopLevelDomainCollection GetTopLevelDomains(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetTopLevelDomainsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the entire list of top-level internet domains that the system supports. + /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -603,46 +324,22 @@ public virtual Mozu.Api.Contracts.Reference.TopLevelDomainCollection GetTopLevel /// var topLevelDomainCollection = await referencedata.GetTopLevelDomainsAsync( responseFields); /// /// - public virtual async Task GetTopLevelDomainsAsync(string responseFields = null) + public virtual async Task GetTopLevelDomainsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetTopLevelDomainsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Retrieves an array list of all units of measure the system supports. - /// - /// 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" - /// Use this field to include those fields which are not included by default. - /// - /// - /// - /// - /// - /// var referencedata = new ReferenceData(); - /// var unitOfMeasureCollection = referencedata.GetUnitsOfMeasure( filter, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Reference.UnitOfMeasureCollection GetUnitsOfMeasure(string filter = null, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetUnitsOfMeasureClient( filter, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves an array list of all units of measure the system supports. + /// /// - /// 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" - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// @@ -652,12 +349,12 @@ public virtual Mozu.Api.Contracts.Reference.UnitOfMeasureCollection GetUnitsOfMe /// var unitOfMeasureCollection = await referencedata.GetUnitsOfMeasureAsync( filter, responseFields); /// /// - public virtual async Task GetUnitsOfMeasureAsync(string filter = null, string responseFields = null) + public virtual async Task GetUnitsOfMeasureAsync(string filter = null, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.ReferenceDataClient.GetUnitsOfMeasureClient( filter, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Platform/SecureAppDataResource.cs b/Mozu.Api/Resources/Platform/SecureAppDataResource.cs old mode 100644 new mode 100755 index 7295f6c4..9132a1a1 --- a/Mozu.Api/Resources/Platform/SecureAppDataResource.cs +++ b/Mozu.Api/Resources/Platform/SecureAppDataResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform { /// - /// Manage Secure App Settings. Expose via arc.js so that arc apps can securely access secrets. Third-party extensions can also access their data. Secured via AppKey.AppId + /// /// public partial class SecureAppDataResource { /// @@ -37,38 +38,13 @@ public SecureAppDataResource CloneWithApiContext(Action contextModi } - /// - /// platform-secureappdata Get GetDBValue description DOCUMENT_HERE - /// - /// - /// The database entry string to create. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// JObject - /// - /// - /// - /// var secureappdata = new SecureAppData(); - /// var json = secureappdata.GetDBValue( appKeyId, dbEntryQuery, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual JObject GetDBValue(string appKeyId, string dbEntryQuery, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.SecureAppDataClient.GetDBValueClient( appKeyId, dbEntryQuery, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// platform-secureappdata Get GetDBValue description DOCUMENT_HERE + /// /// /// - /// The database entry string to create. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// JObject /// @@ -78,47 +54,23 @@ public virtual JObject GetDBValue(string appKeyId, string dbEntryQuery, string r /// var json = await secureappdata.GetDBValueAsync( appKeyId, dbEntryQuery, responseFields); /// /// - public virtual async Task GetDBValueAsync(string appKeyId, string dbEntryQuery, string responseFields = null) + public virtual async Task GetDBValueAsync(string appKeyId, string dbEntryQuery, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.SecureAppDataClient.GetDBValueClient( appKeyId, dbEntryQuery, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// platform-secureappdata Post CreateDBValue description DOCUMENT_HERE - /// - /// - /// The database entry string to create. - /// The value string to create. - /// - /// - /// - /// - /// - /// var secureappdata = new SecureAppData(); - /// secureappdata.CreateDBValue( value, appKeyId, dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void CreateDBValue(JObject value, string appKeyId, string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.SecureAppDataClient.CreateDBValueClient( value, appKeyId, dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// platform-secureappdata Post CreateDBValue description DOCUMENT_HERE + /// /// /// - /// The database entry string to create. - /// The value string to create. + /// + /// /// /// /// @@ -128,46 +80,22 @@ public virtual void CreateDBValue(JObject value, string appKeyId, string dbEntry /// await secureappdata.CreateDBValueAsync( value, appKeyId, dbEntryQuery); /// /// - public virtual async Task CreateDBValueAsync(JObject value, string appKeyId, string dbEntryQuery) + public virtual async Task CreateDBValueAsync(JObject value, string appKeyId, string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.SecureAppDataClient.CreateDBValueClient( value, appKeyId, dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// platform-secureappdata Put UpdateDBValue description DOCUMENT_HERE - /// - /// - /// The database entry string to create. - /// The value string to create. - /// - /// - /// - /// - /// - /// var secureappdata = new SecureAppData(); - /// secureappdata.UpdateDBValue( value, appKeyId, dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void UpdateDBValue(JObject value, string appKeyId, string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.SecureAppDataClient.UpdateDBValueClient( value, appKeyId, dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// platform-secureappdata Put UpdateDBValue description DOCUMENT_HERE + /// /// /// - /// The database entry string to create. - /// The value string to create. + /// + /// /// /// /// @@ -177,44 +105,21 @@ public virtual void UpdateDBValue(JObject value, string appKeyId, string dbEntry /// await secureappdata.UpdateDBValueAsync( value, appKeyId, dbEntryQuery); /// /// - public virtual async Task UpdateDBValueAsync(JObject value, string appKeyId, string dbEntryQuery) + public virtual async Task UpdateDBValueAsync(JObject value, string appKeyId, string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.SecureAppDataClient.UpdateDBValueClient( value, appKeyId, dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// platform-secureappdata Delete DeleteDBValue description DOCUMENT_HERE - /// - /// - /// The database entry string to create. - /// - /// - /// - /// - /// - /// var secureappdata = new SecureAppData(); - /// secureappdata.DeleteDBValue( appKeyId, dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDBValue(string appKeyId, string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.SecureAppDataClient.DeleteDBValueClient( appKeyId, dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// platform-secureappdata Delete DeleteDBValue description DOCUMENT_HERE + /// /// /// - /// The database entry string to create. + /// /// /// /// @@ -224,12 +129,12 @@ public virtual void DeleteDBValue(string appKeyId, string dbEntryQuery) /// await secureappdata.DeleteDBValueAsync( appKeyId, dbEntryQuery); /// /// - public virtual async Task DeleteDBValueAsync(string appKeyId, string dbEntryQuery) + public virtual async Task DeleteDBValueAsync(string appKeyId, string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.SecureAppDataClient.DeleteDBValueClient( appKeyId, dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/SiteDataResource.cs b/Mozu.Api/Resources/Platform/SiteDataResource.cs old mode 100644 new mode 100755 index bee99e43..16b15c5a --- a/Mozu.Api/Resources/Platform/SiteDataResource.cs +++ b/Mozu.Api/Resources/Platform/SiteDataResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform { /// - /// Use the site data resource to store site-level information required for a third-party application in the database. + /// Use the site data resource to store site-level information required for a third-party application in the Mozu database. /// public partial class SiteDataResource { /// @@ -37,36 +38,12 @@ public SiteDataResource CloneWithApiContext(Action contextModificat } - /// - /// Retrieves the value of a record in the database. - /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. - /// - /// string - /// - /// - /// - /// var sitedata = new SiteData(); - /// var string = sitedata.GetDBValue( dbEntryQuery, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual string GetDBValue(string dbEntryQuery, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.SiteDataClient.GetDBValueClient( dbEntryQuery, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the value of a record in the database. + /// /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. + /// The database entry query string used to retrieve the record information. + /// /// /// string /// @@ -76,42 +53,19 @@ public virtual string GetDBValue(string dbEntryQuery, string responseFields = n /// var string = await sitedata.GetDBValueAsync( dbEntryQuery, responseFields); /// /// - public virtual async Task GetDBValueAsync(string dbEntryQuery, string responseFields = null) + public virtual async Task GetDBValueAsync(string dbEntryQuery, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.SiteDataClient.GetDBValueClient( dbEntryQuery, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new record in the database based on the information supplied in the request. - /// - /// The database entry string to create. - /// The value string to create. - /// - /// - /// - /// - /// - /// var sitedata = new SiteData(); - /// sitedata.CreateDBValue( value, dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void CreateDBValue(string value, string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.SiteDataClient.CreateDBValueClient( value, dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Creates a new record in the database based on the information supplied in the request. + /// /// /// The database entry string to create. /// The value string to create. @@ -124,44 +78,21 @@ public virtual void CreateDBValue(string value, string dbEntryQuery) /// await sitedata.CreateDBValueAsync( value, dbEntryQuery); /// /// - public virtual async Task CreateDBValueAsync(string value, string dbEntryQuery) + public virtual async Task CreateDBValueAsync(string value, string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.SiteDataClient.CreateDBValueClient( value, dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates a record in the database based on the information supplied in the request. - /// - /// The database entry string to create. - /// The value string to create. - /// - /// - /// - /// - /// - /// var sitedata = new SiteData(); - /// sitedata.UpdateDBValue( value, dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void UpdateDBValue(string value, string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.SiteDataClient.UpdateDBValueClient( value, dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Updates a record in the database based on the information supplied in the request. + /// /// - /// The database entry string to create. - /// The value string to create. + /// The database entry query string used to update the record information. + /// The database value to update. /// /// /// @@ -171,42 +102,20 @@ public virtual void UpdateDBValue(string value, string dbEntryQuery) /// await sitedata.UpdateDBValueAsync( value, dbEntryQuery); /// /// - public virtual async Task UpdateDBValueAsync(string value, string dbEntryQuery) + public virtual async Task UpdateDBValueAsync(string value, string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.SiteDataClient.UpdateDBValueClient( value, dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Removes a previously defined record in the database. - /// - /// The database entry string to create. - /// - /// - /// - /// - /// - /// var sitedata = new SiteData(); - /// sitedata.DeleteDBValue( dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDBValue(string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.SiteDataClient.DeleteDBValueClient( dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes a previously defined record in the database. + /// /// - /// The database entry string to create. + /// The database entry string to delete. /// /// /// @@ -216,12 +125,12 @@ public virtual void DeleteDBValue(string dbEntryQuery) /// await sitedata.DeleteDBValueAsync( dbEntryQuery); /// /// - public virtual async Task DeleteDBValueAsync(string dbEntryQuery) + public virtual async Task DeleteDBValueAsync(string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.SiteDataClient.DeleteDBValueClient( dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/TenantDataResource.cs b/Mozu.Api/Resources/Platform/TenantDataResource.cs old mode 100644 new mode 100755 index b7bc2b09..e5084890 --- a/Mozu.Api/Resources/Platform/TenantDataResource.cs +++ b/Mozu.Api/Resources/Platform/TenantDataResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform { /// - /// Use the tenant data resource to store tenant-level information required for a third-party application in the database. + /// Use the tenant data resource to store tenant-level information required for a third-party application in the Mozu database. /// public partial class TenantDataResource { /// @@ -37,36 +38,12 @@ public TenantDataResource CloneWithApiContext(Action contextModific } - /// - /// Retrieves the value of a record in the database. - /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. - /// - /// string - /// - /// - /// - /// var tenantdata = new TenantData(); - /// var string = tenantdata.GetDBValue( dbEntryQuery, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual string GetDBValue(string dbEntryQuery, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.TenantDataClient.GetDBValueClient( dbEntryQuery, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the value of a record in the database. + /// /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. + /// The database entry query string used to retrieve the record information. + /// /// /// string /// @@ -76,42 +53,19 @@ public virtual string GetDBValue(string dbEntryQuery, string responseFields = n /// var string = await tenantdata.GetDBValueAsync( dbEntryQuery, responseFields); /// /// - public virtual async Task GetDBValueAsync(string dbEntryQuery, string responseFields = null) + public virtual async Task GetDBValueAsync(string dbEntryQuery, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.TenantDataClient.GetDBValueClient( dbEntryQuery, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new record in the database based on the information supplied in the request. - /// - /// The database entry string to create. - /// The value string to create. - /// - /// - /// - /// - /// - /// var tenantdata = new TenantData(); - /// tenantdata.CreateDBValue( value, dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void CreateDBValue(string value, string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.TenantDataClient.CreateDBValueClient( value, dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Creates a new record in the database based on the information supplied in the request. + /// /// /// The database entry string to create. /// The value string to create. @@ -124,44 +78,21 @@ public virtual void CreateDBValue(string value, string dbEntryQuery) /// await tenantdata.CreateDBValueAsync( value, dbEntryQuery); /// /// - public virtual async Task CreateDBValueAsync(string value, string dbEntryQuery) + public virtual async Task CreateDBValueAsync(string value, string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.TenantDataClient.CreateDBValueClient( value, dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates a record in the database based on the information supplied in the request. - /// - /// The database entry string to create. - /// The value string to create. - /// - /// - /// - /// - /// - /// var tenantdata = new TenantData(); - /// tenantdata.UpdateDBValue( value, dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void UpdateDBValue(string value, string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.TenantDataClient.UpdateDBValueClient( value, dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Updates a record in the database based on the information supplied in the request. + /// /// - /// The database entry string to create. - /// The value string to create. + /// The database entry query string used to update the record information. + /// The database value to update. /// /// /// @@ -171,42 +102,20 @@ public virtual void UpdateDBValue(string value, string dbEntryQuery) /// await tenantdata.UpdateDBValueAsync( value, dbEntryQuery); /// /// - public virtual async Task UpdateDBValueAsync(string value, string dbEntryQuery) + public virtual async Task UpdateDBValueAsync(string value, string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.TenantDataClient.UpdateDBValueClient( value, dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Removes a previously defined record in the database. - /// - /// The database entry string to create. - /// - /// - /// - /// - /// - /// var tenantdata = new TenantData(); - /// tenantdata.DeleteDBValue( dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDBValue(string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.TenantDataClient.DeleteDBValueClient( dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes a previously defined record in the database. + /// /// - /// The database entry string to create. + /// The database entry string to delete. /// /// /// @@ -216,12 +125,12 @@ public virtual void DeleteDBValue(string dbEntryQuery) /// await tenantdata.DeleteDBValueAsync( dbEntryQuery); /// /// - public virtual async Task DeleteDBValueAsync(string dbEntryQuery) + public virtual async Task DeleteDBValueAsync(string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.TenantDataClient.DeleteDBValueClient( dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Resources/Platform/TenantExtensionsResource.cs b/Mozu.Api/Resources/Platform/TenantExtensionsResource.cs old mode 100644 new mode 100755 index 9fd4e22c..b5793a24 --- a/Mozu.Api/Resources/Platform/TenantExtensionsResource.cs +++ b/Mozu.Api/Resources/Platform/TenantExtensionsResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform { /// - /// Use the Extensions resource to manage Arc.js configuration settings. These are the same settings you can configure through in the Action Management JSON Editor. + /// /// public partial class TenantExtensionsResource { /// @@ -37,34 +38,11 @@ public TenantExtensionsResource CloneWithApiContext(Action contextM } - /// - /// Retrieves the Arc.js configuration settings for a site. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// - /// - /// - /// - /// - /// var tenantextensions = new TenantExtensions(); - /// var tenantExtensions = tenantextensions.GetExtensions( responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.InstalledApplications.TenantExtensions GetExtensions(string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.TenantExtensionsClient.GetExtensionsClient( responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the Arc.js configuration settings for a site. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// /// @@ -74,46 +52,22 @@ public virtual Mozu.Api.Contracts.InstalledApplications.TenantExtensions GetExte /// var tenantExtensions = await tenantextensions.GetExtensionsAsync( responseFields); /// /// - public virtual async Task GetExtensionsAsync(string responseFields = null) + public virtual async Task GetExtensionsAsync(string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.TenantExtensionsClient.GetExtensionsClient( responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Updates the Arc.js configuration settings for a site. - /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The updated details of the Arc.js configuration settings. - /// - /// - /// - /// - /// - /// var tenantextensions = new TenantExtensions(); - /// var tenantExtensions = tenantextensions.UpdateExtensions( extensions, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.InstalledApplications.TenantExtensions UpdateExtensions(Mozu.Api.Contracts.InstalledApplications.TenantExtensions extensions, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.TenantExtensionsClient.UpdateExtensionsClient( extensions, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Updates the Arc.js configuration settings for a site. + /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The updated details of the Arc.js configuration settings. + /// + /// /// /// /// @@ -123,12 +77,12 @@ public virtual Mozu.Api.Contracts.InstalledApplications.TenantExtensions UpdateE /// var tenantExtensions = await tenantextensions.UpdateExtensionsAsync( extensions, responseFields); /// /// - public virtual async Task UpdateExtensionsAsync(Mozu.Api.Contracts.InstalledApplications.TenantExtensions extensions, string responseFields = null) + public virtual async Task UpdateExtensionsAsync(Mozu.Api.Contracts.InstalledApplications.TenantExtensions extensions, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.TenantExtensionsClient.UpdateExtensionsClient( extensions, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Platform/TenantResource.cs b/Mozu.Api/Resources/Platform/TenantResource.cs old mode 100644 new mode 100755 index c4634822..617069ad --- a/Mozu.Api/Resources/Platform/TenantResource.cs +++ b/Mozu.Api/Resources/Platform/TenantResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform { /// - /// Use the tenants resource to manage information about a tenant. + /// Use the tenants resource to manage information about a Mozu tenant. /// public partial class TenantResource { /// @@ -41,36 +42,12 @@ public TenantResource CloneWithApiContext(Action contextModificatio } - /// - /// Retrieve details about a specific tenant by providing the tenant ID. - /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the Mozu tenant. - /// - /// - /// - /// - /// - /// var tenant = new Tenant(); - /// var tenant = tenant.GetTenant( tenantId, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual Mozu.Api.Contracts.Tenant.Tenant GetTenant(int tenantId, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.TenantClient.GetTenantClient( tenantId, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieve details about a specific tenant by providing the tenant ID. + /// /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the Mozu tenant. + /// + /// /// /// /// @@ -80,12 +57,12 @@ public virtual Mozu.Api.Contracts.Tenant.Tenant GetTenant(int tenantId, string r /// var tenant = await tenant.GetTenantAsync( tenantId, responseFields); /// /// - public virtual async Task GetTenantAsync(int tenantId, string responseFields = null) + public virtual async Task GetTenantAsync(int tenantId, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.TenantClient.GetTenantClient( tenantId, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } diff --git a/Mozu.Api/Resources/Platform/UserDataResource.cs b/Mozu.Api/Resources/Platform/UserDataResource.cs old mode 100644 new mode 100755 index 088fc2e8..a168acea --- a/Mozu.Api/Resources/Platform/UserDataResource.cs +++ b/Mozu.Api/Resources/Platform/UserDataResource.cs @@ -13,11 +13,12 @@ using Mozu.Api.Security; using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using System.Threading; namespace Mozu.Api.Resources.Platform { /// - /// Use the user data subresource to store user-level data required for a third-party application in the database. + /// Use the user data subresource to store user-level data required for a third-party application in the Mozu database. /// public partial class UserDataResource { /// @@ -37,36 +38,12 @@ public UserDataResource CloneWithApiContext(Action contextModificat } - /// - /// Retrieves the value of a record in the database. - /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. - /// - /// string - /// - /// - /// - /// var userdata = new UserData(); - /// var string = userdata.GetDBValue( dbEntryQuery, responseFields); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual string GetDBValue(string dbEntryQuery, string responseFields = null) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.UserDataClient.GetDBValueClient( dbEntryQuery, responseFields); - client.WithContext(_apiContext); - response = client.Execute(); - return response.Result(); - - } /// - /// Retrieves the value of a record in the database. + /// /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. + /// The database entry query string used to retrieve the record information. + /// /// /// string /// @@ -76,42 +53,19 @@ public virtual string GetDBValue(string dbEntryQuery, string responseFields = n /// var string = await userdata.GetDBValueAsync( dbEntryQuery, responseFields); /// /// - public virtual async Task GetDBValueAsync(string dbEntryQuery, string responseFields = null) + public virtual async Task GetDBValueAsync(string dbEntryQuery, string responseFields = null, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.UserDataClient.GetDBValueClient( dbEntryQuery, responseFields); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); return await response.ResultAsync(); } - /// - /// Creates a new record in the database based on the information supplied in the request. - /// - /// The database entry string to create. - /// The value string to create. - /// - /// - /// - /// - /// - /// var userdata = new UserData(); - /// userdata.CreateDBValue( value, dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void CreateDBValue(string value, string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.UserDataClient.CreateDBValueClient( value, dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Creates a new record in the database based on the information supplied in the request. + /// /// /// The database entry string to create. /// The value string to create. @@ -124,44 +78,21 @@ public virtual void CreateDBValue(string value, string dbEntryQuery) /// await userdata.CreateDBValueAsync( value, dbEntryQuery); /// /// - public virtual async Task CreateDBValueAsync(string value, string dbEntryQuery) + public virtual async Task CreateDBValueAsync(string value, string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.UserDataClient.CreateDBValueClient( value, dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Updates a record in the database based on the information supplied in the request. - /// - /// The database entry string to create. - /// The value string to create. - /// - /// - /// - /// - /// - /// var userdata = new UserData(); - /// userdata.UpdateDBValue( value, dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void UpdateDBValue(string value, string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.UserDataClient.UpdateDBValueClient( value, dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Updates a record in the database based on the information supplied in the request. + /// /// - /// The database entry string to create. - /// The value string to create. + /// The database entry query string used to update the record information. + /// The database value to update. /// /// /// @@ -171,42 +102,20 @@ public virtual void UpdateDBValue(string value, string dbEntryQuery) /// await userdata.UpdateDBValueAsync( value, dbEntryQuery); /// /// - public virtual async Task UpdateDBValueAsync(string value, string dbEntryQuery) + public virtual async Task UpdateDBValueAsync(string value, string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.UserDataClient.UpdateDBValueClient( value, dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } - /// - /// Removes a previously defined record in the database. - /// - /// The database entry string to create. - /// - /// - /// - /// - /// - /// var userdata = new UserData(); - /// userdata.DeleteDBValue( dbEntryQuery); - /// - /// - [Obsolete("This method is obsolete; use the async method instead")] - public virtual void DeleteDBValue(string dbEntryQuery) - { - MozuClient response; - var client = Mozu.Api.Clients.Platform.UserDataClient.DeleteDBValueClient( dbEntryQuery); - client.WithContext(_apiContext); - response = client.Execute(); - - } /// - /// Removes a previously defined record in the database. + /// /// - /// The database entry string to create. + /// The database entry string to delete. /// /// /// @@ -216,12 +125,12 @@ public virtual void DeleteDBValue(string dbEntryQuery) /// await userdata.DeleteDBValueAsync( dbEntryQuery); /// /// - public virtual async Task DeleteDBValueAsync(string dbEntryQuery) + public virtual async Task DeleteDBValueAsync(string dbEntryQuery, CancellationToken ct = default(CancellationToken)) { MozuClient response; var client = Mozu.Api.Clients.Platform.UserDataClient.DeleteDBValueClient( dbEntryQuery); client.WithContext(_apiContext); - response = await client.ExecuteAsync(); + response = await client.ExecuteAsync(ct).ConfigureAwait(false); } diff --git a/Mozu.Api/Security/AppAuthenticator.cs b/Mozu.Api/Security/AppAuthenticator.cs index 82cc77c2..13cab91a 100644 --- a/Mozu.Api/Security/AppAuthenticator.cs +++ b/Mozu.Api/Security/AppAuthenticator.cs @@ -26,7 +26,7 @@ public sealed class AppAuthenticator private RefreshInterval _refreshInterval = null; private static ILogger _log = LogManager.GetLogger(typeof(AppAuthenticator)); - private static SemaphoreSlim _semaphoreWaiter = new SemaphoreSlim(10); + private static SemaphoreSlim _semaphoreWaiter = new SemaphoreSlim(1); /// /// The application auth ticket diff --git a/Mozu.Api/Security/CustomerAuthenticator.cs b/Mozu.Api/Security/CustomerAuthenticator.cs index 50dc0074..57c65b25 100644 --- a/Mozu.Api/Security/CustomerAuthenticator.cs +++ b/Mozu.Api/Security/CustomerAuthenticator.cs @@ -20,29 +20,31 @@ public class CustomerAuthenticationProfile public class CustomerAuthenticator { - public static AuthTicket EnsureAuthTicket(AuthTicket authTicket) + public static async Task EnsureAuthTicket(AuthTicket authTicket) { + if (DateTime.UtcNow >= authTicket.AccessTokenExpiration.AddSeconds(-180)) - return RefreshUserAuthTicket(authTicket).AuthTicket; + return (await RefreshUserAuthTicket(authTicket).ConfigureAwait(false)).AuthTicket; return null; } - private static string GetAuthUrl(int tenantId) + private static async Task GetAuthUrl(int tenantId) { var tenantResource = new TenantResource(); - var tenant = tenantResource.GetTenant(tenantId); + var tenant = await tenantResource.GetTenantAsync(tenantId).ConfigureAwait(false); return HttpHelper.GetUrl(tenant.Domain); } - public static CustomerAuthenticationProfile RefreshUserAuthTicket(AuthTicket authTicket) + public static async Task RefreshUserAuthTicket(AuthTicket authTicket) { var resourceUrl = CustomerAuthTicketUrl.RefreshUserAuthTicketUrl(authTicket.RefreshToken).Url; - var client = new HttpClient { BaseAddress = new Uri(GetAuthUrl(authTicket.TenantId.Value)) }; + var authUrl = await GetAuthUrl(authTicket.TenantId.Value).ConfigureAwait(false); + var client = new HttpClient { BaseAddress = new Uri(authUrl) }; AppAuthenticator.AddHeader(client); if (authTicket.SiteId.HasValue) @@ -59,13 +61,13 @@ public static CustomerAuthenticationProfile RefreshUserAuthTicket(AuthTicket aut - public static CustomerAuthenticationProfile Authenticate(CustomerUserAuthInfo customerUserAuthInfo, + public static async Task Authenticate(CustomerUserAuthInfo customerUserAuthInfo, int tenantId, int siteId) { var resourceUrl = CustomerAuthTicketUrl.CreateUserAuthTicketUrl().Url; - - var client = new HttpClient { BaseAddress = new Uri(GetAuthUrl(tenantId)) }; + var authUrl = await GetAuthUrl(tenantId).ConfigureAwait(false); + var client = new HttpClient { BaseAddress = new Uri(authUrl) }; client.DefaultRequestHeaders.Add(Headers.X_VOL_SITE, siteId.ToString()); diff --git a/Mozu.Api/Urls/Commerce/Admin/LocationTypeUrl.cs b/Mozu.Api/Urls/Commerce/Admin/LocationTypeUrl.cs old mode 100644 new mode 100755 index 46507f4c..2d7f2035 --- a/Mozu.Api/Urls/Commerce/Admin/LocationTypeUrl.cs +++ b/Mozu.Api/Urls/Commerce/Admin/LocationTypeUrl.cs @@ -33,7 +33,7 @@ public static MozuUrl GetLocationTypesUrl() /// Get Resource Url for GetLocationType /// /// The user-defined code that identifies the location type. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -49,7 +49,7 @@ public static MozuUrl GetLocationTypeUrl(string locationTypeCode, string respons /// /// Get Resource Url for AddLocationType /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -65,7 +65,7 @@ public static MozuUrl AddLocationTypeUrl(string responseFields = null) /// Get Resource Url for UpdateLocationType /// /// The user-defined code that identifies the location type. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -81,7 +81,7 @@ public static MozuUrl UpdateLocationTypeUrl(string locationTypeCode, string resp /// /// Get Resource Url for DeleteLocationType /// - /// The user-defined code that identifies the location type. + /// User-defined code used to identify the location type. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Admin/LocationUrl.cs b/Mozu.Api/Urls/Commerce/Admin/LocationUrl.cs old mode 100644 new mode 100755 index 2f81e77c..38e896e1 --- a/Mozu.Api/Urls/Commerce/Admin/LocationUrl.cs +++ b/Mozu.Api/Urls/Commerce/Admin/LocationUrl.cs @@ -19,11 +19,11 @@ public partial class LocationUrl /// /// Get Resource Url for GetLocations /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetLocationsUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetLocation /// - /// The unique, user-defined code that identifies a location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// The merchant-defined code of the location to retrieve. + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetLocationUrl(string locationCode, string responseFields /// /// Get Resource Url for AddLocation /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -74,8 +74,8 @@ public static MozuUrl AddLocationUrl(string responseFields = null) /// /// Get Resource Url for UpdateLocation /// - /// The unique, user-defined code that identifies a location. - /// Use this field to include those fields which are not included by default. + /// The merchant-defined code associated with the location to update. + /// /// /// String - Resource Url /// @@ -91,7 +91,7 @@ public static MozuUrl UpdateLocationUrl(string locationCode, string responseFiel /// /// Get Resource Url for DeleteLocation /// - /// The unique, user-defined code that identifies a location. + /// The merchant-defined code of the location to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Admin/Locations/Attributedefinition/AttributeUrl.cs b/Mozu.Api/Urls/Commerce/Admin/Locations/Attributedefinition/AttributeUrl.cs new file mode 100755 index 00000000..ea096017 --- /dev/null +++ b/Mozu.Api/Urls/Commerce/Admin/Locations/Attributedefinition/AttributeUrl.cs @@ -0,0 +1,109 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Commerce.Admin.Locations.Attributedefinition +{ + public partial class AttributeUrl + { + + /// + /// Get Resource Url for GetAttributes + /// + /// + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetAttributesUrl(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + { + var url = "/api/commerce/admin/locations/attributedefinition/attributes/?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "filter", filter); + mozuUrl.FormatUrl( "pageSize", pageSize); + mozuUrl.FormatUrl( "responseFields", responseFields); + mozuUrl.FormatUrl( "sortBy", sortBy); + mozuUrl.FormatUrl( "startIndex", startIndex); + return mozuUrl; + } + + /// + /// Get Resource Url for GetAttributeVocabularyValues + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetAttributeVocabularyValuesUrl(string attributeFQN) + { + var url = "/api/commerce/admin/locations/attributedefinition/attributes/{attributeFQN}/VocabularyValues"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "attributeFQN", attributeFQN); + return mozuUrl; + } + + /// + /// Get Resource Url for GetAttribute + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetAttributeUrl(string attributeFQN, string responseFields = null) + { + var url = "/api/commerce/admin/locations/attributedefinition/attributes/{attributeFQN}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "attributeFQN", attributeFQN); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for CreateAttribute + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl CreateAttributeUrl(string responseFields = null) + { + var url = "/api/commerce/admin/locations/attributedefinition/attributes/?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdateAttribute + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdateAttributeUrl(string attributeFQN, string responseFields = null) + { + var url = "/api/commerce/admin/locations/attributedefinition/attributes/{attributeFQN}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "attributeFQN", attributeFQN); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Commerce/CartUrl.cs b/Mozu.Api/Urls/Commerce/CartUrl.cs old mode 100644 new mode 100755 index e822ce74..18411b71 --- a/Mozu.Api/Urls/Commerce/CartUrl.cs +++ b/Mozu.Api/Urls/Commerce/CartUrl.cs @@ -19,8 +19,8 @@ public partial class CartUrl /// /// Get Resource Url for GetCart /// - /// Identifier of the cart to delete. - /// Use this field to include those fields which are not included by default. + /// Identifier of the cart to retrieve. + /// /// /// String - Resource Url /// @@ -36,7 +36,7 @@ public static MozuUrl GetCartUrl(string cartId, string responseFields = null) /// /// Get Resource Url for GetOrCreateCart /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -51,7 +51,7 @@ public static MozuUrl GetOrCreateCartUrl(string responseFields = null) /// /// Get Resource Url for GetCartSummary /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -66,8 +66,8 @@ public static MozuUrl GetCartSummaryUrl(string responseFields = null) /// /// Get Resource Url for GetUserCartSummary /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. + /// + /// Unique identifier of the user whose cart details you want to retrieve. /// /// String - Resource Url /// @@ -83,8 +83,8 @@ public static MozuUrl GetUserCartSummaryUrl(string userId, string responseFields /// /// Get Resource Url for GetUserCart /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. + /// + /// Unique identifier of the user whose cart you want to retrieve. /// /// String - Resource Url /// @@ -100,7 +100,7 @@ public static MozuUrl GetUserCartUrl(string userId, string responseFields = nul /// /// Get Resource Url for UpdateCart /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Carts/AppliedDiscountUrl.cs b/Mozu.Api/Urls/Commerce/Carts/AppliedDiscountUrl.cs old mode 100644 new mode 100755 index 544482e5..517f739d --- a/Mozu.Api/Urls/Commerce/Carts/AppliedDiscountUrl.cs +++ b/Mozu.Api/Urls/Commerce/Carts/AppliedDiscountUrl.cs @@ -19,9 +19,9 @@ public partial class AppliedDiscountUrl /// /// Get Resource Url for ApplyCoupon /// - /// Identifier of the cart to delete. - /// Code associated with the coupon to remove from the cart. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the cart to which to apply the coupon. + /// Code associated with the coupon to apply to the cart. + /// /// /// String - Resource Url /// @@ -38,7 +38,7 @@ public static MozuUrl ApplyCouponUrl(string cartId, string couponCode, string re /// /// Get Resource Url for RemoveCoupons /// - /// Identifier of the cart to delete. + /// Unique identifier of the cart. /// /// String - Resource Url /// @@ -53,7 +53,7 @@ public static MozuUrl RemoveCouponsUrl(string cartId) /// /// Get Resource Url for RemoveCoupon /// - /// Identifier of the cart to delete. + /// Unique identifier of the cart. /// Code associated with the coupon to remove from the cart. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Commerce/Carts/CartItemUrl.cs b/Mozu.Api/Urls/Commerce/Carts/CartItemUrl.cs old mode 100644 new mode 100755 index de5d3f64..acf4ecc5 --- a/Mozu.Api/Urls/Commerce/Carts/CartItemUrl.cs +++ b/Mozu.Api/Urls/Commerce/Carts/CartItemUrl.cs @@ -19,8 +19,8 @@ public partial class CartItemUrl /// /// Get Resource Url for GetCartItem /// - /// Identifier of the cart item to delete. - /// Use this field to include those fields which are not included by default. + /// Identifier of the cart item to retrieve. + /// /// /// String - Resource Url /// @@ -36,7 +36,7 @@ public static MozuUrl GetCartItemUrl(string cartItemId, string responseFields = /// /// Get Resource Url for GetCartItems /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -51,7 +51,7 @@ public static MozuUrl GetCartItemsUrl(string responseFields = null) /// /// Get Resource Url for AddItemToCart /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -66,9 +66,9 @@ public static MozuUrl AddItemToCartUrl(string responseFields = null) /// /// Get Resource Url for UpdateCartItemQuantity /// - /// Identifier of the cart item to delete. + /// Identifier of the cart item to update quantity. /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -85,8 +85,8 @@ public static MozuUrl UpdateCartItemQuantityUrl(string cartItemId, int quantity, /// /// Get Resource Url for UpdateCartItem /// - /// Identifier of the cart item to delete. - /// Use this field to include those fields which are not included by default. + /// Identifier of the cart item to update. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Carts/ChangeMessageUrl.cs b/Mozu.Api/Urls/Commerce/Carts/ChangeMessageUrl.cs old mode 100644 new mode 100755 index c798c026..e9cdcdff --- a/Mozu.Api/Urls/Commerce/Carts/ChangeMessageUrl.cs +++ b/Mozu.Api/Urls/Commerce/Carts/ChangeMessageUrl.cs @@ -19,7 +19,7 @@ public partial class ChangeMessageUrl /// /// Get Resource Url for GetMessages /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Carts/ExtendedPropertyUrl.cs b/Mozu.Api/Urls/Commerce/Carts/ExtendedPropertyUrl.cs old mode 100644 new mode 100755 index d866b5a8..dc1a96c8 --- a/Mozu.Api/Urls/Commerce/Carts/ExtendedPropertyUrl.cs +++ b/Mozu.Api/Urls/Commerce/Carts/ExtendedPropertyUrl.cs @@ -45,9 +45,9 @@ public static MozuUrl AddExtendedPropertiesUrl() /// /// Get Resource Url for UpdateExtendedProperty /// - /// Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Any set of key value pairs to be stored in the extended properties of a cart. + /// + /// + /// /// /// String - Resource Url /// @@ -64,7 +64,7 @@ public static MozuUrl UpdateExtendedPropertyUrl(string key, bool? upsert = null /// /// Get Resource Url for UpdateExtendedProperties /// - /// Any set of key value pairs to be stored in the extended properties of a cart. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/AttributeUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/AttributeUrl.cs old mode 100644 new mode 100755 index ae3cb4ae..a6c6eccd --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/AttributeUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/AttributeUrl.cs @@ -19,9 +19,9 @@ public partial class AttributeUrl /// /// Get Resource Url for GetAttributes /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -42,8 +42,8 @@ public static MozuUrl GetAttributesUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetAttribute /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetAttributeUrl(string attributeFQN, string responseFields /// /// Get Resource Url for AddAttribute /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,8 +74,8 @@ public static MozuUrl AddAttributeUrl(string responseFields = null) /// /// Get Resource Url for UpdateAttribute /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -91,7 +91,7 @@ public static MozuUrl UpdateAttributeUrl(string attributeFQN, string responseFie /// /// Get Resource Url for DeleteAttribute /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentUrl.cs old mode 100644 new mode 100755 index c91bb830..67a8242d --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeLocalizedContentUrl.cs @@ -19,7 +19,7 @@ public partial class AttributeLocalizedContentUrl /// /// Get Resource Url for GetAttributeLocalizedContents /// - /// Fully qualified name for an attribute. + /// /// /// String - Resource Url /// @@ -34,9 +34,9 @@ public static MozuUrl GetAttributeLocalizedContentsUrl(string attributeFQN) /// /// Get Resource Url for GetAttributeLocalizedContent /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -53,8 +53,8 @@ public static MozuUrl GetAttributeLocalizedContentUrl(string attributeFQN, strin /// /// Get Resource Url for AddLocalizedContent /// - /// Fully qualified name for an attribute. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -70,7 +70,7 @@ public static MozuUrl AddLocalizedContentUrl(string attributeFQN, string respons /// /// Get Resource Url for UpdateLocalizedContents /// - /// Fully qualified name for an attribute. + /// /// /// String - Resource Url /// @@ -85,9 +85,9 @@ public static MozuUrl UpdateLocalizedContentsUrl(string attributeFQN) /// /// Get Resource Url for UpdateLocalizedContent /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -104,8 +104,8 @@ public static MozuUrl UpdateLocalizedContentUrl(string attributeFQN, string loca /// /// Get Resource Url for DeleteLocalizedContent /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleUrl.cs old mode 100644 new mode 100755 index 791db734..32624697 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeTypeRuleUrl.cs @@ -19,9 +19,9 @@ public partial class AttributeTypeRuleUrl /// /// Get Resource Url for GetAttributeTypeRules /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueUrl.cs old mode 100644 new mode 100755 index b53f5bbd..ab4b3704 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Attributes/AttributeVocabularyValueUrl.cs @@ -19,7 +19,7 @@ public partial class AttributeVocabularyValueUrl /// /// Get Resource Url for GetAttributeVocabularyValues /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// String - Resource Url /// @@ -34,8 +34,8 @@ public static MozuUrl GetAttributeVocabularyValuesUrl(string attributeFQN) /// /// Get Resource Url for GetAttributeVocabularyValueLocalizedContents /// - /// Fully qualified name for an attribute. - /// The value string to create. + /// + /// /// /// String - Resource Url /// @@ -51,10 +51,10 @@ public static MozuUrl GetAttributeVocabularyValueLocalizedContentsUrl(string att /// /// Get Resource Url for GetAttributeVocabularyValueLocalizedContent /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -72,9 +72,9 @@ public static MozuUrl GetAttributeVocabularyValueLocalizedContentUrl(string attr /// /// Get Resource Url for GetAttributeVocabularyValue /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// The actual unique value of the attribute vocabulary to retrieve. A single attribute must have a unique value and match the attribute's data type. If a string value returns null, the system will generate a value. The actual string content displayed shoud be stored as "Content" and actual content is required for string values. /// /// String - Resource Url /// @@ -91,9 +91,9 @@ public static MozuUrl GetAttributeVocabularyValueUrl(string attributeFQN, string /// /// Get Resource Url for AddAttributeVocabularyValueLocalizedContent /// - /// Fully qualified name for an attribute. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// /// /// String - Resource Url /// @@ -110,8 +110,8 @@ public static MozuUrl AddAttributeVocabularyValueLocalizedContentUrl(string attr /// /// Get Resource Url for AddAttributeVocabularyValue /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -127,7 +127,7 @@ public static MozuUrl AddAttributeVocabularyValueUrl(string attributeFQN, string /// /// Get Resource Url for UpdateAttributeVocabularyValues /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// String - Resource Url /// @@ -142,8 +142,8 @@ public static MozuUrl UpdateAttributeVocabularyValuesUrl(string attributeFQN) /// /// Get Resource Url for UpdateAttributeVocabularyValueLocalizedContents /// - /// Fully qualified name for an attribute. - /// The value string to create. + /// + /// /// /// String - Resource Url /// @@ -159,10 +159,10 @@ public static MozuUrl UpdateAttributeVocabularyValueLocalizedContentsUrl(string /// /// Get Resource Url for UpdateAttributeVocabularyValueLocalizedContent /// - /// Fully qualified name for an attribute. - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -180,9 +180,9 @@ public static MozuUrl UpdateAttributeVocabularyValueLocalizedContentUrl(string a /// /// Get Resource Url for UpdateAttributeVocabularyValue /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// The actual unique value of the attribute vocabulary value to update. A single attribute must have a unique value and match the attribute's data type. If a string value returns null, the system will generate a value. The actual string content displayed shoud be stored as "Content" and actual content is required for string values. /// /// String - Resource Url /// @@ -199,8 +199,8 @@ public static MozuUrl UpdateAttributeVocabularyValueUrl(string attributeFQN, str /// /// Get Resource Url for DeleteAttributeVocabularyValue /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The value string to create. + /// + /// The actual unique value of the attribute vocabulary to delete. A single attribute must have a unique value and match the attribute's data type. If a string value returns null, the system will generate a value. The actual string content displayed shoud be stored as "Content" and actual content is required for string values. /// /// String - Resource Url /// @@ -216,9 +216,9 @@ public static MozuUrl DeleteAttributeVocabularyValueUrl(string attributeFQN, str /// /// Get Resource Url for DeleteAttributeVocabularyValueLocalizedContent /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The value string to create. + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/ProductTypeUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/ProductTypeUrl.cs old mode 100644 new mode 100755 index eae7bf6f..fe94d282 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/ProductTypeUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/ProductTypeUrl.cs @@ -19,9 +19,9 @@ public partial class ProductTypeUrl /// /// Get Resource Url for GetProductTypes /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product type search results by any of its properties. 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=Name+cont+shoes" + /// + /// /// /// /// @@ -42,8 +42,8 @@ public static MozuUrl GetProductTypesUrl(int? startIndex = null, int? pageSize /// /// Get Resource Url for GetProductType /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// Identifier of the product type to retrieve. + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetProductTypeUrl(int productTypeId, string responseFields /// /// Get Resource Url for AddProductType /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,8 +74,8 @@ public static MozuUrl AddProductTypeUrl(string responseFields = null) /// /// Get Resource Url for UpdateProductType /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// Identifier of the product type to update. + /// /// /// String - Resource Url /// @@ -91,7 +91,7 @@ public static MozuUrl UpdateProductTypeUrl(int productTypeId, string responseFie /// /// Get Resource Url for DeleteProductType /// - /// Identifier of the product type. + /// Identifier of the product type to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraUrl.cs old mode 100644 new mode 100755 index 37534449..36d8e1a2 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeExtraUrl.cs @@ -34,9 +34,9 @@ public static MozuUrl GetExtrasUrl(int productTypeId) /// /// Get Resource Url for GetExtra /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// + /// Identifier of the product type whose extra is being retrieved. + /// /// /// String - Resource Url /// @@ -54,7 +54,7 @@ public static MozuUrl GetExtraUrl(int productTypeId, string attributeFQN, string /// Get Resource Url for AddExtra /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -70,9 +70,9 @@ public static MozuUrl AddExtraUrl(int productTypeId, string responseFields = nu /// /// Get Resource Url for UpdateExtra /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -89,7 +89,7 @@ public static MozuUrl UpdateExtraUrl(int productTypeId, string attributeFQN, str /// /// Get Resource Url for DeleteExtra /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionUrl.cs old mode 100644 new mode 100755 index b6c3dd9f..8c8cc579 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeOptionUrl.cs @@ -19,7 +19,7 @@ public partial class ProductTypeOptionUrl /// /// Get Resource Url for GetOptions /// - /// Identifier of the product type. + /// Identifier of the product type to retrieve. /// /// String - Resource Url /// @@ -34,9 +34,9 @@ public static MozuUrl GetOptionsUrl(int productTypeId) /// /// Get Resource Url for GetOption /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// + /// The identifier of the product type. + /// /// /// String - Resource Url /// @@ -54,7 +54,7 @@ public static MozuUrl GetOptionUrl(int productTypeId, string attributeFQN, strin /// Get Resource Url for AddOption /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -70,9 +70,9 @@ public static MozuUrl AddOptionUrl(int productTypeId, string responseFields = n /// /// Get Resource Url for UpdateOption /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -89,7 +89,7 @@ public static MozuUrl UpdateOptionUrl(int productTypeId, string attributeFQN, st /// /// Get Resource Url for DeleteOption /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyUrl.cs old mode 100644 new mode 100755 index 0dcd6959..ddc93cc3 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypePropertyUrl.cs @@ -34,9 +34,9 @@ public static MozuUrl GetPropertiesUrl(int productTypeId) /// /// Get Resource Url for GetProperty /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -54,7 +54,7 @@ public static MozuUrl GetPropertyUrl(int productTypeId, string attributeFQN, str /// Get Resource Url for AddProperty /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -70,9 +70,9 @@ public static MozuUrl AddPropertyUrl(int productTypeId, string responseFields = /// /// Get Resource Url for UpdateProperty /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -89,7 +89,7 @@ public static MozuUrl UpdatePropertyUrl(int productTypeId, string attributeFQN, /// /// Get Resource Url for DeleteProperty /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// Identifier of the product type. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationUrl.cs old mode 100644 new mode 100755 index 6e0d6942..e701d9a6 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Attributedefinition/Producttypes/ProductTypeVariationUrl.cs @@ -19,13 +19,13 @@ public partial class ProductTypeVariationUrl /// /// Get Resource Url for GenerateProductVariations /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. + /// + /// /// - /// Identifier of the product type. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// Unique identifier of the product type. + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/CategoryUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/CategoryUrl.cs old mode 100644 new mode 100755 index d920f7fd..fc95a85f --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/CategoryUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/CategoryUrl.cs @@ -19,9 +19,9 @@ public partial class CategoryUrl /// /// Get Resource Url for GetCategories /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product category search results by any of its properties, including its position in the category hierarchy. 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" + /// + /// /// /// /// @@ -42,8 +42,8 @@ public static MozuUrl GetCategoriesUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetChildCategories /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the category for which to retrieve subcategories. + /// /// /// String - Resource Url /// @@ -59,8 +59,8 @@ public static MozuUrl GetChildCategoriesUrl(int categoryId, string responseField /// /// Get Resource Url for GetCategory /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the category to retrieve. + /// /// /// String - Resource Url /// @@ -77,8 +77,8 @@ public static MozuUrl GetCategoryUrl(int categoryId, string responseFields = nu /// Get Resource Url for AddCategory /// /// If true, when adding a new product category, set the sequence number of the new category to an increment of one integer greater than the maximum available sequence number across all product categories. If false, set the sequence number to zero. - /// Use this field to include those fields which are not included by default. - /// Optional. If , uses the you specify in the request as the category's id. If , generates an for the category regardless if you specify an id in the request.If you specify an id already in use and set this parameter to , returns an error. + /// + /// /// /// String - Resource Url /// @@ -95,7 +95,7 @@ public static MozuUrl AddCategoryUrl(bool? incrementSequence = null, bool? useP /// /// Get Resource Url for ValidateDynamicExpression /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -110,7 +110,7 @@ public static MozuUrl ValidateDynamicExpressionUrl(string responseFields = null /// /// Get Resource Url for ValidateRealTimeDynamicExpression /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -125,9 +125,9 @@ public static MozuUrl ValidateRealTimeDynamicExpressionUrl(string responseFields /// /// Get Resource Url for UpdateCategory /// - /// If true, when changing the display option for the category, change it for all subcategories also. The default value is false. + /// If true, when changing the display option for the category, change it for all subcategories also. Default: False. /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -144,10 +144,10 @@ public static MozuUrl UpdateCategoryUrl(int categoryId, bool? cascadeVisibility /// /// Get Resource Url for DeleteCategoryById /// - /// Specifies whether to also delete all subcategories associated with the specified category.If you set this value is false, only the specified category is deleted.The default value is false. - /// Unique identifier of the category to modify. - /// Specifies whether the category, and any associated subcategories, are deleted even if there are products that reference them. The default value is false. - /// Specifies whether any subcategories of the specified category are reassigned to the parent of the specified category.This field only applies if the cascadeDelete parameter is false.The default value is false. + /// If true, also delete all subcategories associated with the specified category. + /// Unique identifier of the category to delete. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/CouponSetUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/CouponSetUrl.cs old mode 100644 new mode 100755 index 7cbb2503..429fcace --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/CouponSetUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/CouponSetUrl.cs @@ -19,12 +19,12 @@ public partial class CouponSetUrl /// /// Get Resource Url for GetCouponSets /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Specifies whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts in the response body. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -44,9 +44,9 @@ public static MozuUrl GetCouponSetsUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetCouponSet /// - /// The unique identifier of the coupon set. - /// Specifies whether to include the number of redeemed coupons, existing coupon codes, and assigned discounts in the response body. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// String - Resource Url /// @@ -63,7 +63,7 @@ public static MozuUrl GetCouponSetUrl(string couponSetCode, bool? includeCounts /// /// Get Resource Url for GetUniqueCouponSetCode /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -78,7 +78,7 @@ public static MozuUrl GetUniqueCouponSetCodeUrl(string responseFields = null) /// /// Get Resource Url for AddCouponSet /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -93,7 +93,7 @@ public static MozuUrl AddCouponSetUrl(string responseFields = null) /// /// Get Resource Url for ValidateUniqueCouponSetCode /// - /// User-defined code that uniqely identifies the channel group. + /// /// /// String - Resource Url /// @@ -108,8 +108,8 @@ public static MozuUrl ValidateUniqueCouponSetCodeUrl(string code) /// /// Get Resource Url for UpdateCouponSet /// - /// The unique identifier of the coupon set. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -125,7 +125,7 @@ public static MozuUrl UpdateCouponSetUrl(string couponSetCode, string responseFi /// /// Get Resource Url for DeleteCouponSet /// - /// The unique identifier of the coupon set. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Couponsets/AssignedDiscountUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Couponsets/AssignedDiscountUrl.cs old mode 100644 new mode 100755 index efef4c8a..dff05a19 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Couponsets/AssignedDiscountUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Couponsets/AssignedDiscountUrl.cs @@ -19,7 +19,7 @@ public partial class AssignedDiscountUrl /// /// Get Resource Url for GetAssignedDiscounts /// - /// The unique identifier of the coupon set. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl GetAssignedDiscountsUrl(string couponSetCode) /// /// Get Resource Url for AssignDiscount /// - /// The unique identifier of the coupon set. + /// /// /// String - Resource Url /// @@ -49,8 +49,8 @@ public static MozuUrl AssignDiscountUrl(string couponSetCode) /// /// Get Resource Url for UnAssignDiscount /// - /// The unique identifier of the coupon set. - /// discountId parameter description DOCUMENT_HERE + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Couponsets/CouponUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Couponsets/CouponUrl.cs old mode 100644 new mode 100755 index 8ac3d9fc..a7e34cb8 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Couponsets/CouponUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Couponsets/CouponUrl.cs @@ -19,10 +19,10 @@ public partial class CouponUrl /// /// Get Resource Url for GetCoupon /// - /// Code associated with the coupon to remove from the cart. - /// The unique identifier of the coupon set that the coupon belongs to. - /// Specifies whether to return the redemptionCount property in the response body object. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -40,13 +40,13 @@ public static MozuUrl GetCouponUrl(string couponSetCode, string couponCode, bool /// /// Get Resource Url for GetCoupons /// - /// The unique identifier of the coupon set that the coupons belongs to. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Specifies whether to include the redemptionCount property in the response body object. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -67,7 +67,7 @@ public static MozuUrl GetCouponsUrl(string couponSetCode, int? startIndex = nul /// /// Get Resource Url for AddCoupons /// - /// The unique identifier of the coupon set. + /// /// /// String - Resource Url /// @@ -82,7 +82,7 @@ public static MozuUrl AddCouponsUrl(string couponSetCode) /// /// Get Resource Url for DeleteCoupons /// - /// The unique identifier of the coupon set that the coupon belongs to. + /// /// /// String - Resource Url /// @@ -97,8 +97,8 @@ public static MozuUrl DeleteCouponsUrl(string couponSetCode) /// /// Get Resource Url for DeleteCoupon /// - /// Code associated with the coupon to remove from the cart. - /// The unique identifier of the coupon set that the coupon belongs to. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/DiscountSettingsUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/DiscountSettingsUrl.cs new file mode 100755 index 00000000..73d2d50e --- /dev/null +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/DiscountSettingsUrl.cs @@ -0,0 +1,56 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Commerce.Catalog.Admin +{ + public partial class DiscountSettingsUrl + { + + /// + /// Get Resource Url for GetDiscountSettings + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetDiscountSettingsUrl(int catalogId, string responseFields = null) + { + var url = "/api/commerce/catalog/admin/discountsettings/{catalogId}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "catalogId", catalogId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdateDiscountSettings + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdateDiscountSettingsUrl(int catalogId, string responseFields = null) + { + var url = "/api/commerce/catalog/admin/discountsettings/{catalogId}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "catalogId", catalogId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/DiscountUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/DiscountUrl.cs old mode 100644 new mode 100755 index a78b6cb8..f74ad56f --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/DiscountUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/DiscountUrl.cs @@ -19,9 +19,9 @@ public partial class DiscountUrl /// /// Get Resource Url for GetDiscounts /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -42,8 +42,8 @@ public static MozuUrl GetDiscountsUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetDiscountContent /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read-only. + /// /// /// String - Resource Url /// @@ -59,8 +59,8 @@ public static MozuUrl GetDiscountContentUrl(int discountId, string responseField /// /// Get Resource Url for GetDiscount /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read-only. + /// /// /// String - Resource Url /// @@ -76,7 +76,7 @@ public static MozuUrl GetDiscountUrl(int discountId, string responseFields = nu /// /// Get Resource Url for GenerateRandomCoupon /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -91,7 +91,7 @@ public static MozuUrl GenerateRandomCouponUrl(string responseFields = null) /// /// Get Resource Url for CreateDiscount /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -106,8 +106,8 @@ public static MozuUrl CreateDiscountUrl(string responseFields = null) /// /// Get Resource Url for UpdateDiscountContent /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read-only. + /// /// /// String - Resource Url /// @@ -123,8 +123,8 @@ public static MozuUrl UpdateDiscountContentUrl(int discountId, string responseFi /// /// Get Resource Url for UpdateDiscount /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount to update. + /// /// /// String - Resource Url /// @@ -140,7 +140,7 @@ public static MozuUrl UpdateDiscountUrl(int discountId, string responseFields = /// /// Get Resource Url for DeleteDiscount /// - /// discountId parameter description DOCUMENT_HERE + /// Unique identifier of the discount. System-supplied and read-only. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Discounts/DiscountTargetUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Discounts/DiscountTargetUrl.cs old mode 100644 new mode 100755 index 917ea6a4..5005f41e --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Discounts/DiscountTargetUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Discounts/DiscountTargetUrl.cs @@ -19,8 +19,8 @@ public partial class DiscountTargetUrl /// /// Get Resource Url for GetDiscountTarget /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read only. + /// /// /// String - Resource Url /// @@ -36,8 +36,8 @@ public static MozuUrl GetDiscountTargetUrl(int discountId, string responseFields /// /// Get Resource Url for UpdateDiscountTarget /// - /// discountId parameter description DOCUMENT_HERE - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the discount. System-supplied and read-only. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/FacetUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/FacetUrl.cs old mode 100644 new mode 100755 index b3f9f03a..65616c91 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/FacetUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/FacetUrl.cs @@ -20,7 +20,7 @@ public partial class FacetUrl /// Get Resource Url for GetFacet /// /// Unique identifier of the facet to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// Validates that the product category associated with a facet is active. System-supplied and read only. /// /// String - Resource Url @@ -38,9 +38,9 @@ public static MozuUrl GetFacetUrl(int facetId, bool? validate = null, string re /// /// Get Resource Url for GetFacetCategoryList /// - /// Unique identifier of the category to modify. + /// Unique identifier of the category associated with the facets to retrieve. /// If true, returns a list of the attributes and categories associated with a product type that have not been defined as a facet for the category. - /// Use this field to include those fields which are not included by default. + /// /// Validates that the product category associated with a facet is active. System-supplied and read only. /// /// String - Resource Url @@ -59,7 +59,7 @@ public static MozuUrl GetFacetCategoryListUrl(int categoryId, bool? includeAvail /// /// Get Resource Url for AddFacet /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,8 +74,8 @@ public static MozuUrl AddFacetUrl(string responseFields = null) /// /// Get Resource Url for UpdateFacet /// - /// Unique identifier of the facet to retrieve. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the facet to modify. + /// /// /// String - Resource Url /// @@ -91,7 +91,7 @@ public static MozuUrl UpdateFacetUrl(int facetId, string responseFields = null) /// /// Get Resource Url for DeleteFacetById /// - /// Unique identifier of the facet to retrieve. + /// Unique identifier of the facet to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/LocationInventoryUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/LocationInventoryUrl.cs old mode 100644 new mode 100755 index 0f7648d7..92a8bce5 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/LocationInventoryUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/LocationInventoryUrl.cs @@ -19,9 +19,9 @@ public partial class LocationInventoryUrl /// /// Get Resource Url for GetLocationInventory /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// User-defined code that uniquely identifies the location. + /// + /// /// /// String - Resource Url /// @@ -38,13 +38,13 @@ public static MozuUrl GetLocationInventoryUrl(string locationCode, string produc /// /// Get Resource Url for GetLocationInventories /// - /// 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" - /// Functions that optimize commonly used filters for efficiency.For the operation, you have access to the filter function. For example, use to filter only for product inventory that is currently active. - /// The unique, user-defined code that identifies a location. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -65,8 +65,8 @@ public static MozuUrl GetLocationInventoriesUrl(string locationCode, int? startI /// /// Get Resource Url for AddLocationInventory /// - /// The unique, user-defined code that identifies a location. - /// Query string parameter lets the service perform an update for a new or existing record. When run, the update occurs without throwing a conflict exception that the record exists. If true, the updates completes regardless of the record currently existing. By default, if no value is specified, the service assumes this value is false. + /// User-defined code that uniquely identifies the location. + /// /// /// String - Resource Url /// @@ -82,7 +82,7 @@ public static MozuUrl AddLocationInventoryUrl(string locationCode, bool? perform /// /// Get Resource Url for UpdateLocationInventory /// - /// The unique, user-defined code that identifies a location. + /// User-defined code that uniquely identifies the location. /// /// String - Resource Url /// @@ -97,8 +97,8 @@ public static MozuUrl UpdateLocationInventoryUrl(string locationCode) /// /// Get Resource Url for DeleteLocationInventory /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// User-defined code that uniquely identifies the location. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/MasterCatalogUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/MasterCatalogUrl.cs old mode 100644 new mode 100755 index ec487f5b..a7c6a0b6 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/MasterCatalogUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/MasterCatalogUrl.cs @@ -19,7 +19,7 @@ public partial class MasterCatalogUrl /// /// Get Resource Url for GetMasterCatalogs /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -34,8 +34,8 @@ public static MozuUrl GetMasterCatalogsUrl(string responseFields = null) /// /// Get Resource Url for GetMasterCatalog /// - /// The unique identifier of the master catalog associated with the entity. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -52,7 +52,7 @@ public static MozuUrl GetMasterCatalogUrl(int masterCatalogId, string responseFi /// Get Resource Url for UpdateMasterCatalog /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/PriceListUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/PriceListUrl.cs old mode 100644 new mode 100755 index 370fe1b5..a8489772 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/PriceListUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/PriceListUrl.cs @@ -19,11 +19,11 @@ public partial class PriceListUrl /// /// Get Resource Url for GetPriceLists /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetPriceListsUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetPriceList /// - /// The unique, user-defined code of the price list. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetPriceListUrl(string priceListCode, string responseField /// /// Get Resource Url for AddPriceList /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -74,8 +74,8 @@ public static MozuUrl AddPriceListUrl(string responseFields = null) /// /// Get Resource Url for BulkAddPriceListEntries /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to adding price list entries to the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. + /// + /// /// /// String - Resource Url /// @@ -91,8 +91,8 @@ public static MozuUrl BulkAddPriceListEntriesUrl(bool? publishEvents = null, bo /// /// Get Resource Url for BulkDeletePriceListEntries /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to deleting price list entries from the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. + /// + /// /// /// String - Resource Url /// @@ -108,8 +108,8 @@ public static MozuUrl BulkDeletePriceListEntriesUrl(bool? publishEvents = null, /// /// Get Resource Url for BulkUpdatePriceListEntries /// - /// Disable this property if you expect to encounter unacceptable performance hits related to clearing the cache for each product in the price list entries. Otherwise, leave this property enabled. - /// Disable this property to prevent publishing the event related to updating price list entries in the system. Disabling this property helps you prevent performance delays if you expect the event to trigger the re-indexing of a large number of products, or if you want to postpone the operations of other applications and services listening for the event. + /// + /// /// /// String - Resource Url /// @@ -125,8 +125,8 @@ public static MozuUrl BulkUpdatePriceListEntriesUrl(bool? publishEvents = null, /// /// Get Resource Url for UpdatePriceList /// - /// The unique, user-defined code of the price list. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -142,8 +142,8 @@ public static MozuUrl UpdatePriceListUrl(string priceListCode, string responseFi /// /// Get Resource Url for DeletePriceList /// - /// Specifies whether to deletes all price list entries associated with the price list. - /// The unique, user-defined code of the price list. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Pricelists/PriceListEntryUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Pricelists/PriceListEntryUrl.cs old mode 100644 new mode 100755 index d9d74d91..a85b6aab --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Pricelists/PriceListEntryUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Pricelists/PriceListEntryUrl.cs @@ -19,11 +19,11 @@ public partial class PriceListEntryUrl /// /// Get Resource Url for GetPriceListEntry /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique code of the price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The start date of the price list entry. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,12 +42,12 @@ public static MozuUrl GetPriceListEntryUrl(string priceListCode, string productC /// /// Get Resource Url for GetPriceListEntries /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// The unique code of the price list associated with the price list entry. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -67,8 +67,8 @@ public static MozuUrl GetPriceListEntriesUrl(string priceListCode, int? startInd /// /// Get Resource Url for AddPriceListEntry /// - /// The specified price list to which you want to add the price list entry. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -84,11 +84,11 @@ public static MozuUrl AddPriceListEntryUrl(string priceListCode, string response /// /// Get Resource Url for UpdatePriceListEntry /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique code of the price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The start date of the price list entry. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -107,10 +107,10 @@ public static MozuUrl UpdatePriceListEntryUrl(string priceListCode, string produ /// /// Get Resource Url for DeletePriceListEntry /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The code of the specified price list associated with the price list entry. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The start date of the price list entry. + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/ProductReservationUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/ProductReservationUrl.cs old mode 100644 new mode 100755 index 21884532..4625e6a6 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/ProductReservationUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/ProductReservationUrl.cs @@ -19,10 +19,10 @@ public partial class ProductReservationUrl /// /// Get Resource Url for GetProductReservations /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// + /// + /// Used to page results from a query. Indicates the maximum number of entities to return from a query. Default value: 20. Max value: 200. + /// + /// The element to sort the results by and the order in which the results appear. Either ascending order (a-z) which accepts 'asc' or 'asc' or descending order (z-a) which accepts 'desc' or 'desc'. The sortBy parameter follows an available property. /// /// /// String - Resource Url @@ -43,7 +43,7 @@ public static MozuUrl GetProductReservationsUrl(int? startIndex = null, int? pa /// Get Resource Url for GetProductReservation /// /// Unique identifier of the product reservation. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -87,7 +87,7 @@ public static MozuUrl CommitReservationsUrl() /// /// Get Resource Url for UpdateProductReservations /// - /// If true, skip the process to validate inventory when creating this product reservation. + /// If true, skip the inventory validation process when updating this product reservation. /// /// String - Resource Url /// @@ -102,7 +102,7 @@ public static MozuUrl UpdateProductReservationsUrl(bool? skipInventoryCheck = n /// /// Get Resource Url for DeleteProductReservation /// - /// Unique identifier of the product reservation. + /// Unique identifier of the reservation. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/ProductUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/ProductUrl.cs old mode 100644 new mode 100755 index 233f0089..2fa46592 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/ProductUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/ProductUrl.cs @@ -19,12 +19,12 @@ public partial class ProductUrl /// /// Get Resource Url for GetProducts /// - /// 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" + /// /// If true, the operation does not return the TotalCount number of results. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// + /// A list of product search terms to use in the query when searching across product code and product name. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -48,7 +48,7 @@ public static MozuUrl GetProductsUrl(int? startIndex = null, int? pageSize = n /// /// Get Resource Url for GetProductInCatalogs /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// String - Resource Url /// @@ -63,9 +63,9 @@ public static MozuUrl GetProductInCatalogsUrl(string productCode) /// /// Get Resource Url for GetProductInCatalog /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -82,8 +82,8 @@ public static MozuUrl GetProductInCatalogUrl(string productCode, int catalogId, /// /// Get Resource Url for GetProduct /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -99,7 +99,7 @@ public static MozuUrl GetProductUrl(string productCode, string responseFields = /// /// Get Resource Url for AddProduct /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -114,8 +114,8 @@ public static MozuUrl AddProductUrl(string responseFields = null) /// /// Get Resource Url for AddProductInCatalog /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -144,7 +144,7 @@ public static MozuUrl RenameProductCodesUrl() /// /// Get Resource Url for UpdateProductInCatalogs /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// String - Resource Url /// @@ -159,9 +159,9 @@ public static MozuUrl UpdateProductInCatalogsUrl(string productCode) /// /// Get Resource Url for UpdateProductInCatalog /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -178,8 +178,8 @@ public static MozuUrl UpdateProductInCatalogUrl(string productCode, int catalogI /// /// Get Resource Url for UpdateProduct /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -195,7 +195,7 @@ public static MozuUrl UpdateProductUrl(string productCode, string responseFields /// /// Get Resource Url for DeleteProduct /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// /// /// String - Resource Url /// @@ -210,8 +210,8 @@ public static MozuUrl DeleteProductUrl(string productCode) /// /// Get Resource Url for DeleteProductInCatalog /// - /// The unique identifier of the catalog of products used by a site. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/LocationInventoryUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/LocationInventoryUrl.cs old mode 100644 new mode 100755 index 2c227ab0..aa36bf1c --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/LocationInventoryUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/LocationInventoryUrl.cs @@ -19,12 +19,12 @@ public partial class LocationInventoryUrl /// /// Get Resource Url for GetLocationInventories /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -44,9 +44,9 @@ public static MozuUrl GetLocationInventoriesUrl(string productCode, int? startIn /// /// Get Resource Url for GetLocationInventory /// - /// The unique, user-defined code that identifies a location. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the location. + /// + /// /// /// String - Resource Url /// @@ -63,8 +63,8 @@ public static MozuUrl GetLocationInventoryUrl(string productCode, string locatio /// /// Get Resource Url for AddLocationInventory /// - /// Query string parameter lets the service perform an update for a new or existing record. When run, the update occurs without throwing a conflict exception that the record exists. If true, the updates completes regardless of the record currently existing. By default, if no value is specified, the service assumes this value is false. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// The performUpserts query string parameter lets the service perform an update if the record already exists instead of throwing an already exists conflict exception. PerformUpserts=true means it updates if the record already exists. By default, no value specified means that the service assumes PerformUpserts=false. + /// /// /// String - Resource Url /// @@ -80,7 +80,7 @@ public static MozuUrl AddLocationInventoryUrl(string productCode, bool? performU /// /// Get Resource Url for UpdateLocationInventory /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// The product code of the product for which to update active stock on hand inventory at a specified location. /// /// String - Resource Url /// @@ -95,8 +95,8 @@ public static MozuUrl UpdateLocationInventoryUrl(string productCode) /// /// Get Resource Url for DeleteLocationInventory /// - /// The unique, user-defined code that identifies a location. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// The code that identifies the location for which to delete product inventory. + /// The product code for which to delete a location's inventory. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductExtraUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductExtraUrl.cs old mode 100644 new mode 100755 index 4f29e4c9..88dd91e0 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductExtraUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductExtraUrl.cs @@ -19,7 +19,7 @@ public partial class ProductExtraUrl /// /// Get Resource Url for GetExtras /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// String - Resource Url /// @@ -34,9 +34,9 @@ public static MozuUrl GetExtrasUrl(string productCode) /// /// Get Resource Url for GetExtraValueLocalizedDeltaPrices /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// /// /// String - Resource Url /// @@ -53,11 +53,11 @@ public static MozuUrl GetExtraValueLocalizedDeltaPricesUrl(string productCode, s /// /// Get Resource Url for GetExtraValueLocalizedDeltaPrice /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -76,9 +76,9 @@ public static MozuUrl GetExtraValueLocalizedDeltaPriceUrl(string productCode, st /// /// Get Resource Url for GetExtra /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -95,10 +95,10 @@ public static MozuUrl GetExtraUrl(string productCode, string attributeFQN, strin /// /// Get Resource Url for AddExtraValueLocalizedDeltaPrice /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -116,8 +116,8 @@ public static MozuUrl AddExtraValueLocalizedDeltaPriceUrl(string productCode, st /// /// Get Resource Url for AddExtra /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -133,9 +133,9 @@ public static MozuUrl AddExtraUrl(string productCode, string responseFields = n /// /// Get Resource Url for UpdateExtraValueLocalizedDeltaPrices /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// /// /// String - Resource Url /// @@ -152,11 +152,11 @@ public static MozuUrl UpdateExtraValueLocalizedDeltaPricesUrl(string productCode /// /// Get Resource Url for UpdateExtraValueLocalizedDeltaPrice /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -175,9 +175,9 @@ public static MozuUrl UpdateExtraValueLocalizedDeltaPriceUrl(string productCode, /// /// Get Resource Url for UpdateExtra /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -194,8 +194,8 @@ public static MozuUrl UpdateExtraUrl(string productCode, string attributeFQN, st /// /// Get Resource Url for DeleteExtra /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// + /// /// /// String - Resource Url /// @@ -211,10 +211,10 @@ public static MozuUrl DeleteExtraUrl(string productCode, string attributeFQN) /// /// Get Resource Url for DeleteExtraValueLocalizedDeltaPrice /// - /// Fully qualified name for an attribute. - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductOptionUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductOptionUrl.cs old mode 100644 new mode 100755 index e6a68aec..b756b099 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductOptionUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductOptionUrl.cs @@ -19,7 +19,7 @@ public partial class ProductOptionUrl /// /// Get Resource Url for GetOptions /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// /// String - Resource Url /// @@ -34,9 +34,9 @@ public static MozuUrl GetOptionsUrl(string productCode) /// /// Get Resource Url for GetOption /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -53,8 +53,8 @@ public static MozuUrl GetOptionUrl(string productCode, string attributeFQN, stri /// /// Get Resource Url for AddOption /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -70,9 +70,9 @@ public static MozuUrl AddOptionUrl(string productCode, string responseFields = /// /// Get Resource Url for UpdateOption /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -89,8 +89,8 @@ public static MozuUrl UpdateOptionUrl(string productCode, string attributeFQN, s /// /// Get Resource Url for DeleteOption /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductPropertyUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductPropertyUrl.cs old mode 100644 new mode 100755 index f0816451..2303a74f --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductPropertyUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductPropertyUrl.cs @@ -19,7 +19,7 @@ public partial class ProductPropertyUrl /// /// Get Resource Url for GetProperties /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// /// /// String - Resource Url /// @@ -34,9 +34,9 @@ public static MozuUrl GetPropertiesUrl(string productCode) /// /// Get Resource Url for GetPropertyValueLocalizedContents /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// /// /// String - Resource Url /// @@ -53,11 +53,11 @@ public static MozuUrl GetPropertyValueLocalizedContentsUrl(string productCode, s /// /// Get Resource Url for GetPropertyValueLocalizedContent /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -76,9 +76,9 @@ public static MozuUrl GetPropertyValueLocalizedContentUrl(string productCode, st /// /// Get Resource Url for GetProperty /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -95,10 +95,10 @@ public static MozuUrl GetPropertyUrl(string productCode, string attributeFQN, st /// /// Get Resource Url for AddPropertyValueLocalizedContent /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -116,8 +116,8 @@ public static MozuUrl AddPropertyValueLocalizedContentUrl(string productCode, st /// /// Get Resource Url for AddProperty /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -133,9 +133,9 @@ public static MozuUrl AddPropertyUrl(string productCode, string responseFields = /// /// Get Resource Url for UpdatePropertyValueLocalizedContents /// - /// Fully qualified name for an attribute. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// /// /// String - Resource Url /// @@ -152,11 +152,11 @@ public static MozuUrl UpdatePropertyValueLocalizedContentsUrl(string productCode /// /// Get Resource Url for UpdatePropertyValueLocalizedContent /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// The value string to create. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -175,9 +175,9 @@ public static MozuUrl UpdatePropertyValueLocalizedContentUrl(string productCode, /// /// Get Resource Url for UpdateProperty /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -194,8 +194,8 @@ public static MozuUrl UpdatePropertyUrl(string productCode, string attributeFQN, /// /// Get Resource Url for DeleteProperty /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. + /// + /// /// /// String - Resource Url /// @@ -211,10 +211,10 @@ public static MozuUrl DeletePropertyUrl(string productCode, string attributeFQN) /// /// Get Resource Url for DeletePropertyValueLocalizedContent /// - /// Fully qualified name for an attribute. - /// Language used for the entity. Currently, only "en-US" is supported. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The value string to create. + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductVariationUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductVariationUrl.cs old mode 100644 new mode 100755 index d93e5ee1..c79e5cd4 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductVariationUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/Products/ProductVariationUrl.cs @@ -19,8 +19,8 @@ public partial class ProductVariationUrl /// /// Get Resource Url for GetProductVariationLocalizedDeltaPrices /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// /// /// String - Resource Url /// @@ -36,10 +36,10 @@ public static MozuUrl GetProductVariationLocalizedDeltaPricesUrl(string productC /// /// Get Resource Url for GetProductVariationLocalizedDeltaPrice /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -57,8 +57,8 @@ public static MozuUrl GetProductVariationLocalizedDeltaPriceUrl(string productCo /// /// Get Resource Url for GetProductVariationLocalizedPrices /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// /// /// String - Resource Url /// @@ -74,10 +74,10 @@ public static MozuUrl GetProductVariationLocalizedPricesUrl(string productCode, /// /// Get Resource Url for GetProductVariationLocalizedPrice /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -95,8 +95,8 @@ public static MozuUrl GetProductVariationLocalizedPriceUrl(string productCode, s /// /// Get Resource Url for GetProductVariation /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// System-generated key that represents the attribute values that uniquely identify a specific product variation. /// /// String - Resource Url @@ -114,12 +114,12 @@ public static MozuUrl GetProductVariationUrl(string productCode, string variatio /// /// Get Resource Url for GetProductVariations /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -139,9 +139,9 @@ public static MozuUrl GetProductVariationsUrl(string productCode, int? startInde /// /// Get Resource Url for AddProductVariationLocalizedDeltaPrice /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// /// /// String - Resource Url /// @@ -158,9 +158,9 @@ public static MozuUrl AddProductVariationLocalizedDeltaPriceUrl(string productCo /// /// Get Resource Url for AddProductVariationLocalizedPrice /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// /// /// String - Resource Url /// @@ -177,8 +177,8 @@ public static MozuUrl AddProductVariationLocalizedPriceUrl(string productCode, s /// /// Get Resource Url for UpdateProductVariationLocalizedDeltaPrices /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// /// /// String - Resource Url /// @@ -194,10 +194,10 @@ public static MozuUrl UpdateProductVariationLocalizedDeltaPricesUrl(string produ /// /// Get Resource Url for UpdateProductVariationLocalizedDeltaPrice /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Use this field to include those fields which are not included by default. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -215,8 +215,8 @@ public static MozuUrl UpdateProductVariationLocalizedDeltaPriceUrl(string produc /// /// Get Resource Url for UpdateProductVariationLocalizedPrices /// - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// /// /// String - Resource Url /// @@ -232,10 +232,10 @@ public static MozuUrl UpdateProductVariationLocalizedPricesUrl(string productCod /// /// Get Resource Url for UpdateProductVariationLocalizedPrice /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -253,8 +253,8 @@ public static MozuUrl UpdateProductVariationLocalizedPriceUrl(string productCode /// /// Get Resource Url for UpdateProductVariation /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Use this field to include those fields which are not included by default. + /// + /// /// System-generated key that represents the attribute values that uniquely identify a specific product variation. /// /// String - Resource Url @@ -272,8 +272,8 @@ public static MozuUrl UpdateProductVariationUrl(string productCode, string varia /// /// Get Resource Url for UpdateProductVariations /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -289,7 +289,7 @@ public static MozuUrl UpdateProductVariationsUrl(string productCode, string resp /// /// Get Resource Url for DeleteProductVariation /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. + /// /// System-generated key that represents the attribute values that uniquely identify a specific product variation. /// /// String - Resource Url @@ -306,9 +306,9 @@ public static MozuUrl DeleteProductVariationUrl(string productCode, string varia /// /// Get Resource Url for DeleteProductVariationLocalizedDeltaPrice /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// /// /// String - Resource Url /// @@ -325,9 +325,9 @@ public static MozuUrl DeleteProductVariationLocalizedDeltaPriceUrl(string produc /// /// Get Resource Url for DeleteProductVariationLocalizedPrice /// - /// The three character ISO currency code, such as USD for US Dollars. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// System-generated key that represents the attribute values that uniquely identify a specific product variation. + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/PublishingScopeUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/PublishingScopeUrl.cs old mode 100644 new mode 100755 index 6438c0b7..3b6255cb --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/PublishingScopeUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/PublishingScopeUrl.cs @@ -19,8 +19,8 @@ public partial class PublishingScopeUrl /// /// Get Resource Url for GetPublishSet /// - /// The unique identifier of the publish set. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -36,7 +36,7 @@ public static MozuUrl GetPublishSetUrl(string publishSetCode, string responseFie /// /// Get Resource Url for GetPublishSets /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -77,7 +77,7 @@ public static MozuUrl PublishDraftsUrl() /// /// Get Resource Url for AssignProductsToPublishSet /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -92,8 +92,8 @@ public static MozuUrl AssignProductsToPublishSetUrl(string responseFields = nul /// /// Get Resource Url for DeletePublishSet /// - /// Specifies whether to discard all the drafts assigned to the publish set when the publish set is deleted. - /// The unique identifier of the publish set. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/SearchUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/SearchUrl.cs old mode 100644 new mode 100755 index 7ae071cf..2d53036f --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/SearchUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/SearchUrl.cs @@ -19,8 +19,8 @@ public partial class SearchUrl /// /// Get Resource Url for GetSearchTuningRule /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the search tuning rule. + /// + /// /// /// String - Resource Url /// @@ -36,11 +36,11 @@ public static MozuUrl GetSearchTuningRuleUrl(string searchTuningRuleCode, string /// /// Get Resource Url for GetSearchTuningRules /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetSearchTuningRulesUrl(int? startIndex = null, int? page /// /// Get Resource Url for GetSearchTuningRuleSortFields /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -74,7 +74,7 @@ public static MozuUrl GetSearchTuningRuleSortFieldsUrl(string responseFields = /// /// Get Resource Url for GetSettings /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -89,8 +89,8 @@ public static MozuUrl GetSettingsUrl(string responseFields = null) /// /// Get Resource Url for GetSynonymDefinitionCollection /// - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -106,11 +106,11 @@ public static MozuUrl GetSynonymDefinitionCollectionUrl(string localeCode, strin /// /// Get Resource Url for GetSynonymDefinitions /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -129,8 +129,8 @@ public static MozuUrl GetSynonymDefinitionsUrl(int? startIndex = null, int? pag /// /// Get Resource Url for GetSynonymDefinition /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the synonym definition. + /// + /// /// /// String - Resource Url /// @@ -146,7 +146,7 @@ public static MozuUrl GetSynonymDefinitionUrl(int synonymId, string responseFiel /// /// Get Resource Url for AddSearchTuningRule /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -161,7 +161,7 @@ public static MozuUrl AddSearchTuningRuleUrl(string responseFields = null) /// /// Get Resource Url for UpdateSearchTuningRuleSortFields /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -176,8 +176,8 @@ public static MozuUrl UpdateSearchTuningRuleSortFieldsUrl(string responseFields /// /// Get Resource Url for UpdateSynonymDefinitionCollection /// - /// The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -193,7 +193,7 @@ public static MozuUrl UpdateSynonymDefinitionCollectionUrl(string localeCode, st /// /// Get Resource Url for AddSynonymDefinition /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -208,8 +208,8 @@ public static MozuUrl AddSynonymDefinitionUrl(string responseFields = null) /// /// Get Resource Url for UpdateSearchTuningRule /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the search tuning rule. + /// + /// /// /// String - Resource Url /// @@ -225,7 +225,7 @@ public static MozuUrl UpdateSearchTuningRuleUrl(string searchTuningRuleCode, str /// /// Get Resource Url for UpdateSettings /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -240,8 +240,8 @@ public static MozuUrl UpdateSettingsUrl(string responseFields = null) /// /// Get Resource Url for UpdateSynonymDefinition /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the synonym definition. + /// + /// /// /// String - Resource Url /// @@ -257,7 +257,7 @@ public static MozuUrl UpdateSynonymDefinitionUrl(int synonymId, string responseF /// /// Get Resource Url for DeleteSearchTuningRule /// - /// The unique identifier of the search tuning rule. + /// /// /// String - Resource Url /// @@ -272,7 +272,7 @@ public static MozuUrl DeleteSearchTuningRuleUrl(string searchTuningRuleCode) /// /// Get Resource Url for DeleteSynonymDefinition /// - /// The unique identifier of the synonym definition. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Admin/SoftAllocationUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Admin/SoftAllocationUrl.cs old mode 100644 new mode 100755 index e15bee73..41cf6760 --- a/Mozu.Api/Urls/Commerce/Catalog/Admin/SoftAllocationUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Admin/SoftAllocationUrl.cs @@ -19,11 +19,11 @@ public partial class SoftAllocationUrl /// /// Get Resource Url for GetSoftAllocations /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetSoftAllocationsUrl(int? startIndex = null, int? pageSi /// /// Get Resource Url for GetSoftAllocation /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// The unique identifier of the soft allocation. + /// + /// /// /// String - Resource Url /// @@ -111,7 +111,7 @@ public static MozuUrl UpdateSoftAllocationsUrl() /// /// Get Resource Url for DeleteSoftAllocation /// - /// The unique identifier of the soft allocation. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Storefront/CategoryUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Storefront/CategoryUrl.cs old mode 100644 new mode 100755 index e1b5c2ea..369f6baa --- a/Mozu.Api/Urls/Commerce/Catalog/Storefront/CategoryUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Storefront/CategoryUrl.cs @@ -19,9 +19,9 @@ public partial class CategoryUrl /// /// Get Resource Url for GetCategories /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product category search results by any of its properties, including its position in the category hierarchy. 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" + /// + /// /// /// /// @@ -43,8 +43,8 @@ public static MozuUrl GetCategoriesUrl(string filter = null, int? startIndex = /// Get Resource Url for GetCategory /// /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// Unique identifier for the storefront container used to organize products. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// Unique identifier of the product category. + /// /// /// String - Resource Url /// @@ -61,7 +61,7 @@ public static MozuUrl GetCategoryUrl(int categoryId, bool? allowInactive = null /// /// Get Resource Url for GetCategoryTree /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Storefront/OrderTaxContextUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Storefront/OrderTaxContextUrl.cs old mode 100644 new mode 100755 index ae2760db..c9b49bfb --- a/Mozu.Api/Urls/Commerce/Catalog/Storefront/OrderTaxContextUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Storefront/OrderTaxContextUrl.cs @@ -19,7 +19,7 @@ public partial class OrderTaxContextUrl /// /// Get Resource Url for EstimateTaxes /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Storefront/PriceListUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Storefront/PriceListUrl.cs old mode 100644 new mode 100755 index 639f0e5b..f36eef4b --- a/Mozu.Api/Urls/Commerce/Catalog/Storefront/PriceListUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Storefront/PriceListUrl.cs @@ -19,8 +19,8 @@ public partial class PriceListUrl /// /// Get Resource Url for GetPriceList /// - /// The unique code of the price list for which you want to retrieve the details. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -36,8 +36,8 @@ public static MozuUrl GetPriceListUrl(string priceListCode, string responseField /// /// Get Resource Url for GetResolvedPriceList /// - /// The unique identifier of the customer account for which to retrieve wish lists. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Storefront/ProductSearchResultUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Storefront/ProductSearchResultUrl.cs old mode 100644 new mode 100755 index c0824ec1..472d5ba8 --- a/Mozu.Api/Urls/Commerce/Catalog/Storefront/ProductSearchResultUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Storefront/ProductSearchResultUrl.cs @@ -19,10 +19,10 @@ public partial class ProductSearchResultUrl /// /// Get Resource Url for GetRandomAccessCursor /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -40,31 +40,31 @@ public static MozuUrl GetRandomAccessCursorUrl(string query = null, string filt /// /// Get Resource Url for Search /// - /// In your first deep paged request, set this parameter to . Then, in all subsequent requests, set this parameter to the subsequent values of that's returned in each response to continue paging through the results. Continue this pattern until is null, which signifies the end of the paged results. - /// Enables search tuning rules on your site. + /// + /// /// Individually list the facet fields you want to display in a web storefront product search. /// Display a range facet not specified in a template in a web storefront product search by listing the facet field and the range to display. /// If filtering using category facets in a hierarchy, the number of category hierarchy levels to return for the facet. This option is only available for category facets. /// If filtering using category facets in a hierarchy, the parent categories you want to skip in the storefront product search. This parameter is only available for category facets. /// If filtering using category facets in a hierarchy, the category in the hierarchy to begin faceting on. This parameter is only available for category facets. /// The number of facet values to return for one or more facets. - /// Use this parameter to filter facet values that are returned by an associated search result by a prefix.For example, to filter on colors that start with b, such as blue, black, or brown you can specify the following: + /// /// Settings reserved for future facet search functionality on a web storefront product search. /// When paging through multiple facets, the startIndex value for each facet. /// The facet template to use on the storefront. A template displays all facets associated with the template on the web storefront product search. Currently, only category-level facet templates are available. - /// A comma-separated list of the facets to exclude from the facetTemplate. + /// /// Display a subset of the facets defined in the template specified in facetTemplate parameter. /// The facet values to apply to the filter. - /// Use this parameter to specify facet sorting outside the predefined facet definitions (which require a category). The most common options are:* (default)—Sorts by product count (highest count first).* —Sorts by lexicographic order. In most cases, this means alphabetical order.The following code demonstrates an example of sort: - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Use this field to include those fields which are not included by default. - /// Options you can specify for the response. This parameter is null by default.You can primarily use this parameter to return volume price band information in product details, which you can then display on category pages and search results depanding on your theme configuration. To return volume price band information, set this parameter to . - /// The settings to control product search and indexing behavior. - /// The unique identifier of the search tuning rule. - /// The category ID that the search tuning rule applies to. - /// + /// + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter product search results by any of its properties, including product code, type, category, and name. 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=categoryId+eq+12" + /// Used to page results from a query. Indicates the maximum number of entities to return from a query. Default value: 12. Max value is 200. + /// The terms to search on. + /// + /// + /// + /// + /// + /// The element to sort the results by and the order in which the results appear. Either ascending order (a-z) which accepts 'asc' or 'asc' or descending order (z-a) which accepts 'desc' or 'desc'. The sortBy parameter follows an available property. /// /// /// String - Resource Url @@ -105,10 +105,10 @@ public static MozuUrl SearchUrl(string query = null, string filter = null, str /// /// Get Resource Url for Suggest /// - /// Specifies the group that you want this operation to return in the response. This parameter accepts one or more values, separated by comma.For example, if you set this parameter to , then this operation returns a object that contains suggestions for products that match the user entered characters in the search field.The valid values for this parameter are the following:* — Indicates that products should be matched against and returned in the response. The search value is compared against product name and code. The response contains a with a name of and a collection of . Each collection item has a of Product and contains a equal to a complete product object.* — Indicates that categories should be matched against and returned in the response. The search value is compared to category name. The response contains a with a name of and a collection of . Each collection item has a of Category and contains a equal to a complete category object.* — Indicates that previously used search terms (keywords) should be matched against and returned in the response, sorted by frequency of use. Keep in mind that it is not currently possible to edit or remove search terms that may be considered undesirable via the API. The response contains a with a name of and a collection of . Each collection item has a of Term and contains a equal to a string value of the matched search term.The default value is ; however, the Core Theme only integrates and ignores the group.This operation only returns data that is then made available to your theme. If you set this paramter to multiple values, returns multiple in the response. Depending on your requirements, you can then customize your theme to display the groups together or as separate lists in the displayed search suggestions. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Properties for the product location inventory provided for queries to locate products by their location. - /// Use this field to include those fields which are not included by default. + /// + /// Indicates the maximum number of entities to return from a query. Default value: 10. Max value: 200. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Storefront/ProductUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Storefront/ProductUrl.cs old mode 100644 new mode 100755 index 34c67b95..1502778f --- a/Mozu.Api/Urls/Commerce/Catalog/Storefront/ProductUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Storefront/ProductUrl.cs @@ -19,11 +19,11 @@ public partial class ProductUrl /// /// Get Resource Url for GetProducts /// - /// In your first deep paged request, set this parameter to . Then, in all subsequent requests, set this parameter to the subsequent values of that's returned in each response to continue paging through the results. Continue this pattern until is null, which signifies the end of the paged results. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Options you can specify for the response. This parameter is null by default.You can primarily use this parameter to return volume price band information in product details, which you can then display on category pages and search results depanding on your theme configuration. To return volume price band information, set this parameter to . + /// + /// + /// Used to page results from a query. Indicates the maximum number of entities to return from a single query. Default value: 20. Maximum value: 200. + /// + /// /// /// /// @@ -47,8 +47,8 @@ public static MozuUrl GetProductsUrl(string filter = null, int? startIndex = n /// Get Resource Url for GetProductInventory /// /// Array of location codes for which to retrieve product inventory information. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -65,24 +65,26 @@ public static MozuUrl GetProductInventoryUrl(string productCode, string location /// /// Get Resource Url for GetProduct /// - /// Specifies whether to accept a product variant's code as the .When you set this parameter to , you can pass in a product variant's code in the GetProduct call to retrieve the product variant details that are associated with the base product. - /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. - /// Specifies whether to supress the 404 error when the product is out of stock. + /// + /// If true, returns an inactive product as part of the query. + /// + /// + /// + /// + /// If true, skip the inventory validation process for the specified product. + /// /// Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. /// /// String - Resource Url /// - public static MozuUrl GetProductUrl(string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, int? quantity = null, bool? acceptVariantProductCode = null, string responseFields = null) + public static MozuUrl GetProductUrl(string productCode, string variationProductCode = null, bool? allowInactive = null, bool? skipInventoryCheck = null, bool? supressOutOfStock404 = null, int? quantity = null, bool? acceptVariantProductCode = null, string purchaseLocation = null, string responseFields = null) { - var url = "/api/commerce/catalog/storefront/products/{productCode}?variationProductCode={variationProductCode}&allowInactive={allowInactive}&skipInventoryCheck={skipInventoryCheck}&supressOutOfStock404={supressOutOfStock404}&quantity={quantity}&acceptVariantProductCode={acceptVariantProductCode}&responseFields={responseFields}"; + var url = "/api/commerce/catalog/storefront/products/{productCode}?variationProductCode={variationProductCode}&allowInactive={allowInactive}&skipInventoryCheck={skipInventoryCheck}&supressOutOfStock404={supressOutOfStock404}&quantity={quantity}&acceptVariantProductCode={acceptVariantProductCode}&purchaseLocation={purchaseLocation}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; mozuUrl.FormatUrl( "acceptVariantProductCode", acceptVariantProductCode); mozuUrl.FormatUrl( "allowInactive", allowInactive); mozuUrl.FormatUrl( "productCode", productCode); + mozuUrl.FormatUrl( "purchaseLocation", purchaseLocation); mozuUrl.FormatUrl( "quantity", quantity); mozuUrl.FormatUrl( "responseFields", responseFields); mozuUrl.FormatUrl( "skipInventoryCheck", skipInventoryCheck); @@ -94,16 +96,16 @@ public static MozuUrl GetProductUrl(string productCode, string variationProductC /// /// Get Resource Url for GetProductForIndexing /// - /// The date when the product was last updated. - /// The unique, user-defined product code of a product, used throughout to reference and associate to a product. - /// The product version. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// String - Resource Url /// public static MozuUrl GetProductForIndexingUrl(string productCode, long? productVersion = null, DateTime? lastModifiedDate = null, string responseFields = null) { - var url = "/api/commerce/catalog/storefront/products/indexing/{productCode}&productVersion={productVersion}&lastModifiedDate={lastModifiedDate}?responseFields={responseFields}"; + var url = "/api/commerce/catalog/storefront/products/indexing/{productCode}?productVersion={productVersion}&lastModifiedDate={lastModifiedDate}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; mozuUrl.FormatUrl( "lastModifiedDate", lastModifiedDate); mozuUrl.FormatUrl( "productCode", productCode); @@ -116,19 +118,21 @@ public static MozuUrl GetProductForIndexingUrl(string productCode, long? product /// Get Resource Url for ConfiguredProduct /// /// If true, the response returns details about the product. If false, returns a product summary such as the product name, price, and sale price. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. + /// + /// + /// + /// + /// If true, skip the inventory validation process for the specified product. /// /// String - Resource Url /// - public static MozuUrl ConfiguredProductUrl(string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, int? quantity = null, string responseFields = null) + public static MozuUrl ConfiguredProductUrl(string productCode, bool? includeOptionDetails = null, bool? skipInventoryCheck = null, int? quantity = null, string purchaseLocation = null, string responseFields = null) { - var url = "/api/commerce/catalog/storefront/products/{productCode}/configure?includeOptionDetails={includeOptionDetails}&skipInventoryCheck={skipInventoryCheck}&quantity={quantity}&responseFields={responseFields}"; + var url = "/api/commerce/catalog/storefront/products/{productCode}/configure?includeOptionDetails={includeOptionDetails}&skipInventoryCheck={skipInventoryCheck}&quantity={quantity}&purchaseLocation={purchaseLocation}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; mozuUrl.FormatUrl( "includeOptionDetails", includeOptionDetails); mozuUrl.FormatUrl( "productCode", productCode); + mozuUrl.FormatUrl( "purchaseLocation", purchaseLocation); mozuUrl.FormatUrl( "quantity", quantity); mozuUrl.FormatUrl( "responseFields", responseFields); mozuUrl.FormatUrl( "skipInventoryCheck", skipInventoryCheck); @@ -138,19 +142,21 @@ public static MozuUrl ConfiguredProductUrl(string productCode, bool? includeOpti /// /// Get Resource Url for ValidateProduct /// - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// Normally, product validation applies default extras to products that do not have options specified. If , product validation does not apply default extras to products. - /// If true, skip the process to validate inventory when creating this product reservation. + /// + /// + /// + /// + /// + /// If true, skip the inventory validation process for the specified product. /// /// String - Resource Url /// - public static MozuUrl ValidateProductUrl(string productCode, bool? skipInventoryCheck = null, int? quantity = null, bool? skipDefaults = null, string responseFields = null) + public static MozuUrl ValidateProductUrl(string productCode, bool? skipInventoryCheck = null, int? quantity = null, bool? skipDefaults = null, string purchaseLocation = null, string responseFields = null) { - var url = "/api/commerce/catalog/storefront/products/{productCode}/validate?skipInventoryCheck={skipInventoryCheck}&quantity={quantity}&skipDefaults={skipDefaults}&responseFields={responseFields}"; + var url = "/api/commerce/catalog/storefront/products/{productCode}/validate?skipInventoryCheck={skipInventoryCheck}&quantity={quantity}&skipDefaults={skipDefaults}&purchaseLocation={purchaseLocation}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; mozuUrl.FormatUrl( "productCode", productCode); + mozuUrl.FormatUrl( "purchaseLocation", purchaseLocation); mozuUrl.FormatUrl( "quantity", quantity); mozuUrl.FormatUrl( "responseFields", responseFields); mozuUrl.FormatUrl( "skipDefaults", skipDefaults); @@ -161,11 +167,11 @@ public static MozuUrl ValidateProductUrl(string productCode, bool? skipInventory /// /// Get Resource Url for ValidateDiscounts /// - /// If true, allow inactive categories to be retrieved in the category list response. If false, the categories retrieved will not include ones marked inactive. - /// The unique identifier of the customer account for which to retrieve wish lists. - /// Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// If true, skip the process to validate inventory when creating this product reservation. + /// If true, this operation returns inactive product discounts as part of the POST. + /// Unique ID of the customer account associated with the shopper requesting the discount. + /// + /// + /// If true, do not validate the product inventory when evaluating the list of discounts. /// Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code. /// /// String - Resource Url @@ -186,7 +192,7 @@ public static MozuUrl ValidateDiscountsUrl(string productCode, string variationP /// /// Get Resource Url for GetProductCosts /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -201,7 +207,7 @@ public static MozuUrl GetProductCostsUrl(string responseFields = null) /// /// Get Resource Url for GetProductInventories /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Catalog/Storefront/ShippingUrl.cs b/Mozu.Api/Urls/Commerce/Catalog/Storefront/ShippingUrl.cs old mode 100644 new mode 100755 index d60aa719..bcf1314c --- a/Mozu.Api/Urls/Commerce/Catalog/Storefront/ShippingUrl.cs +++ b/Mozu.Api/Urls/Commerce/Catalog/Storefront/ShippingUrl.cs @@ -17,10 +17,25 @@ public partial class ShippingUrl { /// + /// Get Resource Url for GetMultiRates + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetMultiRatesUrl(bool? includeRawResponse = null) + { + var url = "/api/commerce/catalog/storefront/shipping/request-multi-rates"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "includeRawResponse", includeRawResponse); + return mozuUrl; + } + + /// /// Get Resource Url for GetRates /// - /// Set this parameter to to retrieve the full raw JSON response from a shipping carrier (instead of just the shipping rate). - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/ChannelGroupUrl.cs b/Mozu.Api/Urls/Commerce/ChannelGroupUrl.cs old mode 100644 new mode 100755 index 15bfc300..3d791c4d --- a/Mozu.Api/Urls/Commerce/ChannelGroupUrl.cs +++ b/Mozu.Api/Urls/Commerce/ChannelGroupUrl.cs @@ -19,11 +19,11 @@ public partial class ChannelGroupUrl /// /// Get Resource Url for GetChannelGroups /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetChannelGroupsUrl(int? startIndex = null, int? pageSize /// /// Get Resource Url for GetChannelGroup /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// The code that uniquely identifies the channel group. + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetChannelGroupUrl(string code, string responseFields = n /// /// Get Resource Url for CreateChannelGroup /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,8 +74,8 @@ public static MozuUrl CreateChannelGroupUrl(string responseFields = null) /// /// Get Resource Url for UpdateChannelGroup /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// Code that identifies the channel group. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/ChannelUrl.cs b/Mozu.Api/Urls/Commerce/ChannelUrl.cs old mode 100644 new mode 100755 index 75e30042..31ee63dc --- a/Mozu.Api/Urls/Commerce/ChannelUrl.cs +++ b/Mozu.Api/Urls/Commerce/ChannelUrl.cs @@ -19,11 +19,11 @@ public partial class ChannelUrl /// /// Get Resource Url for GetChannels /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetChannelsUrl(int? startIndex = null, int? pageSize = n /// /// Get Resource Url for GetChannel /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the channel to retrieve. + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetChannelUrl(string code, string responseFields = null) /// /// Get Resource Url for CreateChannel /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,8 +74,8 @@ public static MozuUrl CreateChannelUrl(string responseFields = null) /// /// Get Resource Url for UpdateChannel /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the channel to update. + /// /// /// String - Resource Url /// @@ -91,7 +91,7 @@ public static MozuUrl UpdateChannelUrl(string code, string responseFields = nul /// /// Get Resource Url for DeleteChannel /// - /// User-defined code that uniqely identifies the channel group. + /// User-defined code that identifies the channel to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/CheckoutUrl.cs b/Mozu.Api/Urls/Commerce/CheckoutUrl.cs new file mode 100755 index 00000000..606dda79 --- /dev/null +++ b/Mozu.Api/Urls/Commerce/CheckoutUrl.cs @@ -0,0 +1,215 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Commerce +{ + public partial class CheckoutUrl + { + + /// + /// Get Resource Url for GetCheckouts + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetCheckoutsUrl(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null) + { + var url = "/api/commerce/checkouts/?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&q={q}&qLimit={qLimit}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "filter", filter); + mozuUrl.FormatUrl( "pageSize", pageSize); + mozuUrl.FormatUrl( "q", q); + mozuUrl.FormatUrl( "qLimit", qLimit); + mozuUrl.FormatUrl( "responseFields", responseFields); + mozuUrl.FormatUrl( "sortBy", sortBy); + mozuUrl.FormatUrl( "startIndex", startIndex); + return mozuUrl; + } + + /// + /// Get Resource Url for GetAvailableActions + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetAvailableActionsUrl(string checkoutId) + { + var url = "/api/commerce/checkouts/{checkoutId}/actions"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + return mozuUrl; + } + + /// + /// Get Resource Url for GetAvailableShippingMethods + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetAvailableShippingMethodsUrl(string checkoutId) + { + var url = "/api/commerce/checkouts/{checkoutId}/shippingMethods"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + return mozuUrl; + } + + /// + /// Get Resource Url for GetCheckout + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetCheckoutUrl(string checkoutId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for CreateCheckoutFromCart + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl CreateCheckoutFromCartUrl(string cartId, string responseFields = null) + { + var url = "/api/commerce/checkouts/?cartId={cartId}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "cartId", cartId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for PerformCheckoutAction + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl PerformCheckoutActionUrl(string checkoutId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/actions?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for ResendCheckoutConfirmationEmail + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl ResendCheckoutConfirmationEmailUrl(string checkoutId) + { + var url = "/api/commerce/checkouts/{checkoutId}/email/resend"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + return mozuUrl; + } + + /// + /// Get Resource Url for SetShippingMethods + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl SetShippingMethodsUrl(string checkoutId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/shippingMethods?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdateCheckout + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdateCheckoutUrl(string checkoutId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for ProcessDigitalWallet + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl ProcessDigitalWalletUrl(string checkoutId, string digitalWalletType, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/digitalWallet/{digitalWalletType}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "digitalWalletType", digitalWalletType); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for ChangeCheckoutPriceList + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl ChangeCheckoutPriceListUrl(string checkoutId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/priceList?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Commerce/Checkouts/AppliedDiscountUrl.cs b/Mozu.Api/Urls/Commerce/Checkouts/AppliedDiscountUrl.cs new file mode 100755 index 00000000..545c63b3 --- /dev/null +++ b/Mozu.Api/Urls/Commerce/Checkouts/AppliedDiscountUrl.cs @@ -0,0 +1,73 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Commerce.Checkouts +{ + public partial class AppliedDiscountUrl + { + + /// + /// Get Resource Url for ApplyCoupon + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl ApplyCouponUrl(string checkoutId, string couponCode, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/coupons/{couponCode}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "couponCode", couponCode); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for RemoveCoupons + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl RemoveCouponsUrl(string checkoutId) + { + var url = "/api/commerce/checkouts/{checkoutId}/coupons"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + return mozuUrl; + } + + /// + /// Get Resource Url for RemoveCoupon + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl RemoveCouponUrl(string checkoutId, string couponCode) + { + var url = "/api/commerce/checkouts/{checkoutId}/coupons/{couponcode}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "couponCode", couponCode); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Commerce/Checkouts/DestinationUrl.cs b/Mozu.Api/Urls/Commerce/Checkouts/DestinationUrl.cs new file mode 100755 index 00000000..1f1994ea --- /dev/null +++ b/Mozu.Api/Urls/Commerce/Checkouts/DestinationUrl.cs @@ -0,0 +1,109 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Commerce.Checkouts +{ + public partial class DestinationUrl + { + + /// + /// Get Resource Url for GetDestinations + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetDestinationsUrl(string checkoutId) + { + var url = "/api/commerce/checkouts/{checkoutId}/destinations"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + return mozuUrl; + } + + /// + /// Get Resource Url for GetDestination + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetDestinationUrl(string checkoutId, string destinationId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/destinations/{destinationId}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "destinationId", destinationId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for AddDestination + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl AddDestinationUrl(string checkoutId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/destinations?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdateDestination + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdateDestinationUrl(string checkoutId, string destinationId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/destinations/{destinationId}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "destinationId", destinationId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for RemoveDestination + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl RemoveDestinationUrl(string checkoutId, string destinationId) + { + var url = "/api/commerce/checkouts/{checkoutId}/destinations/{destinationId}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "destinationId", destinationId); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Commerce/Checkouts/OrderAttributeUrl.cs b/Mozu.Api/Urls/Commerce/Checkouts/OrderAttributeUrl.cs new file mode 100755 index 00000000..6f6ec93b --- /dev/null +++ b/Mozu.Api/Urls/Commerce/Checkouts/OrderAttributeUrl.cs @@ -0,0 +1,69 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Commerce.Checkouts +{ + public partial class OrderAttributeUrl + { + + /// + /// Get Resource Url for GetCheckoutAttributes + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetCheckoutAttributesUrl(string checkoutId) + { + var url = "/api/commerce/checkouts/{checkoutId}/attributes"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + return mozuUrl; + } + + /// + /// Get Resource Url for CreateCheckoutAttributes + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl CreateCheckoutAttributesUrl(string checkoutId) + { + var url = "/api/commerce/checkouts/{checkoutId}/attributes"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdateCheckoutAttribute + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdateCheckoutAttributeUrl(string checkoutId, bool? removeMissing = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/attributes?removeMissing={removeMissing}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "removeMissing", removeMissing); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Commerce/Checkouts/OrderItemUrl.cs b/Mozu.Api/Urls/Commerce/Checkouts/OrderItemUrl.cs new file mode 100755 index 00000000..dc2098f7 --- /dev/null +++ b/Mozu.Api/Urls/Commerce/Checkouts/OrderItemUrl.cs @@ -0,0 +1,81 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Commerce.Checkouts +{ + public partial class OrderItemUrl + { + + /// + /// Get Resource Url for SplitItem + /// + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl SplitItemUrl(string checkoutId, string itemId, int? quantity = null, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/items/{itemId}/split?quantity={quantity}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "itemId", itemId); + mozuUrl.FormatUrl( "quantity", quantity); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for BulkUpdateItemDestinations + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl BulkUpdateItemDestinationsUrl(string checkoutId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/items/destinations?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdateItemDestination + /// + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdateItemDestinationUrl(string checkoutId, string itemId, string destinationId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/items/{itemId}/destination/{destinationId}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "destinationId", destinationId); + mozuUrl.FormatUrl( "itemId", itemId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Commerce/Checkouts/PaymentUrl.cs b/Mozu.Api/Urls/Commerce/Checkouts/PaymentUrl.cs new file mode 100755 index 00000000..5de8bf38 --- /dev/null +++ b/Mozu.Api/Urls/Commerce/Checkouts/PaymentUrl.cs @@ -0,0 +1,58 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Commerce.Checkouts +{ + public partial class PaymentUrl + { + + /// + /// Get Resource Url for PerformPaymentAction + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl PerformPaymentActionUrl(string checkoutId, string paymentId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/payments/{paymentId}/actions?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "paymentId", paymentId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for CreatePaymentAction + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl CreatePaymentActionUrl(string checkoutId, string responseFields = null) + { + var url = "/api/commerce/checkouts/{checkoutId}/payments/actions?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "checkoutId", checkoutId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Commerce/Customer/Accounts/CardUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Accounts/CardUrl.cs old mode 100644 new mode 100755 index 1bb5978e..c6310de1 --- a/Mozu.Api/Urls/Commerce/Customer/Accounts/CardUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Accounts/CardUrl.cs @@ -21,7 +21,7 @@ public partial class CardUrl /// /// Unique identifier of the customer account. /// Unique identifier of the card associated with the customer account billing contact. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -39,7 +39,7 @@ public static MozuUrl GetAccountCardUrl(int accountId, string cardId, string res /// Get Resource Url for GetAccountCards /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -56,7 +56,7 @@ public static MozuUrl GetAccountCardsUrl(int accountId, string responseFields = /// Get Resource Url for AddAccountCard /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -73,8 +73,8 @@ public static MozuUrl AddAccountCardUrl(int accountId, string responseFields = /// Get Resource Url for UpdateAccountCard /// /// Unique identifier of the customer account. - /// Unique identifier of the card associated with the customer account billing contact. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the credit card. + /// /// /// String - Resource Url /// @@ -92,7 +92,7 @@ public static MozuUrl UpdateAccountCardUrl(int accountId, string cardId, string /// Get Resource Url for DeleteAccountCard /// /// Unique identifier of the customer account. - /// Unique identifier of the card associated with the customer account billing contact. + /// Unique identifier of the credit card to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerAttributeUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerAttributeUrl.cs old mode 100644 new mode 100755 index 8f5be10b..8e70211c --- a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerAttributeUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerAttributeUrl.cs @@ -19,9 +19,9 @@ public partial class CustomerAttributeUrl /// /// Get Resource Url for GetAccountAttribute /// - /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// Identifier of the customer account associated with the attribute to retrieve. + /// + /// /// /// String - Resource Url /// @@ -38,10 +38,10 @@ public static MozuUrl GetAccountAttributeUrl(int accountId, string attributeFQN, /// /// Get Resource Url for GetAccountAttributes /// - /// Unique identifier of the customer account. + /// Identifier of the customer account associated with the attributes to retrieve. /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -64,7 +64,7 @@ public static MozuUrl GetAccountAttributesUrl(int accountId, int? startIndex = /// Get Resource Url for AddAccountAttribute /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -80,9 +80,9 @@ public static MozuUrl AddAccountAttributeUrl(int accountId, string responseField /// /// Get Resource Url for UpdateAccountAttribute /// - /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// Identifier of the customer account associated with the attribute. + /// + /// /// /// String - Resource Url /// @@ -100,7 +100,7 @@ public static MozuUrl UpdateAccountAttributeUrl(int accountId, string attributeF /// Get Resource Url for DeleteAccountAttribute /// /// Unique identifier of the customer account. - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerAuditEntryUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerAuditEntryUrl.cs old mode 100644 new mode 100755 index 1b3d256c..96606cd6 --- a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerAuditEntryUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerAuditEntryUrl.cs @@ -19,12 +19,12 @@ public partial class CustomerAuditEntryUrl /// /// Get Resource Url for GetAccountAuditLog /// - /// Unique identifier of the customer account. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerContactUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerContactUrl.cs old mode 100644 new mode 100755 index 20ca94b0..c2c5519b --- a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerContactUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerContactUrl.cs @@ -19,9 +19,9 @@ public partial class CustomerContactUrl /// /// Get Resource Url for GetAccountContact /// - /// Unique identifier of the customer account. - /// Unique identifer of the customer account contact being updated. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account whose contact information is being retrieved. + /// Unique identifier of the customer account contact to retrieve. + /// /// /// String - Resource Url /// @@ -38,10 +38,10 @@ public static MozuUrl GetAccountContactUrl(int accountId, int contactId, string /// /// Get Resource Url for GetAccountContacts /// - /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account associated with the contact information to retrieve. + /// + /// + /// /// /// /// @@ -63,8 +63,8 @@ public static MozuUrl GetAccountContactsUrl(int accountId, int? startIndex = nu /// /// Get Resource Url for AddAccountContact /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account containing the new contact. + /// /// /// String - Resource Url /// @@ -80,9 +80,9 @@ public static MozuUrl AddAccountContactUrl(int accountId, string responseFields /// /// Get Resource Url for UpdateAccountContact /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account whose contact information is being updated. /// Unique identifer of the customer account contact being updated. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -96,11 +96,28 @@ public static MozuUrl UpdateAccountContactUrl(int accountId, int contactId, stri return mozuUrl; } + /// + /// Get Resource Url for AddAccountContactList + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl AddAccountContactListUrl(int accountId, string responseFields = null) + { + var url = "/api/commerce/customer/accounts/{accountId}/contacts?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "accountId", accountId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + /// /// Get Resource Url for DeleteAccountContact /// /// Unique identifier of the customer account. - /// Unique identifer of the customer account contact being updated. + /// Unique identifier of the customer account contact to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerNoteUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerNoteUrl.cs old mode 100644 new mode 100755 index d3bfdd69..cd180d1c --- a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerNoteUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerNoteUrl.cs @@ -19,9 +19,9 @@ public partial class CustomerNoteUrl /// /// Get Resource Url for GetAccountNote /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account that contains the note being retrieved. /// Unique identifier of a particular note to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -39,11 +39,11 @@ public static MozuUrl GetAccountNoteUrl(int accountId, int noteId, string respon /// Get Resource Url for GetAccountNotes /// /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -63,8 +63,8 @@ public static MozuUrl GetAccountNotesUrl(int accountId, int? startIndex = null, /// /// Get Resource Url for AddAccountNote /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account for which to create the note. + /// /// /// String - Resource Url /// @@ -80,9 +80,9 @@ public static MozuUrl AddAccountNoteUrl(int accountId, string responseFields = /// /// Get Resource Url for UpdateAccountNote /// - /// Unique identifier of the customer account. - /// Unique identifier of a particular note to retrieve. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account note to modify. + /// Unique identifier of the note to update. + /// /// /// String - Resource Url /// @@ -99,8 +99,8 @@ public static MozuUrl UpdateAccountNoteUrl(int accountId, int noteId, string res /// /// Get Resource Url for DeleteAccountNote /// - /// Unique identifier of the customer account. - /// Unique identifier of a particular note to retrieve. + /// Unique identifier of the customer account that contains the note being deleted. + /// Unique identifier of the customer account note being deleted. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountUrl.cs old mode 100644 new mode 100755 index fff8aa2b..3ef34ba2 --- a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerPurchaseOrderAccountUrl.cs @@ -19,8 +19,8 @@ public partial class CustomerPurchaseOrderAccountUrl /// /// Get Resource Url for GetCustomerPurchaseOrderAccount /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -36,12 +36,12 @@ public static MozuUrl GetCustomerPurchaseOrderAccountUrl(int accountId, string r /// /// Get Resource Url for GetCustomerPurchaseOrderTransactions /// - /// Unique identifier of the customer account. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -61,8 +61,8 @@ public static MozuUrl GetCustomerPurchaseOrderTransactionsUrl(int accountId, int /// /// Get Resource Url for CreateCustomerPurchaseOrderAccount /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -78,8 +78,8 @@ public static MozuUrl CreateCustomerPurchaseOrderAccountUrl(int accountId, strin /// /// Get Resource Url for CreatePurchaseOrderTransaction /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -95,8 +95,8 @@ public static MozuUrl CreatePurchaseOrderTransactionUrl(int accountId, string re /// /// Get Resource Url for UpdateCustomerPurchaseOrderAccount /// - /// Unique identifier of the customer account. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -112,7 +112,7 @@ public static MozuUrl UpdateCustomerPurchaseOrderAccountUrl(int accountId, strin /// /// Get Resource Url for DeleteCustomerPurchaseOrderAccount /// - /// Unique identifier of the customer account. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerSegmentUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerSegmentUrl.cs old mode 100644 new mode 100755 index 7453c125..b53b50fc --- a/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerSegmentUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Accounts/CustomerSegmentUrl.cs @@ -20,11 +20,11 @@ public partial class CustomerSegmentUrl /// Get Resource Url for GetAccountSegments /// /// Unique identifier of the customer account. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Accounts/TransactionUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Accounts/TransactionUrl.cs old mode 100644 new mode 100755 index f3e1d570..cd6c2baa --- a/Mozu.Api/Urls/Commerce/Customer/Accounts/TransactionUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Accounts/TransactionUrl.cs @@ -19,7 +19,7 @@ public partial class TransactionUrl /// /// Get Resource Url for GetTransactions /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account for which to retrieve transactions. /// /// String - Resource Url /// @@ -35,7 +35,7 @@ public static MozuUrl GetTransactionsUrl(int accountId) /// Get Resource Url for AddTransaction /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -51,7 +51,7 @@ public static MozuUrl AddTransactionUrl(int accountId, string responseFields = /// /// Get Resource Url for RemoveTransaction /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account from which to delete the transaction. /// Unique identifier of the transaction to delete. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Commerce/Customer/AddressValidationRequestUrl.cs b/Mozu.Api/Urls/Commerce/Customer/AddressValidationRequestUrl.cs old mode 100644 new mode 100755 index 7d984cea..9a01ad29 --- a/Mozu.Api/Urls/Commerce/Customer/AddressValidationRequestUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/AddressValidationRequestUrl.cs @@ -19,7 +19,7 @@ public partial class AddressValidationRequestUrl /// /// Get Resource Url for ValidateAddress /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Attributedefinition/AttributeUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Attributedefinition/AttributeUrl.cs old mode 100644 new mode 100755 index 93bb605a..155c503b --- a/Mozu.Api/Urls/Commerce/Customer/Attributedefinition/AttributeUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Attributedefinition/AttributeUrl.cs @@ -19,11 +19,11 @@ public partial class AttributeUrl /// /// Get Resource Url for GetAttributes /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,7 +42,7 @@ public static MozuUrl GetAttributesUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetAttributeVocabularyValues /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// String - Resource Url /// @@ -57,8 +57,8 @@ public static MozuUrl GetAttributeVocabularyValuesUrl(string attributeFQN) /// /// Get Resource Url for GetAttribute /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -71,7 +71,39 @@ public static MozuUrl GetAttributeUrl(string attributeFQN, string responseFields return mozuUrl; } - + /// + /// Get Resource Url for CreateAttribute + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl CreateAttributeUrl(string responseFields = null) + { + var url = "/api/commerce/customer/attributedefinition/attributes/?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdateAttribute + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdateAttributeUrl(string attributeFQN, string responseFields = null) + { + var url = "/api/commerce/customer/attributedefinition/attributes/{attributeFQN}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "attributeFQN", attributeFQN); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + } } diff --git a/Mozu.Api/Urls/Commerce/Customer/CreditUrl.cs b/Mozu.Api/Urls/Commerce/Customer/CreditUrl.cs old mode 100644 new mode 100755 index 9056c89d..2a878a37 --- a/Mozu.Api/Urls/Commerce/Customer/CreditUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/CreditUrl.cs @@ -19,11 +19,11 @@ public partial class CreditUrl /// /// Get Resource Url for GetCredits /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetCreditsUrl(int? startIndex = null, int? pageSize = nu /// /// Get Resource Url for GetCredit /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the store credit to retrieve. + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetCreditUrl(string code, string responseFields = null) /// /// Get Resource Url for AddCredit /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,8 +74,8 @@ public static MozuUrl AddCreditUrl(string responseFields = null) /// /// Get Resource Url for AssociateCreditToShopper /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// The code that represents the credit to claim for the shopper. + /// /// /// String - Resource Url /// @@ -91,7 +91,7 @@ public static MozuUrl AssociateCreditToShopperUrl(string code, string responseFi /// /// Get Resource Url for ResendCreditCreatedEmail /// - /// User-defined code that uniqely identifies the channel group. + /// /// /// String - Resource Url /// @@ -106,8 +106,8 @@ public static MozuUrl ResendCreditCreatedEmailUrl(string code) /// /// Get Resource Url for UpdateCredit /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// User-defined code of the store credit to update. + /// /// /// String - Resource Url /// @@ -123,7 +123,7 @@ public static MozuUrl UpdateCreditUrl(string code, string responseFields = null /// /// Get Resource Url for DeleteCredit /// - /// User-defined code that uniqely identifies the channel group. + /// User-defined code of the store credit to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Credits/CreditAuditEntryUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Credits/CreditAuditEntryUrl.cs old mode 100644 new mode 100755 index 61d3cc78..c29e9dd9 --- a/Mozu.Api/Urls/Commerce/Customer/Credits/CreditAuditEntryUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Credits/CreditAuditEntryUrl.cs @@ -19,12 +19,12 @@ public partial class CreditAuditEntryUrl /// /// Get Resource Url for GetAuditEntries /// - /// User-defined code that uniqely identifies the channel group. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// User-defined code of the credit for which to retrieve audit entries. + /// + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/Credits/CreditTransactionUrl.cs b/Mozu.Api/Urls/Commerce/Customer/Credits/CreditTransactionUrl.cs old mode 100644 new mode 100755 index c5d96654..f4c16595 --- a/Mozu.Api/Urls/Commerce/Customer/Credits/CreditTransactionUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/Credits/CreditTransactionUrl.cs @@ -19,12 +19,12 @@ public partial class CreditTransactionUrl /// /// Get Resource Url for GetTransactions /// - /// User-defined code that uniqely identifies the channel group. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// User-defined code that identifies the customer credit. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -44,8 +44,8 @@ public static MozuUrl GetTransactionsUrl(string code, int? startIndex = null, i /// /// Get Resource Url for AddTransaction /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// User-defined code that identifies the customer credit to update. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/CustomerAccountUrl.cs b/Mozu.Api/Urls/Commerce/Customer/CustomerAccountUrl.cs old mode 100644 new mode 100755 index 7ab2fd1d..b86c7fe7 --- a/Mozu.Api/Urls/Commerce/Customer/CustomerAccountUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/CustomerAccountUrl.cs @@ -20,12 +20,12 @@ public partial class CustomerAccountUrl /// Get Resource Url for GetAccounts /// /// The fields to include in the response. - /// 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" + /// /// If true, retrieve anonymous shopper accounts in the response. /// - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// A list of customer account search terms to use in the query when searching across customer name and email. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. + /// /// /// /// @@ -51,7 +51,7 @@ public static MozuUrl GetAccountsUrl(int? startIndex = null, int? pageSize = n /// Get Resource Url for GetLoginState /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -67,8 +67,8 @@ public static MozuUrl GetLoginStateUrl(int accountId, string responseFields = n /// /// Get Resource Url for GetAccount /// - /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer account to retrieve. + /// /// /// String - Resource Url /// @@ -84,7 +84,7 @@ public static MozuUrl GetAccountUrl(int accountId, string responseFields = null /// /// Get Resource Url for AddAccount /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -99,8 +99,8 @@ public static MozuUrl AddAccountUrl(string responseFields = null) /// /// Get Resource Url for ChangePassword /// - /// Unique identifier of the customer account. - /// Specifies whether to unlock the specified customer account. + /// The customer account information required to change the userpassword. + /// /// /// String - Resource Url /// @@ -117,7 +117,7 @@ public static MozuUrl ChangePasswordUrl(int accountId, bool? unlockAccount = nu /// Get Resource Url for AddLoginToExistingCustomer /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -133,7 +133,7 @@ public static MozuUrl AddLoginToExistingCustomerUrl(int accountId, string respon /// /// Get Resource Url for RecomputeCustomerLifetimeValue /// - /// Unique identifier of the customer account. + /// The unique identifier of the customer account for which to calculate customer lifetime value. /// /// String - Resource Url /// @@ -148,7 +148,7 @@ public static MozuUrl RecomputeCustomerLifetimeValueUrl(int accountId) /// /// Get Resource Url for SetLoginLocked /// - /// Unique identifier of the customer account. + /// The unique identifier of the customer account. /// /// String - Resource Url /// @@ -178,7 +178,7 @@ public static MozuUrl SetPasswordChangeRequiredUrl(int accountId) /// /// Get Resource Url for AddAccountAndLogin /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -193,7 +193,7 @@ public static MozuUrl AddAccountAndLoginUrl(string responseFields = null) /// /// Get Resource Url for AddAccounts /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -208,7 +208,7 @@ public static MozuUrl AddAccountsUrl(string responseFields = null) /// /// Get Resource Url for ChangePasswords /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -223,9 +223,9 @@ public static MozuUrl ChangePasswordsUrl(string responseFields = null) /// /// Get Resource Url for GetLoginStateByEmailAddress /// - /// The unique idenfitier of the customer set. + /// /// The email address associated with the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -242,8 +242,8 @@ public static MozuUrl GetLoginStateByEmailAddressUrl(string emailAddress, string /// /// Get Resource Url for GetLoginStateByUserName /// - /// The unique idenfitier of the customer set. - /// Use this field to include those fields which are not included by default. + /// + /// /// The user name associated with the customer account. /// /// String - Resource Url @@ -261,10 +261,10 @@ public static MozuUrl GetLoginStateByUserNameUrl(string userName, string custome /// /// Get Resource Url for GetCustomersPurchaseOrderAccounts /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -296,7 +296,7 @@ public static MozuUrl ResetPasswordUrl() /// Get Resource Url for UpdateAccount /// /// Unique identifier of the customer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -312,7 +312,7 @@ public static MozuUrl UpdateAccountUrl(int accountId, string responseFields = n /// /// Get Resource Url for DeleteAccount /// - /// Unique identifier of the customer account. + /// Unique identifier of the customer account to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/CustomerAuthTicketUrl.cs b/Mozu.Api/Urls/Commerce/Customer/CustomerAuthTicketUrl.cs old mode 100644 new mode 100755 index 9c4140a7..eac7dafe --- a/Mozu.Api/Urls/Commerce/Customer/CustomerAuthTicketUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/CustomerAuthTicketUrl.cs @@ -19,7 +19,7 @@ public partial class CustomerAuthTicketUrl /// /// Get Resource Url for CreateAnonymousShopperAuthTicket /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl CreateAnonymousShopperAuthTicketUrl(string responseFields /// /// Get Resource Url for CreateUserAuthTicket /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -49,8 +49,8 @@ public static MozuUrl CreateUserAuthTicketUrl(string responseFields = null) /// /// Get Resource Url for RefreshUserAuthTicket /// - /// 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. - /// Use this field to include those fields which are not included by default. + /// The refresh token string required to refresh a user's authentication ticket. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/CustomerSegmentUrl.cs b/Mozu.Api/Urls/Commerce/Customer/CustomerSegmentUrl.cs old mode 100644 new mode 100755 index 591c3082..c7f58cba --- a/Mozu.Api/Urls/Commerce/Customer/CustomerSegmentUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/CustomerSegmentUrl.cs @@ -19,11 +19,11 @@ public partial class CustomerSegmentUrl /// /// Get Resource Url for GetSegments /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -43,7 +43,7 @@ public static MozuUrl GetSegmentsUrl(int? startIndex = null, int? pageSize = n /// Get Resource Url for GetSegment /// /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetSegmentUrl(int id, string responseFields = null) /// /// Get Resource Url for AddSegment /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,7 +74,7 @@ public static MozuUrl AddSegmentUrl(string responseFields = null) /// /// Get Resource Url for AddSegmentAccounts /// - /// Unique identifier of the customer segment to retrieve. + /// Unique identifier of the customer segment for which to add the associated customer accounts. /// /// String - Resource Url /// @@ -89,8 +89,8 @@ public static MozuUrl AddSegmentAccountsUrl(int id) /// /// Get Resource Url for UpdateSegment /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the customer segment. + /// /// /// String - Resource Url /// @@ -106,7 +106,7 @@ public static MozuUrl UpdateSegmentUrl(int id, string responseFields = null) /// /// Get Resource Url for DeleteSegment /// - /// Unique identifier of the customer segment to retrieve. + /// Unique identifier of the customer segment to delete. /// /// String - Resource Url /// @@ -121,8 +121,8 @@ public static MozuUrl DeleteSegmentUrl(int id) /// /// Get Resource Url for RemoveSegmentAccount /// - /// Unique identifier of the customer account. - /// Unique identifier of the customer segment to retrieve. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/CustomerSetUrl.cs b/Mozu.Api/Urls/Commerce/Customer/CustomerSetUrl.cs old mode 100644 new mode 100755 index 78a88f08..1fd8a038 --- a/Mozu.Api/Urls/Commerce/Customer/CustomerSetUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/CustomerSetUrl.cs @@ -19,10 +19,10 @@ public partial class CustomerSetUrl /// /// Get Resource Url for GetCustomerSets /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -40,8 +40,8 @@ public static MozuUrl GetCustomerSetsUrl(int? startIndex = null, int? pageSize /// /// Get Resource Url for GetCustomerSet /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Customer/VisitUrl.cs b/Mozu.Api/Urls/Commerce/Customer/VisitUrl.cs old mode 100644 new mode 100755 index 64b58b22..aad9d153 --- a/Mozu.Api/Urls/Commerce/Customer/VisitUrl.cs +++ b/Mozu.Api/Urls/Commerce/Customer/VisitUrl.cs @@ -19,11 +19,11 @@ public partial class VisitUrl /// /// Get Resource Url for GetVisits /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetVisitsUrl(int? startIndex = null, int? pageSize = nul /// /// Get Resource Url for GetVisit /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the customer visit to update. + /// + /// Unique identifier of the customer visit to retrieve. /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetVisitUrl(string visitId, string responseFields = null) /// /// Get Resource Url for AddVisit /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,7 +74,7 @@ public static MozuUrl AddVisitUrl(string responseFields = null) /// /// Get Resource Url for UpdateVisit /// - /// Use this field to include those fields which are not included by default. + /// /// Unique identifier of the customer visit to update. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Commerce/InStockNotificationSubscriptionUrl.cs b/Mozu.Api/Urls/Commerce/InStockNotificationSubscriptionUrl.cs old mode 100644 new mode 100755 index d03b3a66..f4762895 --- a/Mozu.Api/Urls/Commerce/InStockNotificationSubscriptionUrl.cs +++ b/Mozu.Api/Urls/Commerce/InStockNotificationSubscriptionUrl.cs @@ -19,11 +19,11 @@ public partial class InStockNotificationSubscriptionUrl /// /// Get Resource Url for GetInStockNotificationSubscriptions /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetInStockNotificationSubscriptionsUrl(int? startIndex = /// /// Get Resource Url for GetInStockNotificationSubscription /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the in-stock notification subscription to retrieve. + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetInStockNotificationSubscriptionUrl(int id, string respo /// /// Get Resource Url for AddInStockNotificationSubscription /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,7 +74,7 @@ public static MozuUrl AddInStockNotificationSubscriptionUrl(string responseField /// /// Get Resource Url for DeleteInStockNotificationSubscription /// - /// Unique identifier of the customer segment to retrieve. + /// Unique identifier of the customer in-stock notification subscription to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/LocationUrl.cs b/Mozu.Api/Urls/Commerce/LocationUrl.cs old mode 100644 new mode 100755 index 2fde0cd3..4ca276cd --- a/Mozu.Api/Urls/Commerce/LocationUrl.cs +++ b/Mozu.Api/Urls/Commerce/LocationUrl.cs @@ -19,16 +19,18 @@ public partial class LocationUrl /// /// Get Resource Url for GetLocation /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// - public static MozuUrl GetLocationUrl(string code, string responseFields = null) + public static MozuUrl GetLocationUrl(string locationCode, bool? includeAttributeDefinition = null, string responseFields = null) { - var url = "/api/commerce/storefront/locations/{code}?responseFields={responseFields}"; + var url = "/api/commerce/storefront/locations/{locationCode}?includeAttributeDefinition={includeAttributeDefinition}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; - mozuUrl.FormatUrl( "code", code); + mozuUrl.FormatUrl( "includeAttributeDefinition", includeAttributeDefinition); + mozuUrl.FormatUrl( "locationCode", locationCode); mozuUrl.FormatUrl( "responseFields", responseFields); return mozuUrl; } @@ -36,20 +38,22 @@ public static MozuUrl GetLocationUrl(string code, string responseFields = null) /// /// Get Resource Url for GetLocationsInUsageType /// - /// 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" + /// + /// /// System-defined location usage type code, which is DS for direct ship, SP for in-store pickup, or storeFinder. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// /// /// String - Resource Url /// - public static MozuUrl GetLocationsInUsageTypeUrl(string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public static MozuUrl GetLocationsInUsageTypeUrl(string locationUsageType, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeAttributeDefinition = null, string responseFields = null) { - var url = "/api/commerce/storefront/locationUsageTypes/{locationUsageType}/locations?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&responseFields={responseFields}"; + var url = "/api/commerce/storefront/locationUsageTypes/{locationUsageType}/locations?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&includeAttributeDefinition={includeAttributeDefinition}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; mozuUrl.FormatUrl( "filter", filter); + mozuUrl.FormatUrl( "includeAttributeDefinition", includeAttributeDefinition); mozuUrl.FormatUrl( "locationUsageType", locationUsageType); mozuUrl.FormatUrl( "pageSize", pageSize); mozuUrl.FormatUrl( "responseFields", responseFields); @@ -61,14 +65,16 @@ public static MozuUrl GetLocationsInUsageTypeUrl(string locationUsageType, int? /// /// Get Resource Url for GetDirectShipLocation /// - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// - public static MozuUrl GetDirectShipLocationUrl(string responseFields = null) + public static MozuUrl GetDirectShipLocationUrl(bool? includeAttributeDefinition = null, string responseFields = null) { - var url = "/api/commerce/storefront/locationUsageTypes/DS/location?responseFields={responseFields}"; + var url = "/api/commerce/storefront/locationUsageTypes/DS/location?includeAttributeDefinition={includeAttributeDefinition}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "includeAttributeDefinition", includeAttributeDefinition); mozuUrl.FormatUrl( "responseFields", responseFields); return mozuUrl; } @@ -76,16 +82,18 @@ public static MozuUrl GetDirectShipLocationUrl(string responseFields = null) /// /// Get Resource Url for GetInStorePickupLocation /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// - public static MozuUrl GetInStorePickupLocationUrl(string code, string responseFields = null) + public static MozuUrl GetInStorePickupLocationUrl(string locationCode, bool? includeAttributeDefinition = null, string responseFields = null) { - var url = "/api/commerce/storefront/locationUsageTypes/SP/locations/{code}?responseFields={responseFields}"; + var url = "/api/commerce/storefront/locationUsageTypes/SP/locations/{locationCode}?includeAttributeDefinition={includeAttributeDefinition}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; - mozuUrl.FormatUrl( "code", code); + mozuUrl.FormatUrl( "includeAttributeDefinition", includeAttributeDefinition); + mozuUrl.FormatUrl( "locationCode", locationCode); mozuUrl.FormatUrl( "responseFields", responseFields); return mozuUrl; } @@ -93,19 +101,21 @@ public static MozuUrl GetInStorePickupLocationUrl(string code, string responseFi /// /// Get Resource Url for GetInStorePickupLocations /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// - public static MozuUrl GetInStorePickupLocationsUrl(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + public static MozuUrl GetInStorePickupLocationsUrl(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, bool? includeAttributeDefinition = null, string responseFields = null) { - var url = "/api/commerce/storefront/locationUsageTypes/SP/locations?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&responseFields={responseFields}"; + var url = "/api/commerce/storefront/locationUsageTypes/SP/locations?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&includeAttributeDefinition={includeAttributeDefinition}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; mozuUrl.FormatUrl( "filter", filter); + mozuUrl.FormatUrl( "includeAttributeDefinition", includeAttributeDefinition); mozuUrl.FormatUrl( "pageSize", pageSize); mozuUrl.FormatUrl( "responseFields", responseFields); mozuUrl.FormatUrl( "sortBy", sortBy); diff --git a/Mozu.Api/Urls/Commerce/OrderUrl.cs b/Mozu.Api/Urls/Commerce/OrderUrl.cs old mode 100644 new mode 100755 index 6b34b67c..7246fa5e --- a/Mozu.Api/Urls/Commerce/OrderUrl.cs +++ b/Mozu.Api/Urls/Commerce/OrderUrl.cs @@ -19,21 +19,23 @@ public partial class OrderUrl /// /// Get Resource Url for GetOrders /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter an order's search results by any of its properties, including status, contact information, or total. 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=Status+eq+Submitted" + /// + /// Used to page results from a query. Indicates the maximum number of entities to return from a query. Default value: 20. Max value: 200. + /// A list of order search terms to use in the query when searching across order number and the name or email of the billing contact. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// + /// + /// The element to sort the results by and the order in which the results appear. Either ascending order (a-z) which accepts 'asc' or 'asc' or descending order (z-a) which accepts 'desc' or 'desc'. The sortBy parameter follows an available property. For examp /// /// /// String - Resource Url /// - public static MozuUrl GetOrdersUrl(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, string responseFields = null) + public static MozuUrl GetOrdersUrl(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string q = null, int? qLimit = null, bool? includeBin = null, string responseFields = null) { - var url = "/api/commerce/orders/?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&q={q}&qLimit={qLimit}&responseFields={responseFields}"; + var url = "/api/commerce/orders/?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&q={q}&qLimit={qLimit}&includeBin={includeBin}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; mozuUrl.FormatUrl( "filter", filter); + mozuUrl.FormatUrl( "includeBin", includeBin); mozuUrl.FormatUrl( "pageSize", pageSize); mozuUrl.FormatUrl( "q", q); mozuUrl.FormatUrl( "qLimit", qLimit); @@ -46,7 +48,7 @@ public static MozuUrl GetOrdersUrl(int? startIndex = null, int? pageSize = nul /// /// Get Resource Url for GetAvailableActions /// - /// Unique identifier of the order. + /// Unique identifier of the available order actions to get. /// /// String - Resource Url /// @@ -61,7 +63,7 @@ public static MozuUrl GetAvailableActionsUrl(string orderId) /// /// Get Resource Url for GetTaxableOrders /// - /// Unique identifier of the order. + /// Unique identifier of the order to retrieve. /// /// String - Resource Url /// @@ -77,16 +79,18 @@ public static MozuUrl GetTaxableOrdersUrl(string orderId) /// Get Resource Url for GetOrder /// /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// + /// Unique identifier of the order details to get. + /// /// /// String - Resource Url /// - public static MozuUrl GetOrderUrl(string orderId, bool? draft = null, string responseFields = null) + public static MozuUrl GetOrderUrl(string orderId, bool? draft = null, bool? includeBin = null, string responseFields = null) { - var url = "/api/commerce/orders/{orderId}?draft={draft}&responseFields={responseFields}"; + var url = "/api/commerce/orders/{orderId}?draft={draft}&includeBin={includeBin}&responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; mozuUrl.FormatUrl( "draft", draft); + mozuUrl.FormatUrl( "includeBin", includeBin); mozuUrl.FormatUrl( "orderId", orderId); mozuUrl.FormatUrl( "responseFields", responseFields); return mozuUrl; @@ -95,8 +99,8 @@ public static MozuUrl GetOrderUrl(string orderId, bool? draft = null, string re /// /// Get Resource Url for CreateOrderFromCart /// - /// Identifier of the cart to delete. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the cart. This is the original cart ID expressed as a GUID. + /// /// /// String - Resource Url /// @@ -112,7 +116,7 @@ public static MozuUrl CreateOrderFromCartUrl(string cartId, string responseField /// /// Get Resource Url for CreateOrder /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -128,7 +132,7 @@ public static MozuUrl CreateOrderUrl(string responseFields = null) /// Get Resource Url for PerformOrderAction /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -141,12 +145,31 @@ public static MozuUrl PerformOrderActionUrl(string orderId, string responseField return mozuUrl; } + /// + /// Get Resource Url for PriceOrder + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl PriceOrderUrl(bool refreshShipping, string couponCodeToApply = null, string responseFields = null) + { + var url = "/api/commerce/orders/price?refreshShipping={refreshShipping}&couponCodeToApply={couponCodeToApply}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "couponCodeToApply", couponCodeToApply); + mozuUrl.FormatUrl( "refreshShipping", refreshShipping); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + /// /// Get Resource Url for ProcessDigitalWallet /// - /// The type of digital wallet to be processed. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// String - Resource Url /// @@ -163,11 +186,11 @@ public static MozuUrl ProcessDigitalWalletUrl(string orderId, string digitalWall /// /// Get Resource Url for UpdateOrderDiscount /// - /// discountId parameter description DOCUMENT_HERE - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// Unique identifier of the discount. System-supplied and read only. + /// Unique identifier of the order discount. System-supplied and read only. + /// + /// Specifies whether to modify the discount by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// @@ -186,8 +209,8 @@ public static MozuUrl UpdateOrderDiscountUrl(string orderId, int discountId, str /// /// Get Resource Url for DeleteOrderDraft /// - /// Unique identifier of the order. - /// Determines whether or not to check versioning of items for concurrency purposes. + /// Unique identifier of the order associated with the draft to delete. + /// If applicable, the version of the order draft to delete. /// /// String - Resource Url /// @@ -203,7 +226,7 @@ public static MozuUrl DeleteOrderDraftUrl(string orderId, string version = null /// /// Get Resource Url for ResendOrderConfirmationEmail /// - /// Unique identifier of the order. + /// /// /// String - Resource Url /// @@ -218,10 +241,10 @@ public static MozuUrl ResendOrderConfirmationEmailUrl(string orderId) /// /// Get Resource Url for ChangeOrderPriceList /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -240,7 +263,7 @@ public static MozuUrl ChangeOrderPriceListUrl(string orderId, string updateMode /// Get Resource Url for ChangeOrderUserId /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -256,10 +279,10 @@ public static MozuUrl ChangeOrderUserIdUrl(string orderId, string responseFields /// /// Get Resource Url for UpdateOrder /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order to update. + /// /// 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." - /// 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. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/AdjustmentUrl.cs b/Mozu.Api/Urls/Commerce/Orders/AdjustmentUrl.cs old mode 100644 new mode 100755 index e1f39582..e0f8ec83 --- a/Mozu.Api/Urls/Commerce/Orders/AdjustmentUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/AdjustmentUrl.cs @@ -19,10 +19,10 @@ public partial class AdjustmentUrl /// /// Get Resource Url for ApplyHandlingAdjustment /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -40,10 +40,10 @@ public static MozuUrl ApplyHandlingAdjustmentUrl(string orderId, string updateMo /// /// Get Resource Url for ApplyShippingAdjustment /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// Unique identifier of the order associated with the shipping adjustment. + /// + /// Specifies whether to apply the shipping adjustment by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// @@ -61,10 +61,10 @@ public static MozuUrl ApplyShippingAdjustmentUrl(string orderId, string updateMo /// /// Get Resource Url for ApplyAdjustment /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// Unique identifier of the order for which to apply the adjustment. + /// + /// Specifies whether to apply the adjustment by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// @@ -82,9 +82,9 @@ public static MozuUrl ApplyAdjustmentUrl(string orderId, string updateMode = nu /// /// Get Resource Url for RemoveHandlingAdjustment /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// /// /// String - Resource Url /// @@ -101,9 +101,9 @@ public static MozuUrl RemoveHandlingAdjustmentUrl(string orderId, string updateM /// /// Get Resource Url for RemoveShippingAdjustment /// - /// Unique identifier of the order. - /// 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." - /// 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. + /// Unique identifier of the order with the applied shipping adjustment. + /// Specifies whether to remove the shipping adjustment by updating the original order, updating the order in draft mode, or updating 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." + /// /// /// String - Resource Url /// @@ -120,9 +120,9 @@ public static MozuUrl RemoveShippingAdjustmentUrl(string orderId, string updateM /// /// Get Resource Url for RemoveAdjustment /// - /// Unique identifier of the order. - /// 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." - /// 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. + /// Unique identifier of the order for which to delete the adjustment. + /// Specifies whether to remove the adjustment by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/AppliedDiscountUrl.cs b/Mozu.Api/Urls/Commerce/Orders/AppliedDiscountUrl.cs old mode 100644 new mode 100755 index 09cf0fa3..de5bb2af --- a/Mozu.Api/Urls/Commerce/Orders/AppliedDiscountUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/AppliedDiscountUrl.cs @@ -19,11 +19,11 @@ public partial class AppliedDiscountUrl /// /// Get Resource Url for ApplyCoupon /// - /// Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// + /// Unique identifier of the order to associate the coupon. System-supplied and read-only. + /// + /// Specifies whether to apply the coupon by updating the original order, updating the order in draft mode, or updating 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." + /// /// /// String - Resource Url /// @@ -42,10 +42,10 @@ public static MozuUrl ApplyCouponUrl(string orderId, string couponCode, string u /// /// Get Resource Url for RemoveCoupon /// - /// Alphanumeric code associated with the coupon or promotion that results in a discounted price. - /// Unique identifier of the order. - /// 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." - /// 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. + /// + /// Unique identifier of the order with the coupon to remove. + /// Specifies whether to remove the coupon by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// @@ -63,9 +63,9 @@ public static MozuUrl RemoveCouponUrl(string orderId, string couponCode, string /// /// Get Resource Url for RemoveCoupons /// - /// Unique identifier of the order. - /// 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." - /// 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. + /// Unique identifier of the order with the coupons to remove. + /// Specifies whether to remove coupons by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/Attributedefinition/AttributeUrl.cs b/Mozu.Api/Urls/Commerce/Orders/Attributedefinition/AttributeUrl.cs old mode 100644 new mode 100755 index 27792302..47f0bcb2 --- a/Mozu.Api/Urls/Commerce/Orders/Attributedefinition/AttributeUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/Attributedefinition/AttributeUrl.cs @@ -19,11 +19,11 @@ public partial class AttributeUrl /// /// Get Resource Url for GetAttributes /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,7 +42,7 @@ public static MozuUrl GetAttributesUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetAttributeVocabularyValues /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. + /// /// /// String - Resource Url /// @@ -57,8 +57,8 @@ public static MozuUrl GetAttributeVocabularyValuesUrl(string attributeFQN) /// /// Get Resource Url for GetAttribute /// - /// The fully qualified name of the attribute, which is a user defined attribute identifier. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -74,7 +74,7 @@ public static MozuUrl GetAttributeUrl(string attributeFQN, string responseFields /// /// Get Resource Url for CreateAttribute /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -89,8 +89,8 @@ public static MozuUrl CreateAttributeUrl(string responseFields = null) /// /// Get Resource Url for UpdateAttribute /// - /// Fully qualified name for an attribute. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/BillingInfoUrl.cs b/Mozu.Api/Urls/Commerce/Orders/BillingInfoUrl.cs old mode 100644 new mode 100755 index ac6b9244..52b5bf4c --- a/Mozu.Api/Urls/Commerce/Orders/BillingInfoUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/BillingInfoUrl.cs @@ -19,9 +19,9 @@ public partial class BillingInfoUrl /// /// Get Resource Url for GetBillingInfo /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. + /// If true, retrieve the draft version of the order billing information, which might include uncommitted changes. /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -39,9 +39,9 @@ public static MozuUrl GetBillingInfoUrl(string orderId, bool? draft = null, str /// Get Resource Url for SetBillingInfo /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// + /// Specifies whether to set the billing information by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/DigitalPackageUrl.cs b/Mozu.Api/Urls/Commerce/Orders/DigitalPackageUrl.cs old mode 100644 new mode 100755 index 3a2ac0df..52732737 --- a/Mozu.Api/Urls/Commerce/Orders/DigitalPackageUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/DigitalPackageUrl.cs @@ -20,7 +20,7 @@ public partial class DigitalPackageUrl /// Get Resource Url for GetAvailableDigitalPackageFulfillmentActions /// /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. + /// This parameter provides the unique identifier of the order on which to get a list of available actions. /// /// String - Resource Url /// @@ -36,9 +36,9 @@ public static MozuUrl GetAvailableDigitalPackageFulfillmentActionsUrl(string ord /// /// Get Resource Url for GetDigitalPackage /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// This parameter provides the digital package Id. + /// This parameter provides the unique identifier of the order with which to associate the digital package. + /// /// /// String - Resource Url /// @@ -55,8 +55,8 @@ public static MozuUrl GetDigitalPackageUrl(string orderId, string digitalPackage /// /// Get Resource Url for CreateDigitalPackage /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// The orderID is a required paramter for the digitalpackages operation. The orderId is a unique identifier of the order with which to associate the digital package. + /// /// /// String - Resource Url /// @@ -72,9 +72,9 @@ public static MozuUrl CreateDigitalPackageUrl(string orderId, string responseFie /// /// Get Resource Url for UpdateDigitalPackage /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// This parameter specifies the digital package to update in the order. + /// This parameter provides the unique identifier of the order with which to associate the digital package. + /// /// /// String - Resource Url /// @@ -91,8 +91,8 @@ public static MozuUrl UpdateDigitalPackageUrl(string orderId, string digitalPack /// /// Get Resource Url for DeleteDigitalPackage /// - /// This parameter supplies package ID to get fulfillment actions for the digital package. - /// Unique identifier of the order. + /// The digitalPackage ID is unique package ID to update on the order. + /// The orderId is unique identifier of the order with which to associate the package. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/ExtendedPropertyUrl.cs b/Mozu.Api/Urls/Commerce/Orders/ExtendedPropertyUrl.cs old mode 100644 new mode 100755 index b5b9b88f..2c020076 --- a/Mozu.Api/Urls/Commerce/Orders/ExtendedPropertyUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/ExtendedPropertyUrl.cs @@ -19,8 +19,8 @@ public partial class ExtendedPropertyUrl /// /// Get Resource Url for GetExtendedProperties /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. + /// + /// /// /// String - Resource Url /// @@ -36,9 +36,9 @@ public static MozuUrl GetExtendedPropertiesUrl(string orderId, bool? draft = nu /// /// Get Resource Url for AddExtendedProperties /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// /// /// String - Resource Url /// @@ -55,12 +55,12 @@ public static MozuUrl AddExtendedPropertiesUrl(string orderId, string updateMode /// /// Get Resource Url for UpdateExtendedProperty /// - /// The extended property key. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Inserts and updates an extended property. - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -80,10 +80,10 @@ public static MozuUrl UpdateExtendedPropertyUrl(string orderId, string key, stri /// /// Get Resource Url for UpdateExtendedProperties /// - /// Unique identifier of the order. - /// 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." - /// Inserts and updates the extended property. - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -101,10 +101,10 @@ public static MozuUrl UpdateExtendedPropertiesUrl(string orderId, string updateM /// /// Get Resource Url for DeleteExtendedProperty /// - /// The extended property key. - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -122,9 +122,9 @@ public static MozuUrl DeleteExtendedPropertyUrl(string orderId, string key, stri /// /// Get Resource Url for DeleteExtendedProperties /// - /// Unique identifier of the order. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/FulfillmentActionUrl.cs b/Mozu.Api/Urls/Commerce/Orders/FulfillmentActionUrl.cs old mode 100644 new mode 100755 index 0ec29c82..ba7b57f1 --- a/Mozu.Api/Urls/Commerce/Orders/FulfillmentActionUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/FulfillmentActionUrl.cs @@ -19,8 +19,8 @@ public partial class FulfillmentActionUrl /// /// Get Resource Url for PerformFulfillmentAction /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// Unique identifier of the order for which to perform the fulfillment action. + /// Updated order with a new fulfillment status resulting from the action supplied in the request. /// /// String - Resource Url /// @@ -36,8 +36,8 @@ public static MozuUrl PerformFulfillmentActionUrl(string orderId, string respons /// /// Get Resource Url for ResendPackageFulfillmentEmail /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/FulfillmentInfoUrl.cs b/Mozu.Api/Urls/Commerce/Orders/FulfillmentInfoUrl.cs old mode 100644 new mode 100755 index a4ab88df..2dea2d9f --- a/Mozu.Api/Urls/Commerce/Orders/FulfillmentInfoUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/FulfillmentInfoUrl.cs @@ -19,9 +19,9 @@ public partial class FulfillmentInfoUrl /// /// Get Resource Url for GetFulfillmentInfo /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. + /// If true, retrieve the draft version of the order's fulfillment information, which might include uncommitted changes. /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -39,9 +39,9 @@ public static MozuUrl GetFulfillmentInfoUrl(string orderId, bool? draft = null, /// Get Resource Url for SetFulFillmentInfo /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// + /// Specifies whether to set the fulfillment information by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/OrderAttributeUrl.cs b/Mozu.Api/Urls/Commerce/Orders/OrderAttributeUrl.cs old mode 100644 new mode 100755 index 36eb4277..607038be --- a/Mozu.Api/Urls/Commerce/Orders/OrderAttributeUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/OrderAttributeUrl.cs @@ -19,7 +19,7 @@ public partial class OrderAttributeUrl /// /// Get Resource Url for GetOrderAttributes /// - /// Unique identifier of the order. + /// Unique identifier of the order for which to retrieve a list of defined attributes. /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl GetOrderAttributesUrl(string orderId) /// /// Get Resource Url for CreateOrderAttributes /// - /// Unique identifier of the order. + /// Unique identifier of the order for which to assign the attributes. /// /// String - Resource Url /// @@ -49,7 +49,7 @@ public static MozuUrl CreateOrderAttributesUrl(string orderId) /// /// Get Resource Url for UpdateOrderAttributes /// - /// Unique identifier of the order. + /// Identifier of the order for which to update attributes. /// If true, the operation removes missing properties so that the updated order attributes will not show properties with a null value. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Commerce/Orders/OrderItemUrl.cs b/Mozu.Api/Urls/Commerce/Orders/OrderItemUrl.cs old mode 100644 new mode 100755 index 54a9d8db..6b0287ab --- a/Mozu.Api/Urls/Commerce/Orders/OrderItemUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/OrderItemUrl.cs @@ -19,10 +19,10 @@ public partial class OrderItemUrl /// /// Get Resource Url for GetOrderItemViaLineId /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// The specific line id that's associated with the order item. - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -40,10 +40,10 @@ public static MozuUrl GetOrderItemViaLineIdUrl(string orderId, int lineId, bool? /// /// Get Resource Url for GetOrderItem /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. + /// If true, retrieve the draft version of this order item, which might include uncommitted changes to the order item, the order, or other order components. + /// Unique identifier of the order item to retrieve. + /// Unique identifier of the order item details to retrieve. + /// /// /// String - Resource Url /// @@ -61,9 +61,9 @@ public static MozuUrl GetOrderItemUrl(string orderId, string orderItemId, bool? /// /// Get Resource Url for GetOrderItems /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// If true, retrieve the draft version of the order's items, which might include uncommitted changes to one or more order items, the order itself, or other order components. + /// Unique identifier of the order items to retrieve. + /// /// /// String - Resource Url /// @@ -80,11 +80,11 @@ public static MozuUrl GetOrderItemsUrl(string orderId, bool? draft = null, stri /// /// Get Resource Url for CreateOrderItem /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. - /// If true, skip the process to validate inventory when creating this product reservation. - /// 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." - /// 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. + /// Unique identifier of the order for which to add the item. + /// + /// If true, do not validate the product inventory when adding this item to the order. + /// Specifies whether to add the item by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// @@ -103,12 +103,12 @@ public static MozuUrl CreateOrderItemUrl(string orderId, string updateMode = nu /// /// Get Resource Url for UpdateOrderItemDiscount /// - /// discountId parameter description DOCUMENT_HERE - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// Unique identifier of the discount. System-supplied and read only. + /// Unique identifier of the order associated with the item discount. + /// Unique identifier of the item in the order. + /// + /// Specifies whether to change the item discount by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// @@ -128,12 +128,12 @@ public static MozuUrl UpdateOrderItemDiscountUrl(string orderId, string orderIte /// /// Get Resource Url for UpdateItemDuty /// - /// The amount added to the order item for duty fees. - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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." - /// Determines whether or not to check versioning of items for concurrency purposes. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -154,10 +154,10 @@ public static MozuUrl UpdateItemDutyUrl(string orderId, string orderItemId, deci /// Get Resource Url for UpdateItemFulfillment /// /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// Unique identifier of the item in the order. + /// + /// Specifies whether to apply the coupon by updating the original order, updating the order in draft mode, or updating 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." + /// /// /// String - Resource Url /// @@ -176,12 +176,12 @@ public static MozuUrl UpdateItemFulfillmentUrl(string orderId, string orderItemI /// /// Get Resource Url for UpdateItemProductPrice /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. + /// Unique identifier of the order containing the item to price override. + /// Unique identifier of the item in the order to price override. /// The override price to specify for this item in the specified order. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// + /// Specifies whether to change the product price by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// @@ -201,12 +201,12 @@ public static MozuUrl UpdateItemProductPriceUrl(string orderId, string orderItem /// /// Get Resource Url for UpdateItemQuantity /// - /// Unique identifier of the order. - /// Unique identifier of the item to remove from the order. - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// 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." - /// 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. + /// Unique identifier of the order containing the item to update quantity. + /// Unique identifier of the item in the order to update quantity. + /// The quantity of the item in the order to update. + /// + /// Specifies whether to change the item quantity by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// @@ -226,10 +226,10 @@ public static MozuUrl UpdateItemQuantityUrl(string orderId, string orderItemId, /// /// Get Resource Url for DeleteOrderItem /// - /// Unique identifier of the order. + /// Unique identifier of the order with the item to remove. /// Unique identifier of the item to remove from the order. - /// 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." - /// 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. + /// Specifies whether to remove the item by updating the original order, updating the order in draft mode, or updating the order in draft mode and then committing 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." + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/OrderNoteUrl.cs b/Mozu.Api/Urls/Commerce/Orders/OrderNoteUrl.cs old mode 100644 new mode 100755 index d362baf6..4fa7b7cc --- a/Mozu.Api/Urls/Commerce/Orders/OrderNoteUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/OrderNoteUrl.cs @@ -34,9 +34,9 @@ public static MozuUrl GetOrderNotesUrl(string orderId) /// /// Get Resource Url for GetOrderNote /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order note to retrieve. + /// Unique identifier of the order associated with the note. + /// /// /// String - Resource Url /// @@ -53,8 +53,8 @@ public static MozuUrl GetOrderNoteUrl(string orderId, string noteId, string resp /// /// Get Resource Url for CreateOrderNote /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order for which to add a note. + /// /// /// String - Resource Url /// @@ -70,9 +70,9 @@ public static MozuUrl CreateOrderNoteUrl(string orderId, string responseFields = /// /// Get Resource Url for UpdateOrderNote /// - /// Unique identifier of a particular note to retrieve. + /// Unique identifier of the order note. /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -89,8 +89,8 @@ public static MozuUrl UpdateOrderNoteUrl(string orderId, string noteId, string r /// /// Get Resource Url for DeleteOrderNote /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the order. + /// Unique identifier of the order note to delete. + /// Unique identifier of the order associated with the note. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/OrderReturnableItemUrl.cs b/Mozu.Api/Urls/Commerce/Orders/OrderReturnableItemUrl.cs old mode 100644 new mode 100755 index 30dce861..73447148 --- a/Mozu.Api/Urls/Commerce/Orders/OrderReturnableItemUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/OrderReturnableItemUrl.cs @@ -19,8 +19,8 @@ public partial class OrderReturnableItemUrl /// /// Get Resource Url for GetOrderReturnableItems /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/OrderValidationResultUrl.cs b/Mozu.Api/Urls/Commerce/Orders/OrderValidationResultUrl.cs old mode 100644 new mode 100755 index 2c4e0480..8d9a17c1 --- a/Mozu.Api/Urls/Commerce/Orders/OrderValidationResultUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/OrderValidationResultUrl.cs @@ -35,7 +35,7 @@ public static MozuUrl GetValidationResultsUrl(string orderId) /// Get Resource Url for AddValidationResult /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/PackageUrl.cs b/Mozu.Api/Urls/Commerce/Orders/PackageUrl.cs old mode 100644 new mode 100755 index ce76f779..56430c31 --- a/Mozu.Api/Urls/Commerce/Orders/PackageUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/PackageUrl.cs @@ -19,8 +19,8 @@ public partial class PackageUrl /// /// Get Resource Url for GetAvailablePackageFulfillmentActions /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. + /// Unique identifier of the order associated with the package fulfillment. + /// Unique identifier of the package associated with the fulfillment actions to retrieve. /// /// String - Resource Url /// @@ -36,7 +36,7 @@ public static MozuUrl GetAvailablePackageFulfillmentActionsUrl(string orderId, s /// /// Get Resource Url for GetPackageLabel /// - /// Unique identifier of the order. + /// Unique identifier of the order associated with the package label to retrieve. /// Unique identifier of the package for which to retrieve the label. /// /// String - Resource Url @@ -53,9 +53,9 @@ public static MozuUrl GetPackageLabelUrl(string orderId, string packageId) /// /// Get Resource Url for GetPackage /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the package to retrieve. + /// Unique identifier of the package to retrieve. + /// /// /// String - Resource Url /// @@ -72,8 +72,8 @@ public static MozuUrl GetPackageUrl(string orderId, string packageId, string res /// /// Get Resource Url for CreatePackage /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with this package. + /// /// /// String - Resource Url /// @@ -89,9 +89,9 @@ public static MozuUrl CreatePackageUrl(string orderId, string responseFields = /// /// Get Resource Url for UpdatePackage /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the package to update. + /// Unique identifier of the package of order items to update. + /// /// /// String - Resource Url /// @@ -108,8 +108,8 @@ public static MozuUrl UpdatePackageUrl(string orderId, string packageId, string /// /// Get Resource Url for DeletePackage /// - /// Unique identifier of the order. - /// Unique identifier of the package for which to retrieve the label. + /// Unique identifier of the order associated with the package to delete. + /// Unique identifier of the package to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/PaymentUrl.cs b/Mozu.Api/Urls/Commerce/Orders/PaymentUrl.cs old mode 100644 new mode 100755 index fa7035ee..9a91f3a6 --- a/Mozu.Api/Urls/Commerce/Orders/PaymentUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/PaymentUrl.cs @@ -20,7 +20,7 @@ public partial class PaymentUrl /// Get Resource Url for GetPayments /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -36,8 +36,8 @@ public static MozuUrl GetPaymentsUrl(string orderId, string responseFields = nu /// /// Get Resource Url for GetAvailablePaymentActions /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. + /// Unique identifier of the order associated with the payment. + /// Unique identifer of the payment for which to retrieve available actions. /// /// String - Resource Url /// @@ -53,9 +53,9 @@ public static MozuUrl GetAvailablePaymentActionsUrl(string orderId, string payme /// /// Get Resource Url for GetPayment /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the payment transaction. + /// Unique identifier of the payment transaction submitted for the order. + /// /// /// String - Resource Url /// @@ -72,9 +72,9 @@ public static MozuUrl GetPaymentUrl(string orderId, string paymentId, string res /// /// Get Resource Url for PerformPaymentAction /// - /// Unique identifier of the order. - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the payment. + /// Unique identifer of the payment for which to perform the action. + /// /// /// String - Resource Url /// @@ -91,8 +91,8 @@ public static MozuUrl PerformPaymentActionUrl(string orderId, string paymentId, /// /// Get Resource Url for CreatePaymentAction /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order for which to apply the payment. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/PickupUrl.cs b/Mozu.Api/Urls/Commerce/Orders/PickupUrl.cs old mode 100644 new mode 100755 index 962788e8..4b352361 --- a/Mozu.Api/Urls/Commerce/Orders/PickupUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/PickupUrl.cs @@ -19,8 +19,8 @@ public partial class PickupUrl /// /// Get Resource Url for GetAvailablePickupFulfillmentActions /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. + /// Unique identifier of the order associated with the pickup. + /// Unique identifier of the pickup for which to retrieve available actions. /// /// String - Resource Url /// @@ -36,9 +36,9 @@ public static MozuUrl GetAvailablePickupFulfillmentActionsUrl(string orderId, st /// /// Get Resource Url for GetPickup /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the pickup. + /// Unique identifier of the pickup to retrieve. + /// /// /// String - Resource Url /// @@ -56,7 +56,7 @@ public static MozuUrl GetPickupUrl(string orderId, string pickupId, string respo /// Get Resource Url for CreatePickup /// /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -72,9 +72,9 @@ public static MozuUrl CreatePickupUrl(string orderId, string responseFields = n /// /// Get Resource Url for UpdatePickup /// - /// Unique identifier of the order. - /// Unique identifier of the pickup to remove. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the in-store pickup. + /// Unique identifier of the pickup to update. + /// /// /// String - Resource Url /// @@ -91,7 +91,7 @@ public static MozuUrl UpdatePickupUrl(string orderId, string pickupId, string re /// /// Get Resource Url for DeletePickup /// - /// Unique identifier of the order. + /// Unique identifier of the order associated with the pickup. /// Unique identifier of the pickup to remove. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Commerce/Orders/RefundUrl.cs b/Mozu.Api/Urls/Commerce/Orders/RefundUrl.cs old mode 100644 new mode 100755 index 507a6e56..d20e0ef6 --- a/Mozu.Api/Urls/Commerce/Orders/RefundUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/RefundUrl.cs @@ -19,8 +19,8 @@ public partial class RefundUrl /// /// Get Resource Url for CreateRefund /// - /// Unique identifier of the order. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -36,8 +36,8 @@ public static MozuUrl CreateRefundUrl(string orderId, string responseFields = n /// /// Get Resource Url for ResendRefundEmail /// - /// Unique identifier of the order. - /// Unique ID of the refund. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Orders/ShipmentUrl.cs b/Mozu.Api/Urls/Commerce/Orders/ShipmentUrl.cs old mode 100644 new mode 100755 index 13f65b04..dfc5602f --- a/Mozu.Api/Urls/Commerce/Orders/ShipmentUrl.cs +++ b/Mozu.Api/Urls/Commerce/Orders/ShipmentUrl.cs @@ -19,8 +19,8 @@ public partial class ShipmentUrl /// /// Get Resource Url for GetShipment /// - /// Unique identifier of the order. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the order associated with the shipment to retrieve. + /// /// Unique identifier of the shipment to retrieve. /// /// String - Resource Url @@ -38,8 +38,8 @@ public static MozuUrl GetShipmentUrl(string orderId, string shipmentId, string r /// /// Get Resource Url for GetAvailableShipmentMethods /// - /// If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components. - /// Unique identifier of the order. + /// + /// Unique identifier of the order for the available shipment methods being retrieved. /// /// String - Resource Url /// @@ -55,7 +55,7 @@ public static MozuUrl GetAvailableShipmentMethodsUrl(string orderId, bool? draft /// /// Get Resource Url for CreatePackageShipments /// - /// Unique identifier of the order. + /// Unique identifier of the order for this shipment. /// /// String - Resource Url /// @@ -70,8 +70,8 @@ public static MozuUrl CreatePackageShipmentsUrl(string orderId) /// /// Get Resource Url for DeleteShipment /// - /// Unique identifier of the order. - /// Unique identifier of the shipment to retrieve. + /// Unique identifier of the order to cancel shipment. + /// Unique identifier of the shipment to cancel. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Payments/FraudScreenUrl.cs b/Mozu.Api/Urls/Commerce/Payments/FraudScreenUrl.cs old mode 100644 new mode 100755 index 5d303d19..aee7964c --- a/Mozu.Api/Urls/Commerce/Payments/FraudScreenUrl.cs +++ b/Mozu.Api/Urls/Commerce/Payments/FraudScreenUrl.cs @@ -19,7 +19,7 @@ public partial class FraudScreenUrl /// /// Get Resource Url for Screen /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Payments/PublicCardUrl.cs b/Mozu.Api/Urls/Commerce/Payments/PublicCardUrl.cs old mode 100644 new mode 100755 index e1181ce3..8a2f7cc1 --- a/Mozu.Api/Urls/Commerce/Payments/PublicCardUrl.cs +++ b/Mozu.Api/Urls/Commerce/Payments/PublicCardUrl.cs @@ -19,7 +19,7 @@ public partial class PublicCardUrl /// /// Get Resource Url for Create /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -34,8 +34,8 @@ public static MozuUrl CreateUrl(string responseFields = null) /// /// Get Resource Url for Update /// - /// Unique identifier of the card associated with the customer account billing contact. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -51,7 +51,7 @@ public static MozuUrl UpdateUrl(string cardId, string responseFields = null) /// /// Get Resource Url for Delete /// - /// Unique identifier of the card associated with the customer account billing contact. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/ReturnUrl.cs b/Mozu.Api/Urls/Commerce/ReturnUrl.cs old mode 100644 new mode 100755 index 4e95b66a..566837eb --- a/Mozu.Api/Urls/Commerce/ReturnUrl.cs +++ b/Mozu.Api/Urls/Commerce/ReturnUrl.cs @@ -19,12 +19,12 @@ public partial class ReturnUrl /// /// Get Resource Url for GetReturns /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -44,7 +44,7 @@ public static MozuUrl GetReturnsUrl(int? startIndex = null, int? pageSize = nu /// /// Get Resource Url for GetAvailableReturnActions /// - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return for which to retrieve available actions. /// /// String - Resource Url /// @@ -59,9 +59,9 @@ public static MozuUrl GetAvailableReturnActionsUrl(string returnId) /// /// Get Resource Url for GetReturnItem /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the return item whose details you want to get. + /// + /// + /// /// /// String - Resource Url /// @@ -78,8 +78,8 @@ public static MozuUrl GetReturnItemUrl(string returnId, string returnItemId, str /// /// Get Resource Url for GetReturnItems /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// String - Resource Url /// @@ -96,7 +96,7 @@ public static MozuUrl GetReturnItemsUrl(string returnId, string responseFields = /// Get Resource Url for GetAvailablePaymentActionsForReturn /// /// Unique identifier of the payment for which to perform the action. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return associated with the payment. /// /// String - Resource Url /// @@ -112,9 +112,9 @@ public static MozuUrl GetAvailablePaymentActionsForReturnUrl(string returnId, st /// /// Get Resource Url for GetPayment /// - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return payment to retrieve. + /// + /// Unique identifier of the return associated with the payment. /// /// String - Resource Url /// @@ -131,8 +131,8 @@ public static MozuUrl GetPaymentUrl(string returnId, string paymentId, string re /// /// Get Resource Url for GetPayments /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// Returns the details of the refund payment associated with the return specified in the request. /// /// String - Resource Url /// @@ -148,8 +148,8 @@ public static MozuUrl GetPaymentsUrl(string returnId, string responseFields = n /// /// Get Resource Url for GetReturn /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// Returns the properties of the return specified in the request as well as system-supplied information. /// /// String - Resource Url /// @@ -165,7 +165,7 @@ public static MozuUrl GetReturnUrl(string returnId, string responseFields = nul /// /// Get Resource Url for GetReasons /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -180,7 +180,7 @@ public static MozuUrl GetReasonsUrl(string responseFields = null) /// /// Get Resource Url for CreateReturn /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -195,8 +195,8 @@ public static MozuUrl CreateReturnUrl(string responseFields = null) /// /// Get Resource Url for CreateReturnItem /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// String - Resource Url /// @@ -212,9 +212,9 @@ public static MozuUrl CreateReturnItemUrl(string returnId, string responseFields /// /// Get Resource Url for PerformPaymentActionForReturn /// - /// Unique identifier of the payment for which to perform the action. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return payment to update. + /// + /// Unique identifier of the return associated with the refund payment. /// /// String - Resource Url /// @@ -231,8 +231,8 @@ public static MozuUrl PerformPaymentActionForReturnUrl(string returnId, string p /// /// Get Resource Url for CreatePaymentActionForReturn /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// Unique identifier of the return associated with the payment action. /// /// String - Resource Url /// @@ -248,8 +248,8 @@ public static MozuUrl CreatePaymentActionForReturnUrl(string returnId, string re /// /// Get Resource Url for CreateReturnShippingOrder /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// String - Resource Url /// @@ -265,7 +265,7 @@ public static MozuUrl CreateReturnShippingOrderUrl(string returnId, string respo /// /// Get Resource Url for PerformReturnActions /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -280,8 +280,8 @@ public static MozuUrl PerformReturnActionsUrl(string responseFields = null) /// /// Get Resource Url for UpdateReturn /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// Unique identifier of the return. /// /// String - Resource Url /// @@ -310,8 +310,8 @@ public static MozuUrl ResendReturnEmailUrl() /// /// Get Resource Url for DeleteOrderItem /// - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the return item whose details you want to get. + /// + /// /// /// String - Resource Url /// @@ -327,7 +327,7 @@ public static MozuUrl DeleteOrderItemUrl(string returnId, string returnItemId) /// /// Get Resource Url for DeleteReturn /// - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Returns/OrderNoteUrl.cs b/Mozu.Api/Urls/Commerce/Returns/OrderNoteUrl.cs old mode 100644 new mode 100755 index 556bacf8..ae6e21c4 --- a/Mozu.Api/Urls/Commerce/Returns/OrderNoteUrl.cs +++ b/Mozu.Api/Urls/Commerce/Returns/OrderNoteUrl.cs @@ -19,7 +19,7 @@ public partial class OrderNoteUrl /// /// Get Resource Url for GetReturnNotes /// - /// Unique identifier of the return whose items you want to get. + /// /// /// String - Resource Url /// @@ -34,9 +34,9 @@ public static MozuUrl GetReturnNotesUrl(string returnId) /// /// Get Resource Url for GetReturnNote /// - /// Unique identifier of a particular note to retrieve. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// + /// /// /// String - Resource Url /// @@ -53,8 +53,8 @@ public static MozuUrl GetReturnNoteUrl(string returnId, string noteId, string re /// /// Get Resource Url for CreateReturnNote /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// String - Resource Url /// @@ -70,9 +70,9 @@ public static MozuUrl CreateReturnNoteUrl(string returnId, string responseFields /// /// Get Resource Url for UpdateReturnNote /// - /// Unique identifier of a particular note to retrieve. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Unique identifier of the return whose items you want to get. + /// + /// + /// /// /// String - Resource Url /// @@ -89,8 +89,8 @@ public static MozuUrl UpdateReturnNoteUrl(string returnId, string noteId, string /// /// Get Resource Url for DeleteReturnNote /// - /// Unique identifier of a particular note to retrieve. - /// Unique identifier of the return whose items you want to get. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Returns/PackageUrl.cs b/Mozu.Api/Urls/Commerce/Returns/PackageUrl.cs old mode 100644 new mode 100755 index 0cf29a98..032c12b2 --- a/Mozu.Api/Urls/Commerce/Returns/PackageUrl.cs +++ b/Mozu.Api/Urls/Commerce/Returns/PackageUrl.cs @@ -19,9 +19,9 @@ public partial class PackageUrl /// /// Get Resource Url for GetPackageLabel /// - /// Unique identifier of the package for which to retrieve the label. - /// Specifies whether to return the RMA label image as Base64-encoded PNG image instead of as a byte array encoded in the original image format. The default is . - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package for which to retrieve the label. + /// + /// Unique identifier of the return associated with the replacement package label to retrieve. /// /// String - Resource Url /// @@ -38,9 +38,9 @@ public static MozuUrl GetPackageLabelUrl(string returnId, string packageId, bool /// /// Get Resource Url for GetPackage /// - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package to retrieve. + /// + /// Unique identifier of the return associated with the replacement package to retrieve. /// /// String - Resource Url /// @@ -57,8 +57,8 @@ public static MozuUrl GetPackageUrl(string returnId, string packageId, string re /// /// Get Resource Url for CreatePackage /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// + /// Unique identifier of the return for which to create a replacement package. /// /// String - Resource Url /// @@ -74,9 +74,9 @@ public static MozuUrl CreatePackageUrl(string returnId, string responseFields = /// /// Get Resource Url for UpdatePackage /// - /// Unique identifier of the package for which to retrieve the label. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package to update. + /// + /// Unique identifier of the return associated with the replacement package to update. /// /// String - Resource Url /// @@ -93,8 +93,8 @@ public static MozuUrl UpdatePackageUrl(string returnId, string packageId, string /// /// Get Resource Url for DeletePackage /// - /// Unique identifier of the package for which to retrieve the label. - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return replacement package to delete. + /// Unique identifier of the return associated with the replacement package to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Returns/ShipmentUrl.cs b/Mozu.Api/Urls/Commerce/Returns/ShipmentUrl.cs old mode 100644 new mode 100755 index 5bb06b86..4e154a17 --- a/Mozu.Api/Urls/Commerce/Returns/ShipmentUrl.cs +++ b/Mozu.Api/Urls/Commerce/Returns/ShipmentUrl.cs @@ -19,9 +19,9 @@ public partial class ShipmentUrl /// /// Get Resource Url for GetShipment /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the shipment to retrieve. + /// + /// Unique identifier of the return associated with the replacement shipment to retrieve. + /// Unique identifier of the return replacement shipment to retrieve. /// /// String - Resource Url /// @@ -38,7 +38,7 @@ public static MozuUrl GetShipmentUrl(string returnId, string shipmentId, string /// /// Get Resource Url for CreatePackageShipments /// - /// Unique identifier of the return whose items you want to get. + /// Unique identifier of the return for which to create replacement package shipments. /// /// String - Resource Url /// @@ -53,8 +53,8 @@ public static MozuUrl CreatePackageShipmentsUrl(string returnId) /// /// Get Resource Url for DeleteShipment /// - /// Unique identifier of the return whose items you want to get. - /// Unique identifier of the shipment to retrieve. + /// Unique identifier of the return associated with the replacement shipment to delete. + /// Unique identifier of the return replacement shipment to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/ApplicationUrl.cs b/Mozu.Api/Urls/Commerce/Settings/ApplicationUrl.cs old mode 100644 new mode 100755 index 3e7f3706..7e441964 --- a/Mozu.Api/Urls/Commerce/Settings/ApplicationUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/ApplicationUrl.cs @@ -19,7 +19,7 @@ public partial class ApplicationUrl /// /// Get Resource Url for ThirdPartyGetApplication /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl ThirdPartyGetApplicationUrl(string responseFields = null) /// /// Get Resource Url for ThirdPartyUpdateApplication /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/CartSettingsUrl.cs b/Mozu.Api/Urls/Commerce/Settings/CartSettingsUrl.cs old mode 100644 new mode 100755 index 999a8bdf..8dd065b6 --- a/Mozu.Api/Urls/Commerce/Settings/CartSettingsUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/CartSettingsUrl.cs @@ -19,7 +19,7 @@ public partial class CartSettingsUrl /// /// Get Resource Url for GetCartSettings /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl GetCartSettingsUrl(string responseFields = null) /// /// Get Resource Url for CreateCartSettings /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -49,7 +49,7 @@ public static MozuUrl CreateCartSettingsUrl(string responseFields = null) /// /// Get Resource Url for UpdateCartSettings /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/Checkout/CustomerCheckoutSettingsUrl.cs b/Mozu.Api/Urls/Commerce/Settings/Checkout/CustomerCheckoutSettingsUrl.cs old mode 100644 new mode 100755 index 308d889e..793c1220 --- a/Mozu.Api/Urls/Commerce/Settings/Checkout/CustomerCheckoutSettingsUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/Checkout/CustomerCheckoutSettingsUrl.cs @@ -19,7 +19,7 @@ public partial class CustomerCheckoutSettingsUrl /// /// Get Resource Url for GetCustomerCheckoutSettings /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl GetCustomerCheckoutSettingsUrl(string responseFields = nu /// /// Get Resource Url for UpdateCustomerCheckoutSettings /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/Checkout/PaymentSettingsUrl.cs b/Mozu.Api/Urls/Commerce/Settings/Checkout/PaymentSettingsUrl.cs old mode 100644 new mode 100755 index f29c9054..7584f114 --- a/Mozu.Api/Urls/Commerce/Settings/Checkout/PaymentSettingsUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/Checkout/PaymentSettingsUrl.cs @@ -19,8 +19,8 @@ public partial class PaymentSettingsUrl /// /// Get Resource Url for GetThirdPartyPaymentWorkflowWithValues /// - /// Fully qualified name of the attribute for the third-party payment workflow. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -62,7 +62,7 @@ public static MozuUrl AddThirdPartyPaymentWorkflowUrl() /// /// Get Resource Url for DeleteThirdPartyPaymentWorkflow /// - /// Fully qualified name of the attribute for the third-party payment workflow. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/CheckoutSettingsUrl.cs b/Mozu.Api/Urls/Commerce/Settings/CheckoutSettingsUrl.cs old mode 100644 new mode 100755 index d58aef59..a8af3ca7 --- a/Mozu.Api/Urls/Commerce/Settings/CheckoutSettingsUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/CheckoutSettingsUrl.cs @@ -19,7 +19,7 @@ public partial class CheckoutSettingsUrl /// /// Get Resource Url for GetCheckoutSettings /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/General/CustomRouteSettingsUrl.cs b/Mozu.Api/Urls/Commerce/Settings/General/CustomRouteSettingsUrl.cs old mode 100644 new mode 100755 index f7218840..df5f76dc --- a/Mozu.Api/Urls/Commerce/Settings/General/CustomRouteSettingsUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/General/CustomRouteSettingsUrl.cs @@ -19,7 +19,7 @@ public partial class CustomRouteSettingsUrl /// /// Get Resource Url for GetCustomRouteSettings /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl GetCustomRouteSettingsUrl(string responseFields = null) /// /// Get Resource Url for CreateCustomRouteSettings /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -49,7 +49,7 @@ public static MozuUrl CreateCustomRouteSettingsUrl(string responseFields = null /// /// Get Resource Url for UpdateCustomRouteSettings /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/General/TaxableTerritoryUrl.cs b/Mozu.Api/Urls/Commerce/Settings/General/TaxableTerritoryUrl.cs old mode 100644 new mode 100755 index 0e2b065a..9ba314f4 --- a/Mozu.Api/Urls/Commerce/Settings/General/TaxableTerritoryUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/General/TaxableTerritoryUrl.cs @@ -32,7 +32,7 @@ public static MozuUrl GetTaxableTerritoriesUrl() /// /// Get Resource Url for AddTaxableTerritory /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/GeneralSettingsUrl.cs b/Mozu.Api/Urls/Commerce/Settings/GeneralSettingsUrl.cs old mode 100644 new mode 100755 index b03d5737..520c19d1 --- a/Mozu.Api/Urls/Commerce/Settings/GeneralSettingsUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/GeneralSettingsUrl.cs @@ -19,7 +19,7 @@ public partial class GeneralSettingsUrl /// /// Get Resource Url for GetGeneralSettings /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl GetGeneralSettingsUrl(string responseFields = null) /// /// Get Resource Url for UpdateGeneralSettings /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/LocationUsageUrl.cs b/Mozu.Api/Urls/Commerce/Settings/LocationUsageUrl.cs old mode 100644 new mode 100755 index 4b1f01e9..d1aad4a9 --- a/Mozu.Api/Urls/Commerce/Settings/LocationUsageUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/LocationUsageUrl.cs @@ -19,7 +19,7 @@ public partial class LocationUsageUrl /// /// Get Resource Url for GetLocationUsages /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -34,8 +34,8 @@ public static MozuUrl GetLocationUsagesUrl(string responseFields = null) /// /// Get Resource Url for GetLocationUsage /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// Code that identifies the location usage type, which is "DS" for direct ship, "SP" for in-store pickup, or "storeFinder" for store finder. + /// /// /// String - Resource Url /// @@ -51,8 +51,8 @@ public static MozuUrl GetLocationUsageUrl(string code, string responseFields = /// /// Get Resource Url for UpdateLocationUsage /// - /// User-defined code that uniqely identifies the channel group. - /// Use this field to include those fields which are not included by default. + /// Code that identifies the location usage type, which is "DS" for direct ship, "SP" for in-store pickup, or "storeFinder" for store finder. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/Shipping/SiteShippingHandlingFeeUrl.cs b/Mozu.Api/Urls/Commerce/Settings/Shipping/SiteShippingHandlingFeeUrl.cs old mode 100644 new mode 100755 index 272efc59..463de8f4 --- a/Mozu.Api/Urls/Commerce/Settings/Shipping/SiteShippingHandlingFeeUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/Shipping/SiteShippingHandlingFeeUrl.cs @@ -19,7 +19,7 @@ public partial class SiteShippingHandlingFeeUrl /// /// Get Resource Url for GetOrderHandlingFee /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl GetOrderHandlingFeeUrl(string responseFields = null) /// /// Get Resource Url for CreateOrderHandlingFee /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -49,7 +49,7 @@ public static MozuUrl CreateOrderHandlingFeeUrl(string responseFields = null) /// /// Get Resource Url for UpdateOrderHandlingFee /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Settings/SiteShippingSettingsUrl.cs b/Mozu.Api/Urls/Commerce/Settings/SiteShippingSettingsUrl.cs old mode 100644 new mode 100755 index 5e25cdeb..4442323b --- a/Mozu.Api/Urls/Commerce/Settings/SiteShippingSettingsUrl.cs +++ b/Mozu.Api/Urls/Commerce/Settings/SiteShippingSettingsUrl.cs @@ -19,7 +19,7 @@ public partial class SiteShippingSettingsUrl /// /// Get Resource Url for GetSiteShippingSettings /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Shipping/Admin/CarrierConfigurationUrl.cs b/Mozu.Api/Urls/Commerce/Shipping/Admin/CarrierConfigurationUrl.cs old mode 100644 new mode 100755 index bccb5a04..ed6a085d --- a/Mozu.Api/Urls/Commerce/Shipping/Admin/CarrierConfigurationUrl.cs +++ b/Mozu.Api/Urls/Commerce/Shipping/Admin/CarrierConfigurationUrl.cs @@ -19,11 +19,11 @@ public partial class CarrierConfigurationUrl /// /// Get Resource Url for GetConfigurations /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetConfigurationsUrl(int? startIndex = null, int? pageSiz /// /// Get Resource Url for GetConfiguration /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -59,8 +59,8 @@ public static MozuUrl GetConfigurationUrl(string carrierId, string responseField /// /// Get Resource Url for CreateConfiguration /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -76,8 +76,8 @@ public static MozuUrl CreateConfigurationUrl(string carrierId, string responseFi /// /// Get Resource Url for UpdateConfiguration /// - /// The unique identifier of the carrier. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -93,7 +93,7 @@ public static MozuUrl UpdateConfigurationUrl(string carrierId, string responseFi /// /// Get Resource Url for DeleteConfiguration /// - /// The unique identifier of the carrier configuration. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesUrl.cs b/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesUrl.cs new file mode 100755 index 00000000..04b43cd9 --- /dev/null +++ b/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/OrderHandlingFeeRulesUrl.cs @@ -0,0 +1,111 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles +{ + public partial class OrderHandlingFeeRulesUrl + { + + /// + /// Get Resource Url for GetOrderHandlingFeeRule + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetOrderHandlingFeeRuleUrl(string profilecode, string id, string responseFields = null) + { + var url = "/api/commerce/shipping/admin/profiles/{profilecode}/rules/orderhandlingfees/{id}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "id", id); + mozuUrl.FormatUrl( "profilecode", profilecode); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for GetOrderHandlingFeeRules + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetOrderHandlingFeeRulesUrl(string profilecode, string responseFields = null) + { + var url = "/api/commerce/shipping/admin/profiles/{profilecode}/rules/orderhandlingfees?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "profilecode", profilecode); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for CreateOrderHandlingFeeRule + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl CreateOrderHandlingFeeRuleUrl(string profilecode, string responseFields = null) + { + var url = "/api/commerce/shipping/admin/profiles/{profilecode}/rules/orderhandlingfees?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "profilecode", profilecode); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdateOrderHandlingFeeRule + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdateOrderHandlingFeeRuleUrl(string profilecode, string id, string responseFields = null) + { + var url = "/api/commerce/shipping/admin/profiles/{profilecode}/rules/orderhandlingfees/{id}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "id", id); + mozuUrl.FormatUrl( "profilecode", profilecode); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for DeleteOrderHandlingFeeRule + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl DeleteOrderHandlingFeeRuleUrl(string profilecode, string id) + { + var url = "/api/commerce/shipping/admin/profiles/{profilecode}/rules/orderhandlingfees/{id}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "id", id); + mozuUrl.FormatUrl( "profilecode", profilecode); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/HandlingFeeRuleUrl.cs b/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesUrl.cs old mode 100644 new mode 100755 similarity index 62% rename from Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/HandlingFeeRuleUrl.cs rename to Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesUrl.cs index c3581d81..4e2fc33a --- a/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/HandlingFeeRuleUrl.cs +++ b/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ProductHandlingFeeRulesUrl.cs @@ -13,15 +13,15 @@ namespace Mozu.Api.Urls.Commerce.Shipping.Admin.Profiles { - public partial class HandlingFeeRuleUrl + public partial class ProductHandlingFeeRulesUrl { /// /// Get Resource Url for GetProductHandlingFeeRule /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// String - Resource Url /// @@ -38,8 +38,8 @@ public static MozuUrl GetProductHandlingFeeRuleUrl(string profilecode, string id /// /// Get Resource Url for GetProductHandlingFeeRules /// - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -55,8 +55,8 @@ public static MozuUrl GetProductHandlingFeeRulesUrl(string profilecode, string r /// /// Get Resource Url for CreateProductHandlingFeeRule /// - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -72,9 +72,9 @@ public static MozuUrl CreateProductHandlingFeeRuleUrl(string profilecode, string /// /// Get Resource Url for UpdateProductHandlingFeeRule /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// String - Resource Url /// @@ -91,8 +91,8 @@ public static MozuUrl UpdateProductHandlingFeeRuleUrl(string profilecode, string /// /// Get Resource Url for DeleteProductHandlingFeeRule /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the product handling fee rule is associated. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleUrl.cs b/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleUrl.cs old mode 100644 new mode 100755 index a0f9de50..64c7c0f2 --- a/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleUrl.cs +++ b/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ShippingInclusionRuleUrl.cs @@ -19,9 +19,9 @@ public partial class ShippingInclusionRuleUrl /// /// Get Resource Url for GetShippingInclusionRule /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// String - Resource Url /// @@ -38,8 +38,8 @@ public static MozuUrl GetShippingInclusionRuleUrl(string profilecode, string id, /// /// Get Resource Url for GetShippingInclusionRules /// - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -55,8 +55,8 @@ public static MozuUrl GetShippingInclusionRulesUrl(string profilecode, string re /// /// Get Resource Url for CreateShippingInclusionRule /// - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -72,9 +72,9 @@ public static MozuUrl CreateShippingInclusionRuleUrl(string profilecode, string /// /// Get Resource Url for UpdateShippingInclusionRule /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// String - Resource Url /// @@ -91,8 +91,8 @@ public static MozuUrl UpdateShippingInclusionRuleUrl(string profilecode, string /// /// Get Resource Url for DeleteShippingInclusionRule /// - /// Unique identifier of the customer segment to retrieve. - /// The unique, user-defined code of the profile with which the shipping inclusion rule is associated. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ShippingStatesUrl.cs b/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ShippingStatesUrl.cs old mode 100644 new mode 100755 index edbab35c..57373102 --- a/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ShippingStatesUrl.cs +++ b/Mozu.Api/Urls/Commerce/Shipping/Admin/Profiles/ShippingStatesUrl.cs @@ -19,7 +19,7 @@ public partial class ShippingStatesUrl /// /// Get Resource Url for GetStates /// - /// The unique, user-defined code of the profile with which the shipping state is associated. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl GetStatesUrl(string profileCode) /// /// Get Resource Url for UpdateStates /// - /// The unique, user-defined code of the profile with which the shipping state is associated. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Shipping/Admin/ShippingProfileUrl.cs b/Mozu.Api/Urls/Commerce/Shipping/Admin/ShippingProfileUrl.cs old mode 100644 new mode 100755 index 8a9bb084..124e12ac --- a/Mozu.Api/Urls/Commerce/Shipping/Admin/ShippingProfileUrl.cs +++ b/Mozu.Api/Urls/Commerce/Shipping/Admin/ShippingProfileUrl.cs @@ -19,7 +19,7 @@ public partial class ShippingProfileUrl /// /// Get Resource Url for GetProfiles /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/TargetRuleUrl.cs b/Mozu.Api/Urls/Commerce/TargetRuleUrl.cs old mode 100644 new mode 100755 index dae50cd6..7f6fb524 --- a/Mozu.Api/Urls/Commerce/TargetRuleUrl.cs +++ b/Mozu.Api/Urls/Commerce/TargetRuleUrl.cs @@ -19,11 +19,11 @@ public partial class TargetRuleUrl /// /// Get Resource Url for GetTargetRules /// - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetTargetRulesUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetTargetRule /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetTargetRuleUrl(string code, string responseFields = nul /// /// Get Resource Url for CreateTargetRule /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -87,8 +87,8 @@ public static MozuUrl ValidateTargetRuleUrl() /// /// Get Resource Url for UpdateTargetRule /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -104,7 +104,7 @@ public static MozuUrl UpdateTargetRuleUrl(string code, string responseFields = /// /// Get Resource Url for DeleteTargetRule /// - /// User-defined code that uniqely identifies the channel group. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/WishlistUrl.cs b/Mozu.Api/Urls/Commerce/WishlistUrl.cs old mode 100644 new mode 100755 index c2335aa4..1034b8f5 --- a/Mozu.Api/Urls/Commerce/WishlistUrl.cs +++ b/Mozu.Api/Urls/Commerce/WishlistUrl.cs @@ -19,13 +19,13 @@ public partial class WishlistUrl /// /// Get Resource Url for GetWishlists /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character. + /// + /// + /// A list of search terms to use in the query when searching across wish list name. Separate multiple search terms with a space character. /// The maximum number of search results to return in the response. You can limit any range between 1-100. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// + /// + /// /// /// String - Resource Url /// @@ -46,8 +46,8 @@ public static MozuUrl GetWishlistsUrl(int? startIndex = null, int? pageSize = /// /// Get Resource Url for GetWishlist /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. + /// + /// Unique identifier of the shopper wish list to retrieve. /// /// String - Resource Url /// @@ -64,7 +64,7 @@ public static MozuUrl GetWishlistUrl(string wishlistId, string responseFields = /// Get Resource Url for GetWishlistByName /// /// The unique identifier of the customer account for which to retrieve wish lists. - /// Use this field to include those fields which are not included by default. + /// /// The name of the wish list to retrieve. /// /// String - Resource Url @@ -82,7 +82,7 @@ public static MozuUrl GetWishlistByNameUrl(int customerAccountId, string wishlis /// /// Get Resource Url for CreateWishlist /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -97,8 +97,8 @@ public static MozuUrl CreateWishlistUrl(string responseFields = null) /// /// Get Resource Url for UpdateWishlist /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. + /// + /// Unique identifier of the shopper wish list to update. /// /// String - Resource Url /// @@ -114,7 +114,7 @@ public static MozuUrl UpdateWishlistUrl(string wishlistId, string responseFields /// /// Get Resource Url for DeleteWishlist /// - /// Unique identifier of the wish list. + /// Unique identifier of the wish list to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Commerce/Wishlists/WishlistItemUrl.cs b/Mozu.Api/Urls/Commerce/Wishlists/WishlistItemUrl.cs old mode 100644 new mode 100755 index 4acf2f93..50c4e9ae --- a/Mozu.Api/Urls/Commerce/Wishlists/WishlistItemUrl.cs +++ b/Mozu.Api/Urls/Commerce/Wishlists/WishlistItemUrl.cs @@ -19,9 +19,9 @@ public partial class WishlistItemUrl /// /// Get Resource Url for GetWishlistItem /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. + /// + /// Unique identifier of the wish list item to retrieve. + /// Unique identifier of the wish list associated with the item to retrieve. /// /// String - Resource Url /// @@ -38,12 +38,12 @@ public static MozuUrl GetWishlistItemUrl(string wishlistId, string wishlistItemI /// /// Get Resource Url for GetWishlistItems /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// Unique identifier of the wish list. + /// + /// + /// + /// + /// + /// Unique identifier of the wish list associated with the items to retrieve. /// /// String - Resource Url /// @@ -63,13 +63,13 @@ public static MozuUrl GetWishlistItemsUrl(string wishlistId, int? startIndex = /// /// Get Resource Url for GetWishlistItemsByWishlistName /// - /// The unique identifier of the customer account for which to retrieve wish lists. - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. - /// The name of the wish list to retrieve. + /// The unique identifier of the customer account associated with the wish list. + /// + /// + /// + /// + /// + /// The name of the wish list that contains the items to retrieve. /// /// String - Resource Url /// @@ -90,8 +90,8 @@ public static MozuUrl GetWishlistItemsByWishlistNameUrl(int customerAccountId, s /// /// Get Resource Url for AddItemToWishlist /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. + /// + /// Unique identifier of the wish list associated with the item to add. /// /// String - Resource Url /// @@ -107,10 +107,10 @@ public static MozuUrl AddItemToWishlistUrl(string wishlistId, string responseFie /// /// Get Resource Url for UpdateWishlistItemQuantity /// - /// The number of cart items in the shopper's active cart. - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. + /// The quantity of the item in the wish list. + /// + /// Unique identifier of the wish list associated with the item quantity to update. + /// Unique identifier of the item in the wish list to update quantity. /// /// String - Resource Url /// @@ -128,9 +128,9 @@ public static MozuUrl UpdateWishlistItemQuantityUrl(string wishlistId, string wi /// /// Get Resource Url for UpdateWishlistItem /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the wish list. - /// Unique identifier of the item to remove from the shopper wish list. + /// + /// Unique identifier of the wish list associated with the item to update. + /// Unique identifier of the item in the shopper wish list to update. /// /// String - Resource Url /// @@ -147,7 +147,7 @@ public static MozuUrl UpdateWishlistItemUrl(string wishlistId, string wishlistIt /// /// Get Resource Url for RemoveAllWishlistItems /// - /// Unique identifier of the wish list. + /// Unique identifier of the wish list associated with the items to remove. /// /// String - Resource Url /// @@ -162,7 +162,7 @@ public static MozuUrl RemoveAllWishlistItemsUrl(string wishlistId) /// /// Get Resource Url for DeleteWishlistItem /// - /// Unique identifier of the wish list. + /// Unique identifier of the wish list associated with the item to remove. /// Unique identifier of the item to remove from the shopper wish list. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Content/DocumentDraftSummaryUrl.cs b/Mozu.Api/Urls/Content/DocumentDraftSummaryUrl.cs old mode 100644 new mode 100755 index 635d4527..a2c6c1b2 --- a/Mozu.Api/Urls/Content/DocumentDraftSummaryUrl.cs +++ b/Mozu.Api/Urls/Content/DocumentDraftSummaryUrl.cs @@ -19,10 +19,10 @@ public partial class DocumentDraftSummaryUrl /// /// Get Resource Url for ListDocumentDraftSummaries /// - /// List of document lists that contain documents to delete. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. + /// Lists that contain the document drafts. + /// + /// + /// /// /// String - Resource Url /// @@ -55,7 +55,7 @@ public static MozuUrl DeleteDocumentDraftsUrl(string documentLists = null) /// /// Get Resource Url for PublishDocuments /// - /// List of document lists that contain documents to delete. + /// List of document lists that contain documents to publish. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Content/DocumentListTypeUrl.cs b/Mozu.Api/Urls/Content/DocumentListTypeUrl.cs old mode 100644 new mode 100755 index f5858292..6c821c6b --- a/Mozu.Api/Urls/Content/DocumentListTypeUrl.cs +++ b/Mozu.Api/Urls/Content/DocumentListTypeUrl.cs @@ -19,9 +19,9 @@ public partial class DocumentListTypeUrl /// /// Get Resource Url for GetDocumentListTypes /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// /// /// String - Resource Url /// @@ -39,7 +39,7 @@ public static MozuUrl GetDocumentListTypesUrl(int? pageSize = null, int? startI /// Get Resource Url for GetDocumentListType /// /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -55,7 +55,7 @@ public static MozuUrl GetDocumentListTypeUrl(string documentListTypeFQN, string /// /// Get Resource Url for CreateDocumentListType /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -71,7 +71,7 @@ public static MozuUrl CreateDocumentListTypeUrl(string responseFields = null) /// Get Resource Url for UpdateDocumentListType /// /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Content/DocumentListUrl.cs b/Mozu.Api/Urls/Content/DocumentListUrl.cs old mode 100644 new mode 100755 index 01a6be20..b4b0f432 --- a/Mozu.Api/Urls/Content/DocumentListUrl.cs +++ b/Mozu.Api/Urls/Content/DocumentListUrl.cs @@ -19,8 +19,8 @@ public partial class DocumentListUrl /// /// Get Resource Url for GetDocumentLists /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// /// String - Resource Url @@ -38,8 +38,8 @@ public static MozuUrl GetDocumentListsUrl(int? pageSize = null, int? startIndex /// /// Get Resource Url for GetDocumentList /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. + /// The name of the document list. + /// /// /// String - Resource Url /// @@ -55,7 +55,7 @@ public static MozuUrl GetDocumentListUrl(string documentListName, string respons /// /// Get Resource Url for CreateDocumentList /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -70,8 +70,8 @@ public static MozuUrl CreateDocumentListUrl(string responseFields = null) /// /// Get Resource Url for UpdateDocumentList /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -87,7 +87,7 @@ public static MozuUrl UpdateDocumentListUrl(string documentListName, string resp /// /// Get Resource Url for DeleteDocumentList /// - /// Name of content documentListName to delete + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Content/DocumentTypeUrl.cs b/Mozu.Api/Urls/Content/DocumentTypeUrl.cs old mode 100644 new mode 100755 index 7021dd5c..39c9a303 --- a/Mozu.Api/Urls/Content/DocumentTypeUrl.cs +++ b/Mozu.Api/Urls/Content/DocumentTypeUrl.cs @@ -19,9 +19,9 @@ public partial class DocumentTypeUrl /// /// Get Resource Url for GetDocumentTypes /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. + /// + /// + /// /// /// String - Resource Url /// @@ -39,7 +39,7 @@ public static MozuUrl GetDocumentTypesUrl(int? pageSize = null, int? startIndex /// Get Resource Url for GetDocumentType /// /// The name of the document type to retrieve. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -55,7 +55,7 @@ public static MozuUrl GetDocumentTypeUrl(string documentTypeName, string respons /// /// Get Resource Url for CreateDocumentType /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -70,8 +70,8 @@ public static MozuUrl CreateDocumentTypeUrl(string responseFields = null) /// /// Get Resource Url for UpdateDocumentType /// - /// The name of the document type to retrieve. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Content/Documentlists/DocumentTreeUrl.cs b/Mozu.Api/Urls/Content/Documentlists/DocumentTreeUrl.cs old mode 100644 new mode 100755 index 060fed80..c960172b --- a/Mozu.Api/Urls/Content/Documentlists/DocumentTreeUrl.cs +++ b/Mozu.Api/Urls/Content/Documentlists/DocumentTreeUrl.cs @@ -19,8 +19,8 @@ public partial class DocumentTreeUrl /// /// Get Resource Url for GetTreeDocumentContent /// - /// Name of content documentListName to delete - /// The name of the document in the site. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. /// /// String - Resource Url /// @@ -36,15 +36,15 @@ public static MozuUrl GetTreeDocumentContentUrl(string documentListName, string /// /// Get Resource Url for TransformTreeDocumentContent /// - /// Crops the image based on the specified coordinates. The reference point for positive coordinates is the top-left corner of the image, and the reference point for negative coordinates is the bottom-right corner of the image.Usage: Example: removes 10 pixels from all edges of the image. leaves the image uncropped. - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Specifies an exact height dimension for the image, in pixels. - /// Specifies a pixel limitation for the largest side of an image. - /// Specifies a pixel limitation for the height of the image, preserving the aspect ratio if the image needs resizing. - /// Specifies a pixel limitation for the width of the image, preserving the aspect ratio if the image needs resizing. - /// Adjusts the image compression. Accepts values from 0-100, where 100 = highest quality, least compression. - /// Specifies an exact width dimension for the image, in pixels. + /// + /// + /// + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -67,10 +67,10 @@ public static MozuUrl TransformTreeDocumentContentUrl(string documentListName, s /// /// Get Resource Url for GetTreeDocument /// - /// Name of content documentListName to delete - /// The name of the document in the site. - /// Include inactive content. - /// Use this field to include those fields which are not included by default. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. + /// + /// /// /// String - Resource Url /// @@ -88,8 +88,8 @@ public static MozuUrl GetTreeDocumentUrl(string documentListName, string documen /// /// Get Resource Url for UpdateTreeDocumentContent /// - /// Name of content documentListName to delete - /// The name of the document in the site. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. /// /// String - Resource Url /// @@ -105,8 +105,8 @@ public static MozuUrl UpdateTreeDocumentContentUrl(string documentListName, stri /// /// Get Resource Url for DeleteTreeDocumentContent /// - /// Name of content documentListName to delete - /// The name of the document in the site. + /// The name of the document list associated with the document. + /// The name of the document, which is unique within its folder. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Content/Documentlists/DocumentUrl.cs b/Mozu.Api/Urls/Content/Documentlists/DocumentUrl.cs old mode 100644 new mode 100755 index de4b7569..cab2a7bf --- a/Mozu.Api/Urls/Content/Documentlists/DocumentUrl.cs +++ b/Mozu.Api/Urls/Content/Documentlists/DocumentUrl.cs @@ -19,8 +19,8 @@ public partial class DocumentUrl /// /// Get Resource Url for GetDocumentContent /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Unique identifier of the document. + /// The name of the document list associated with the document. /// /// String - Resource Url /// @@ -36,15 +36,15 @@ public static MozuUrl GetDocumentContentUrl(string documentListName, string docu /// /// Get Resource Url for TransformDocumentContent /// - /// Crops the image based on the specified coordinates. The reference point for positive coordinates is the top-left corner of the image, and the reference point for negative coordinates is the bottom-right corner of the image.Usage: Example: removes 10 pixels from all edges of the image. leaves the image uncropped. - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Specifies an exact height dimension for the image, in pixels. - /// Specifies a pixel limitation for the largest side of an image. - /// Specifies a pixel limitation for the height of the image, preserving the aspect ratio if the image needs resizing. - /// Specifies a pixel limitation for the width of the image, preserving the aspect ratio if the image needs resizing. - /// Adjusts the image compression. Accepts values from 0-100, where 100 = highest quality, least compression. - /// Specifies an exact width dimension for the image, in pixels. + /// + /// + /// + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -67,10 +67,10 @@ public static MozuUrl TransformDocumentContentUrl(string documentListName, strin /// /// Get Resource Url for GetDocument /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Include inactive content. - /// Use this field to include those fields which are not included by default. + /// Identifier of the document being retrieved. + /// The name of the document list associated with the document to retrieve. + /// + /// /// /// String - Resource Url /// @@ -88,13 +88,13 @@ public static MozuUrl GetDocumentUrl(string documentListName, string documentId, /// /// Get Resource Url for GetDocuments /// - /// Name of content documentListName to delete - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// Include inactive content. - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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" - /// 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. + /// The name of the document list. + /// A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. You can filter a document's search results by any of its properties, including its name or folder path. 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=Name+sw+Events" + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -115,8 +115,8 @@ public static MozuUrl GetDocumentsUrl(string documentListName, string filter = /// /// Get Resource Url for CreateDocument /// - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. + /// The descriptive alphanumeric document list name being created. + /// /// /// String - Resource Url /// @@ -132,8 +132,8 @@ public static MozuUrl CreateDocumentUrl(string documentListName, string response /// /// Get Resource Url for UpdateDocumentContent /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Unique identifier of the document. + /// The name of the document list associated with the document. /// /// String - Resource Url /// @@ -149,9 +149,9 @@ public static MozuUrl UpdateDocumentContentUrl(string documentListName, string d /// /// Get Resource Url for UpdateDocument /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the document to update. + /// Name of the document list associated with the document. + /// /// /// String - Resource Url /// @@ -168,8 +168,8 @@ public static MozuUrl UpdateDocumentUrl(string documentListName, string document /// /// Get Resource Url for DeleteDocument /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Identifier of the document being deleted. + /// The name of the document list associated with the document list being deleted. /// /// String - Resource Url /// @@ -185,8 +185,8 @@ public static MozuUrl DeleteDocumentUrl(string documentListName, string document /// /// Get Resource Url for DeleteDocumentContent /// - /// Unique identifier for a document, used by content and document calls. Document IDs are associated with document types, document type lists, sites, and tenants. - /// Name of content documentListName to delete + /// Unique identifier of the document. + /// The name of the document list associated with the document. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Content/Documentlists/FacetUrl.cs b/Mozu.Api/Urls/Content/Documentlists/FacetUrl.cs old mode 100644 new mode 100755 index 0da9d47d..deb303ad --- a/Mozu.Api/Urls/Content/Documentlists/FacetUrl.cs +++ b/Mozu.Api/Urls/Content/Documentlists/FacetUrl.cs @@ -19,7 +19,7 @@ public partial class FacetUrl /// /// Get Resource Url for GetFacets /// - /// Name of content documentListName to delete + /// The document list associated with the facets to retrieve. /// The property name associated with the facets to retrieve. /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Content/Documentlists/ViewUrl.cs b/Mozu.Api/Urls/Content/Documentlists/ViewUrl.cs old mode 100644 new mode 100755 index ace6ac66..39b88447 --- a/Mozu.Api/Urls/Content/Documentlists/ViewUrl.cs +++ b/Mozu.Api/Urls/Content/Documentlists/ViewUrl.cs @@ -19,14 +19,14 @@ public partial class ViewUrl /// /// Get Resource Url for GetViewDocuments /// - /// Name of content documentListName to delete - /// 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" - /// Include inactive content. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Content/PropertyTypeUrl.cs b/Mozu.Api/Urls/Content/PropertyTypeUrl.cs old mode 100644 new mode 100755 index b85aab12..c58cd758 --- a/Mozu.Api/Urls/Content/PropertyTypeUrl.cs +++ b/Mozu.Api/Urls/Content/PropertyTypeUrl.cs @@ -19,9 +19,9 @@ public partial class PropertyTypeUrl /// /// Get Resource Url for GetPropertyTypes /// - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. - /// 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. + /// + /// + /// /// /// String - Resource Url /// @@ -38,8 +38,8 @@ public static MozuUrl GetPropertyTypesUrl(int? pageSize = null, int? startIndex /// /// Get Resource Url for GetPropertyType /// - /// The name of the property type. - /// Use this field to include those fields which are not included by default. + /// The name of the content property type. + /// /// /// String - Resource Url /// @@ -55,7 +55,7 @@ public static MozuUrl GetPropertyTypeUrl(string propertyTypeName, string respons /// /// Get Resource Url for CreatePropertyType /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -70,8 +70,8 @@ public static MozuUrl CreatePropertyTypeUrl(string responseFields = null) /// /// Get Resource Url for UpdatePropertyType /// - /// The name of the property type. - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -87,7 +87,7 @@ public static MozuUrl UpdatePropertyTypeUrl(string propertyTypeName, string resp /// /// Get Resource Url for DeletePropertyType /// - /// The name of the property type. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Content/PublishSetSummaryUrl.cs b/Mozu.Api/Urls/Content/PublishSetSummaryUrl.cs old mode 100644 new mode 100755 index c85daacd..b5372ba3 --- a/Mozu.Api/Urls/Content/PublishSetSummaryUrl.cs +++ b/Mozu.Api/Urls/Content/PublishSetSummaryUrl.cs @@ -19,9 +19,9 @@ public partial class PublishSetSummaryUrl /// /// Get Resource Url for GetPublishSets /// - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// /// /// String - Resource Url /// @@ -38,12 +38,12 @@ public static MozuUrl GetPublishSetsUrl(int? pageSize = null, int? startIndex = /// /// Get Resource Url for GetPublishSetItems /// - /// User-defined code that uniqely identifies the channel group. - /// A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters. - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -63,9 +63,9 @@ public static MozuUrl GetPublishSetItemsUrl(string code, int? pageSize = null, /// /// Get Resource Url for DeletePublishSet /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. - /// Specifies whether to discard the pending content changes assigned to the content publish set when the publish set is deleted. + /// + /// + /// /// /// String - Resource Url /// @@ -82,8 +82,8 @@ public static MozuUrl DeletePublishSetUrl(string code, bool? shouldDiscard = nu /// /// Get Resource Url for AddPublishSetItems /// - /// User-defined code that uniqely identifies the channel group. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Event/EventNotificationUrl.cs b/Mozu.Api/Urls/Event/EventNotificationUrl.cs old mode 100644 new mode 100755 index daf6e431..c688071c --- a/Mozu.Api/Urls/Event/EventNotificationUrl.cs +++ b/Mozu.Api/Urls/Event/EventNotificationUrl.cs @@ -19,9 +19,9 @@ public partial class EventNotificationUrl /// /// Get Resource Url for GetEvents /// - /// 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" - /// The number of results to display on each page when creating paged results from a query. The maximum value is 200. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// /// @@ -43,7 +43,7 @@ public static MozuUrl GetEventsUrl(int? startIndex = null, int? pageSize = nul /// Get Resource Url for GetEvent /// /// The unique identifier of the event being retrieved. An event is a notification about a create, read, update, or delete on an order, product, discount or category. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Event/Push/SubscriptionUrl.cs b/Mozu.Api/Urls/Event/Push/SubscriptionUrl.cs old mode 100644 new mode 100755 index 25228b34..86260b34 --- a/Mozu.Api/Urls/Event/Push/SubscriptionUrl.cs +++ b/Mozu.Api/Urls/Event/Push/SubscriptionUrl.cs @@ -19,11 +19,11 @@ public partial class SubscriptionUrl /// /// Get Resource Url for GetSubscriptions /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Event/Push/Subscriptions/EventDeliverySummaryUrl.cs b/Mozu.Api/Urls/Event/Push/Subscriptions/EventDeliverySummaryUrl.cs old mode 100644 new mode 100755 index 63dcafec..c0c55b04 --- a/Mozu.Api/Urls/Event/Push/Subscriptions/EventDeliverySummaryUrl.cs +++ b/Mozu.Api/Urls/Event/Push/Subscriptions/EventDeliverySummaryUrl.cs @@ -19,17 +19,17 @@ public partial class EventDeliverySummaryUrl /// /// Get Resource Url for GetDeliveryAttemptSummary /// - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. - /// Unique identifier for a subscription, such as subscribing tenants for an event or to receive a notification. + /// + /// + /// This operation paramenter is the unique identifer for a subscription. /// /// String - Resource Url /// - public static MozuUrl GetDeliveryAttemptSummaryUrl(string subscriptionId, int? id = null, string responseFields = null) + public static MozuUrl GetDeliveryAttemptSummaryUrl(string subscriptionId, int? processId = null, string responseFields = null) { var url = "/api/event/push/subscriptions/{subscriptionId}/deliveryattempts/{id}?responseFields={responseFields}"; var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; - mozuUrl.FormatUrl( "id", id); + mozuUrl.FormatUrl( "processId", processId); mozuUrl.FormatUrl( "responseFields", responseFields); mozuUrl.FormatUrl( "subscriptionId", subscriptionId); return mozuUrl; @@ -38,12 +38,12 @@ public static MozuUrl GetDeliveryAttemptSummaryUrl(string subscriptionId, int? i /// /// Get Resource Url for GetDeliveryAttemptSummaries /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// Unique identifier for a subscription, such as subscribing tenants for an event or to receive a notification. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/Adminuser/AdminUserUrl.cs b/Mozu.Api/Urls/Platform/Adminuser/AdminUserUrl.cs old mode 100644 new mode 100755 index 485d5ca6..1ea28938 --- a/Mozu.Api/Urls/Platform/Adminuser/AdminUserUrl.cs +++ b/Mozu.Api/Urls/Platform/Adminuser/AdminUserUrl.cs @@ -19,7 +19,7 @@ public partial class AdminUserUrl /// /// Get Resource Url for GetTenantScopesForUser /// - /// Use this field to include those fields which are not included by default. + /// /// Unique identifier of the user whose tenant scopes you want to retrieve. /// /// String - Resource Url @@ -36,8 +36,8 @@ public static MozuUrl GetTenantScopesForUserUrl(string userId, string responseFi /// /// Get Resource Url for GetUser /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the user whose tenant scopes you want to retrieve. + /// + /// Unique identifier of the administrator account to retrieve. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/Adminuser/TenantAdminUserAuthTicketUrl.cs b/Mozu.Api/Urls/Platform/Adminuser/TenantAdminUserAuthTicketUrl.cs old mode 100644 new mode 100755 index 3ab88d26..7fdd44bb --- a/Mozu.Api/Urls/Platform/Adminuser/TenantAdminUserAuthTicketUrl.cs +++ b/Mozu.Api/Urls/Platform/Adminuser/TenantAdminUserAuthTicketUrl.cs @@ -19,7 +19,7 @@ public partial class TenantAdminUserAuthTicketUrl /// /// Get Resource Url for CreateUserAuthTicket /// - /// Use this field to include those fields which are not included by default. + /// /// Unique identifier of the development or production tenant for which to generate the user authentication ticket. /// /// String - Resource Url @@ -36,7 +36,7 @@ public static MozuUrl CreateUserAuthTicketUrl(int? tenantId = null, string resp /// /// Get Resource Url for RefreshAuthTicket /// - /// Use this field to include those fields which are not included by default. + /// /// /// /// String - Resource Url @@ -53,7 +53,7 @@ public static MozuUrl RefreshAuthTicketUrl(int? tenantId = null, string respons /// /// Get Resource Url for DeleteUserAuthTicket /// - /// 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. + /// Refresh token string associated with the user authentication ticket. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/Appdev/AppPackageUrl.cs b/Mozu.Api/Urls/Platform/Appdev/AppPackageUrl.cs new file mode 100755 index 00000000..556272ca --- /dev/null +++ b/Mozu.Api/Urls/Platform/Appdev/AppPackageUrl.cs @@ -0,0 +1,212 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Platform.Appdev +{ + public partial class AppPackageUrl + { + + /// + /// Get Resource Url for GetAllPackages + /// + /// + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetAllPackagesUrl(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + { + var url = "/api/platform/appdev/apppackages/?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "filter", filter); + mozuUrl.FormatUrl( "pageSize", pageSize); + mozuUrl.FormatUrl( "responseFields", responseFields); + mozuUrl.FormatUrl( "sortBy", sortBy); + mozuUrl.FormatUrl( "startIndex", startIndex); + return mozuUrl; + } + + /// + /// Get Resource Url for GetPackage + /// + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetPackageUrl(string applicationKey, bool? includeChildren = null, bool? skipDevAccountCheck = null, string responseFields = null) + { + var url = "/api/platform/appdev/apppackages/{applicationKey}/?includeChildren={includeChildren}&skipDevAccountCheck={skipDevAccountCheck}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "applicationKey", applicationKey); + mozuUrl.FormatUrl( "includeChildren", includeChildren); + mozuUrl.FormatUrl( "responseFields", responseFields); + mozuUrl.FormatUrl( "skipDevAccountCheck", skipDevAccountCheck); + return mozuUrl; + } + + /// + /// Get Resource Url for GetPackages + /// + /// + /// + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetPackagesUrl(string applicationKey, int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + { + var url = "/api/platform/appdev/apppackages/applications/{applicationKey}/packages/?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "applicationKey", applicationKey); + mozuUrl.FormatUrl( "filter", filter); + mozuUrl.FormatUrl( "pageSize", pageSize); + mozuUrl.FormatUrl( "responseFields", responseFields); + mozuUrl.FormatUrl( "sortBy", sortBy); + mozuUrl.FormatUrl( "startIndex", startIndex); + return mozuUrl; + } + + /// + /// Get Resource Url for GetApplicationSummaryChildren + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetApplicationSummaryChildrenUrl(string appId) + { + var url = "/api/platform/appdev/apppackages/apps/{appId}/"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "appId", appId); + return mozuUrl; + } + + /// + /// Get Resource Url for GetApplicationSummaryParents + /// + /// + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetApplicationSummaryParentsUrl(int? startIndex = null, int? pageSize = null, string sortBy = null, string filter = null, string responseFields = null) + { + var url = "/api/platform/appdev/apppackages/collection/?startIndex={startIndex}&pageSize={pageSize}&sortBy={sortBy}&filter={filter}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "filter", filter); + mozuUrl.FormatUrl( "pageSize", pageSize); + mozuUrl.FormatUrl( "responseFields", responseFields); + mozuUrl.FormatUrl( "sortBy", sortBy); + mozuUrl.FormatUrl( "startIndex", startIndex); + return mozuUrl; + } + + /// + /// Get Resource Url for ClonePackage + /// + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl ClonePackageUrl(string applicationKey, string packageName, string responseFields = null) + { + var url = "/api/platform/appdev/apppackages/{applicationKey}/clone/{packageName}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "applicationKey", applicationKey); + mozuUrl.FormatUrl( "packageName", packageName); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for CreateNewCorePackage + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl CreateNewCorePackageUrl(string responseFields = null) + { + var url = "/api/platform/appdev/apppackages/create?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for CreatePackage + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl CreatePackageUrl(int? projectId = null, string responseFields = null) + { + var url = "/api/platform/appdev/apppackages/project/?projectId={projectId}&responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "projectId", projectId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdatePackage + /// + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdatePackageUrl(string applicationKey, string responseFields = null) + { + var url = "/api/platform/appdev/apppackages/{applicationKey}/?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "applicationKey", applicationKey); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for DeletePackage + /// + /// + /// + /// String - Resource Url + /// + public static MozuUrl DeletePackageUrl(string applicationKey) + { + var url = "/api/platform/appdev/apppackages/{applicationKey}/"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "applicationKey", applicationKey); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Platform/Appdev/PackageUrl.cs b/Mozu.Api/Urls/Platform/Appdev/PackageUrl.cs old mode 100644 new mode 100755 index 2fb3f54c..5d95b8dc --- a/Mozu.Api/Urls/Platform/Appdev/PackageUrl.cs +++ b/Mozu.Api/Urls/Platform/Appdev/PackageUrl.cs @@ -19,7 +19,7 @@ public partial class PackageUrl /// /// Get Resource Url for GetFile /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. + /// /// /// /// String - Resource Url diff --git a/Mozu.Api/Urls/Platform/ApplicationUrl.cs b/Mozu.Api/Urls/Platform/ApplicationUrl.cs old mode 100644 new mode 100755 index b92c471b..226eaf78 --- a/Mozu.Api/Urls/Platform/ApplicationUrl.cs +++ b/Mozu.Api/Urls/Platform/ApplicationUrl.cs @@ -19,8 +19,8 @@ public partial class ApplicationUrl /// /// Get Resource Url for GetAppPackageNames /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -36,8 +36,8 @@ public static MozuUrl GetAppPackageNamesUrl(string applicationKey, string respon /// /// Get Resource Url for GetAppVersions /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -53,9 +53,9 @@ public static MozuUrl GetAppVersionsUrl(string nsAndAppId, string responseFields /// /// Get Resource Url for GetPackageFileMetadata /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Represents the file name and location. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// /// /// String - Resource Url /// @@ -72,8 +72,8 @@ public static MozuUrl GetPackageFileMetadataUrl(string applicationKey, string fi /// /// Get Resource Url for GetPackageMetadata /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -89,10 +89,10 @@ public static MozuUrl GetPackageMetadataUrl(string applicationKey, string respon /// /// Get Resource Url for UpsertPackageFile /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// The date and time of the last file insert or update. This parameter is optional. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -110,8 +110,8 @@ public static MozuUrl UpsertPackageFileUrl(string applicationKey, string filepat /// /// Get Resource Url for RenamePackageFile /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -127,8 +127,8 @@ public static MozuUrl RenamePackageFileUrl(string applicationKey, string respons /// /// Get Resource Url for DeletePackageFile /// - /// The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}. - /// Represents the file name and location. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/Applications/AuthTicketUrl.cs b/Mozu.Api/Urls/Platform/Applications/AuthTicketUrl.cs old mode 100644 new mode 100755 index 02555074..8820fd65 --- a/Mozu.Api/Urls/Platform/Applications/AuthTicketUrl.cs +++ b/Mozu.Api/Urls/Platform/Applications/AuthTicketUrl.cs @@ -19,7 +19,7 @@ public partial class AuthTicketUrl /// /// Get Resource Url for AuthenticateApp /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl AuthenticateAppUrl(string responseFields = null) /// /// Get Resource Url for RefreshAppAuthTicket /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -49,7 +49,7 @@ public static MozuUrl RefreshAppAuthTicketUrl(string responseFields = null) /// /// Get Resource Url for DeleteAppAuthTicket /// - /// 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. + /// The refresh token string from the application's authentication ticket. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/Developer/DeveloperAdminUserAuthTicketUrl.cs b/Mozu.Api/Urls/Platform/Developer/DeveloperAdminUserAuthTicketUrl.cs old mode 100644 new mode 100755 index 99be7336..f48f1ad5 --- a/Mozu.Api/Urls/Platform/Developer/DeveloperAdminUserAuthTicketUrl.cs +++ b/Mozu.Api/Urls/Platform/Developer/DeveloperAdminUserAuthTicketUrl.cs @@ -20,7 +20,7 @@ public partial class DeveloperAdminUserAuthTicketUrl /// Get Resource Url for CreateDeveloperUserAuthTicket /// /// Unique identifier of the developer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -37,7 +37,7 @@ public static MozuUrl CreateDeveloperUserAuthTicketUrl(int? developerAccountId = /// Get Resource Url for RefreshDeveloperAuthTicket /// /// Unique identifier of the developer account. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -53,7 +53,7 @@ public static MozuUrl RefreshDeveloperAuthTicketUrl(int? developerAccountId = n /// /// Get Resource Url for DeleteUserAuthTicket /// - /// 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. + /// Refresh token string associated with the developer account authentication ticket. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/EntityListUrl.cs b/Mozu.Api/Urls/Platform/EntityListUrl.cs old mode 100644 new mode 100755 index d008cc0a..dc980494 --- a/Mozu.Api/Urls/Platform/EntityListUrl.cs +++ b/Mozu.Api/Urls/Platform/EntityListUrl.cs @@ -19,11 +19,11 @@ public partial class EntityListUrl /// /// Get Resource Url for GetEntityLists /// - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -42,8 +42,8 @@ public static MozuUrl GetEntityListsUrl(int? pageSize = null, int? startIndex = /// /// Get Resource Url for GetEntityList /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -59,7 +59,7 @@ public static MozuUrl GetEntityListUrl(string entityListFullName, string respons /// /// Get Resource Url for CreateEntityList /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -74,8 +74,8 @@ public static MozuUrl CreateEntityListUrl(string responseFields = null) /// /// Get Resource Url for UpdateEntityList /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -91,7 +91,7 @@ public static MozuUrl UpdateEntityListUrl(string entityListFullName, string resp /// /// Get Resource Url for DeleteEntityList /// - /// The full name of the EntityList including namespace in name@nameSpace format + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/Entitylists/EntityContainerUrl.cs b/Mozu.Api/Urls/Platform/Entitylists/EntityContainerUrl.cs old mode 100644 new mode 100755 index e9826ced..65fb0e5c --- a/Mozu.Api/Urls/Platform/Entitylists/EntityContainerUrl.cs +++ b/Mozu.Api/Urls/Platform/Entitylists/EntityContainerUrl.cs @@ -19,9 +19,9 @@ public partial class EntityContainerUrl /// /// Get Resource Url for GetEntityContainer /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -38,12 +38,12 @@ public static MozuUrl GetEntityContainerUrl(string entityListFullName, string id /// /// Get Resource Url for GetEntityContainers /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/Entitylists/EntityUrl.cs b/Mozu.Api/Urls/Platform/Entitylists/EntityUrl.cs old mode 100644 new mode 100755 index 5eb9be19..5abcad07 --- a/Mozu.Api/Urls/Platform/Entitylists/EntityUrl.cs +++ b/Mozu.Api/Urls/Platform/Entitylists/EntityUrl.cs @@ -19,9 +19,9 @@ public partial class EntityUrl /// /// Get Resource Url for GetEntity /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -38,12 +38,12 @@ public static MozuUrl GetEntityUrl(string entityListFullName, string id, string /// /// Get Resource Url for GetEntities /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -63,8 +63,8 @@ public static MozuUrl GetEntitiesUrl(string entityListFullName, int? pageSize = /// /// Get Resource Url for InsertEntity /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -80,9 +80,9 @@ public static MozuUrl InsertEntityUrl(string entityListFullName, string response /// /// Get Resource Url for UpdateEntity /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. - /// Use this field to include those fields which are not included by default. + /// + /// + /// /// /// String - Resource Url /// @@ -99,8 +99,8 @@ public static MozuUrl UpdateEntityUrl(string entityListFullName, string id, stri /// /// Get Resource Url for DeleteEntity /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Unique identifier of the customer segment to retrieve. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/Entitylists/ListViewUrl.cs b/Mozu.Api/Urls/Platform/Entitylists/ListViewUrl.cs old mode 100644 new mode 100755 index 739c4577..54eab92a --- a/Mozu.Api/Urls/Platform/Entitylists/ListViewUrl.cs +++ b/Mozu.Api/Urls/Platform/Entitylists/ListViewUrl.cs @@ -19,10 +19,10 @@ public partial class ListViewUrl /// /// Get Resource Url for GetViewEntity /// - /// Unique identifier for an entity, which defines the schema, rules, and formats for JSON entities within the MZDB ( Mongo DB). - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -40,12 +40,12 @@ public static MozuUrl GetViewEntityUrl(string entityListFullName, string viewNam /// /// Get Resource Url for GetViewEntities /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -65,10 +65,10 @@ public static MozuUrl GetViewEntitiesUrl(string entityListFullName, string viewN /// /// Get Resource Url for GetViewEntityContainer /// - /// Unique identifier for an entity, which defines the schema, rules, and formats for JSON entities within the MZDB ( Mongo DB). - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// /// /// String - Resource Url /// @@ -86,12 +86,12 @@ public static MozuUrl GetViewEntityContainerUrl(string entityListFullName, strin /// /// Get Resource Url for GetViewEntityContainers /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// 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" - /// 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50. - /// Use this field to include those fields which are not included by default. - /// 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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// + /// + /// + /// /// /// String - Resource Url /// @@ -111,9 +111,9 @@ public static MozuUrl GetViewEntityContainersUrl(string entityListFullName, stri /// /// Get Resource Url for GetEntityListView /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// /// /// String - Resource Url /// @@ -130,8 +130,8 @@ public static MozuUrl GetEntityListViewUrl(string entityListFullName, string vie /// /// Get Resource Url for GetEntityListViews /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -147,8 +147,8 @@ public static MozuUrl GetEntityListViewsUrl(string entityListFullName, string re /// /// Get Resource Url for CreateEntityListView /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// @@ -164,9 +164,9 @@ public static MozuUrl CreateEntityListViewUrl(string entityListFullName, string /// /// Get Resource Url for UpdateEntityListView /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// Use this field to include those fields which are not included by default. - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// + /// /// /// String - Resource Url /// @@ -183,8 +183,8 @@ public static MozuUrl UpdateEntityListViewUrl(string entityListFullName, string /// /// Get Resource Url for DeleteEntityListView /// - /// The full name of the EntityList including namespace in name@nameSpace format - /// The name for a view. Views are used to render data in , such as document and entity lists. Each view includes a schema, format, name, ID, and associated data types to render. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/Extensions/CredentialStoreEntryUrl.cs b/Mozu.Api/Urls/Platform/Extensions/CredentialStoreEntryUrl.cs old mode 100644 new mode 100755 diff --git a/Mozu.Api/Urls/Platform/InstalledApplicationsUrl.cs b/Mozu.Api/Urls/Platform/InstalledApplicationsUrl.cs new file mode 100755 index 00000000..48b9d705 --- /dev/null +++ b/Mozu.Api/Urls/Platform/InstalledApplicationsUrl.cs @@ -0,0 +1,56 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by a Codezu. +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; + +namespace Mozu.Api.Urls.Platform +{ + public partial class InstalledApplicationsUrl + { + + /// + /// Get Resource Url for GetApplication + /// + /// The application ID that represents the application to retrieve. + /// + /// + /// String - Resource Url + /// + public static MozuUrl GetApplicationUrl(string appId, string responseFields = null) + { + var url = "/api/platform/applications/{appId}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "appId", appId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + /// + /// Get Resource Url for UpdateApplication + /// + /// The application ID that represents the application to update. + /// + /// + /// String - Resource Url + /// + public static MozuUrl UpdateApplicationUrl(string appId, string responseFields = null) + { + var url = "/api/platform/applications/{appId}?responseFields={responseFields}"; + var mozuUrl = new MozuUrl(url, MozuUrl.UrlLocation.TENANT_POD, false) ; + mozuUrl.FormatUrl( "appId", appId); + mozuUrl.FormatUrl( "responseFields", responseFields); + return mozuUrl; + } + + + } +} + diff --git a/Mozu.Api/Urls/Platform/ReferenceDataUrl.cs b/Mozu.Api/Urls/Platform/ReferenceDataUrl.cs old mode 100644 new mode 100755 index 520294dd..418206e8 --- a/Mozu.Api/Urls/Platform/ReferenceDataUrl.cs +++ b/Mozu.Api/Urls/Platform/ReferenceDataUrl.cs @@ -19,8 +19,8 @@ public partial class ReferenceDataUrl /// /// Get Resource Url for GetAddressSchema /// - /// The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. - /// Use this field to include those fields which are not included by default. + /// The 2-letter country code used to retrieve a specified address schema. + /// /// /// String - Resource Url /// @@ -36,7 +36,7 @@ public static MozuUrl GetAddressSchemaUrl(string countryCode = null, string res /// /// Get Resource Url for GetAddressSchemas /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -52,7 +52,7 @@ public static MozuUrl GetAddressSchemasUrl(string responseFields = null) /// Get Resource Url for GetBehavior /// /// Unique identifier of the behavior. - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -68,8 +68,8 @@ public static MozuUrl GetBehaviorUrl(int behaviorId, string responseFields = nu /// /// Get Resource Url for GetBehaviorCategory /// - /// Unique identifier of the category to modify. - /// Use this field to include those fields which are not included by default. + /// Unique identifier of the behavior category. + /// /// /// String - Resource Url /// @@ -85,7 +85,7 @@ public static MozuUrl GetBehaviorCategoryUrl(int categoryId, string responseFiel /// /// Get Resource Url for GetBehaviorCategories /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -100,7 +100,7 @@ public static MozuUrl GetBehaviorCategoriesUrl(string responseFields = null) /// /// Get Resource Url for GetBehaviors /// - /// Use this field to include those fields which are not included by default. + /// /// The user type associated with the behaviors to retrieve. /// /// String - Resource Url @@ -117,7 +117,7 @@ public static MozuUrl GetBehaviorsUrl(string userType = null, string responseFi /// /// Get Resource Url for GetContentLocales /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -132,7 +132,7 @@ public static MozuUrl GetContentLocalesUrl(string responseFields = null) /// /// Get Resource Url for GetCountries /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -147,7 +147,7 @@ public static MozuUrl GetCountriesUrl(string responseFields = null) /// /// Get Resource Url for GetCountriesWithStates /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -162,7 +162,7 @@ public static MozuUrl GetCountriesWithStatesUrl(string responseFields = null) /// /// Get Resource Url for GetCurrencies /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -177,7 +177,7 @@ public static MozuUrl GetCurrenciesUrl(string responseFields = null) /// /// Get Resource Url for GetTimeZones /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -192,7 +192,7 @@ public static MozuUrl GetTimeZonesUrl(string responseFields = null) /// /// Get Resource Url for GetTopLevelDomains /// - /// Use this field to include those fields which are not included by default. + /// /// /// String - Resource Url /// @@ -207,8 +207,8 @@ public static MozuUrl GetTopLevelDomainsUrl(string responseFields = null) /// /// Get Resource Url for GetUnitsOfMeasure /// - /// 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" - /// Use this field to include those fields which are not included by default. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/SecureAppDataUrl.cs b/Mozu.Api/Urls/Platform/SecureAppDataUrl.cs old mode 100644 new mode 100755 index 0ece8035..a6759e80 --- a/Mozu.Api/Urls/Platform/SecureAppDataUrl.cs +++ b/Mozu.Api/Urls/Platform/SecureAppDataUrl.cs @@ -20,8 +20,8 @@ public partial class SecureAppDataUrl /// Get Resource Url for GetDBValue /// /// - /// The database entry string to create. - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// + /// /// /// String - Resource Url /// @@ -39,7 +39,7 @@ public static MozuUrl GetDBValueUrl(string appKeyId, string dbEntryQuery, string /// Get Resource Url for CreateDBValue /// /// - /// The database entry string to create. + /// /// /// String - Resource Url /// @@ -56,7 +56,7 @@ public static MozuUrl CreateDBValueUrl(string appKeyId, string dbEntryQuery) /// Get Resource Url for UpdateDBValue /// /// - /// The database entry string to create. + /// /// /// String - Resource Url /// @@ -73,7 +73,7 @@ public static MozuUrl UpdateDBValueUrl(string appKeyId, string dbEntryQuery) /// Get Resource Url for DeleteDBValue /// /// - /// The database entry string to create. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/SiteDataUrl.cs b/Mozu.Api/Urls/Platform/SiteDataUrl.cs old mode 100644 new mode 100755 index 1d45e80c..baf1681b --- a/Mozu.Api/Urls/Platform/SiteDataUrl.cs +++ b/Mozu.Api/Urls/Platform/SiteDataUrl.cs @@ -19,8 +19,8 @@ public partial class SiteDataUrl /// /// Get Resource Url for GetDBValue /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. + /// The database entry query string used to retrieve the record information. + /// /// /// String - Resource Url /// @@ -51,7 +51,7 @@ public static MozuUrl CreateDBValueUrl(string dbEntryQuery) /// /// Get Resource Url for UpdateDBValue /// - /// The database entry string to create. + /// The database entry query string used to update the record information. /// /// String - Resource Url /// @@ -66,7 +66,7 @@ public static MozuUrl UpdateDBValueUrl(string dbEntryQuery) /// /// Get Resource Url for DeleteDBValue /// - /// The database entry string to create. + /// The database entry string to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/TenantDataUrl.cs b/Mozu.Api/Urls/Platform/TenantDataUrl.cs old mode 100644 new mode 100755 index 6dd0339e..e450a53f --- a/Mozu.Api/Urls/Platform/TenantDataUrl.cs +++ b/Mozu.Api/Urls/Platform/TenantDataUrl.cs @@ -19,8 +19,8 @@ public partial class TenantDataUrl /// /// Get Resource Url for GetDBValue /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. + /// The database entry query string used to retrieve the record information. + /// /// /// String - Resource Url /// @@ -51,7 +51,7 @@ public static MozuUrl CreateDBValueUrl(string dbEntryQuery) /// /// Get Resource Url for UpdateDBValue /// - /// The database entry string to create. + /// The database entry query string used to update the record information. /// /// String - Resource Url /// @@ -66,7 +66,7 @@ public static MozuUrl UpdateDBValueUrl(string dbEntryQuery) /// /// Get Resource Url for DeleteDBValue /// - /// The database entry string to create. + /// The database entry string to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/TenantExtensionsUrl.cs b/Mozu.Api/Urls/Platform/TenantExtensionsUrl.cs old mode 100644 new mode 100755 index 75e6c2cd..8052444f --- a/Mozu.Api/Urls/Platform/TenantExtensionsUrl.cs +++ b/Mozu.Api/Urls/Platform/TenantExtensionsUrl.cs @@ -19,7 +19,7 @@ public partial class TenantExtensionsUrl /// /// Get Resource Url for GetExtensions /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// @@ -34,7 +34,7 @@ public static MozuUrl GetExtensionsUrl(string responseFields = null) /// /// Get Resource Url for UpdateExtensions /// - /// Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/TenantUrl.cs b/Mozu.Api/Urls/Platform/TenantUrl.cs old mode 100644 new mode 100755 index 6baedc93..234c2914 --- a/Mozu.Api/Urls/Platform/TenantUrl.cs +++ b/Mozu.Api/Urls/Platform/TenantUrl.cs @@ -19,8 +19,8 @@ public partial class TenantUrl /// /// Get Resource Url for GetTenant /// - /// Use this field to include those fields which are not included by default. - /// Unique identifier of the Mozu tenant. + /// + /// /// /// String - Resource Url /// diff --git a/Mozu.Api/Urls/Platform/UserDataUrl.cs b/Mozu.Api/Urls/Platform/UserDataUrl.cs old mode 100644 new mode 100755 index 7043929c..63796033 --- a/Mozu.Api/Urls/Platform/UserDataUrl.cs +++ b/Mozu.Api/Urls/Platform/UserDataUrl.cs @@ -19,8 +19,8 @@ public partial class UserDataUrl /// /// Get Resource Url for GetDBValue /// - /// The database entry string to create. - /// Use this field to include those fields which are not included by default. + /// The database entry query string used to retrieve the record information. + /// /// /// String - Resource Url /// @@ -51,7 +51,7 @@ public static MozuUrl CreateDBValueUrl(string dbEntryQuery) /// /// Get Resource Url for UpdateDBValue /// - /// The database entry string to create. + /// The database entry query string used to update the record information. /// /// String - Resource Url /// @@ -66,7 +66,7 @@ public static MozuUrl UpdateDBValueUrl(string dbEntryQuery) /// /// Get Resource Url for DeleteDBValue /// - /// The database entry string to create. + /// The database entry string to delete. /// /// String - Resource Url /// diff --git a/Mozu.Api/Version.cs b/Mozu.Api/Version.cs index b3708f43..df17e973 100644 --- a/Mozu.Api/Version.cs +++ b/Mozu.Api/Version.cs @@ -14,7 +14,7 @@ public class Version { public static string ApiVersion { - get { return "1.1721.17151.0"; } + get { return "2.2818.18108.0"; } } } } \ No newline at end of file